{ "openapi": "3.0.0", "info": { "description": "OpenAPI specification for the entire Messari API", "title": "Messari API - Metrics V1", "version": "1.0.0" }, "servers": [ { "description": "Messari API", "url": "https://api.messari.io" } ], "security": [], "paths": { "/metrics/v1/assets": { "get": { "description": "Retrieve a list of assets", "operationId": "getAssets", "parameters": [ { "description": "Number of items per page", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "integer", "example": 10, "default": 10 } }, { "description": "Number of items per page. Kept for backward compatibility", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "integer" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer", "example": 1, "default": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/metricsAsset" }, "type": "array" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/SnapshotListingMetadata" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get assets", "tags": [ "metrics/assets" ] } }, "/metrics/v1/assets/metrics": { "get": { "description": "Get metric catalog of datasets for assets.", "operationId": "getAssetsTimeseriesCatalog", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesCatalog" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get timeseries metrics catalog", "tags": [ "metrics/assets" ] } }, "/metrics/v1/assets/{assetIdentifier}": { "get": { "description": "Retrieve a specific asset", "operationId": "getAsset", "parameters": [ { "description": "Asset ID or slug", "in": "path", "name": "assetIdentifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/metricsAsset" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get asset", "tags": [ "metrics/assets" ] } }, "/metrics/v1/assets/{entityIdentifier}/metrics/{datasetSlug}/time-series": { "get": { "description": "Retrieve a specific asset's timeseries data", "operationId": "getAssetTimeseries", "parameters": [ { "description": "Entity ID or slug", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string", "example": "bitcoin", "default": "bitcoin" } }, { "description": "Dataset slug", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string" }, "example": "price" }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get asset timeseries data", "tags": [ "metrics/assets" ] } }, "/metrics/v1/assets/{entityIdentifier}/metrics/{datasetSlug}/time-series/{granularity}": { "get": { "description": "Retrieve a specific asset's timeseries data", "operationId": "getAssetTimeseriesWithGranularity", "parameters": [ { "description": "Entity ID or slug", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string", "example": "bitcoin", "default": "bitcoin" } }, { "description": "Dataset slug", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string" }, "example": "price" }, { "description": "Granularity", "in": "path", "name": "granularity", "required": true, "schema": { "enum": [ "1m", "5m", "15m", "30m", "1h", "6h", "1d", "1w", "30d", "1q", "1y" ], "type": "string", "example": "1d", "default": "1d" } }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get asset timeseries data", "tags": [ "metrics/assets" ] } }, "/metrics/v1/exchanges": { "get": { "description": "Retrieve a list of exchanges", "operationId": "getExchanges", "parameters": [ { "description": "Number of items per page", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "integer", "example": 10, "default": 10 } }, { "description": "Number of items per page. Kept for backward compatibility", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "integer" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer", "example": 1, "default": 1 } }, { "description": "Filter by exchange type", "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "centralized", "decentralized" ] } }, { "in": "query", "name": "typeRankCutoff", "schema": { "format": "double", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Exchange" }, "type": "array" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/SnapshotListingMetadata" } }, "required": [ "data" ], "type": "object" }, "example": { "error": null, "data": [ { "id": "d8b0ea44-1963-451e-ac37-aead4ba3b4c7", "name": "Binance", "slug": "binance", "type": "centralized", "yearEstablished": 2017, "region": "Americas", "country": "Cayman Islands", "typeRank30D": 1, "globalRank30D": 1, "relatedExchangeIDs": [ "86f92f67-7968-4c8d-8cb6-a5b1c80ef185", "eabe49f0-c1a3-4166-b773-780fe809ac93", "b196e8a3-34cc-40bd-a6cb-bb8283958021", "181f44f6-f9b7-4c11-9e44-7c7f803d808e", "0db82dc0-fa38-4831-b50a-3ac803de1754", "9741f98b-7a9b-4564-921a-b52bf303fbfc", "174e0471-1033-4e12-97d5-9f234ed21142", "86f92f67-7968-4c8d-8cb6-a5b1c80ef185", "5204836b-f5ac-478e-bc50-b51c56cb97c6", "7ac870f5-a3ff-486d-a5a1-5d58140da970" ], "metrics": { "volume24Hour": 13935863720.677505, "trades24Hour": 49321872, "assetsCount": 651, "marketsCount": 3282 } }, { "id": "2b482c0b-592c-47a3-bc24-33c8788feea7", "name": "Bitrue", "slug": "bitrue", "type": "centralized", "yearEstablished": 2018, "region": "Africa", "country": "Seychelles", "typeRank30D": 2, "globalRank30D": 2, "relatedExchangeIDs": [ "bd9ed9e8-b95f-43e8-b156-654e62fc556f", "6b7daad8-c6f0-48fd-a3db-e1276f03918d", "eaad939f-52c1-4a08-9857-c520a01072cc", "75a38c76-4ae7-4f06-9e5b-6e11eb70bdab", "74079b89-fc6d-499d-84a2-0bb1bc1ed6be", "66dfc7e9-e098-4143-a462-cf2579b31cb5", "8a1030cc-9b12-46e6-82d7-8b0a7e8f7f18", "4173177d-94f8-4ab5-9f67-5dc67663f88d", "6dcd9e5e-3d98-4367-bc14-1658ca426fd3", "f3075f49-a247-4593-a804-aad65c047981" ], "metrics": { "volume24Hour": 7678012601.082666, "trades24Hour": 32486401, "assetsCount": 1293, "marketsCount": 1892 } }, { "id": "bd9ed9e8-b95f-43e8-b156-654e62fc556f", "name": "XT.com", "slug": "xt-com", "type": "centralized", "yearEstablished": 2018, "region": "Africa", "country": "Seychelles", "typeRank30D": 3, "globalRank30D": 3, "relatedExchangeIDs": [ "2b482c0b-592c-47a3-bc24-33c8788feea7", "6b7daad8-c6f0-48fd-a3db-e1276f03918d", "eaad939f-52c1-4a08-9857-c520a01072cc", "75a38c76-4ae7-4f06-9e5b-6e11eb70bdab", "74079b89-fc6d-499d-84a2-0bb1bc1ed6be", "66dfc7e9-e098-4143-a462-cf2579b31cb5", "8a1030cc-9b12-46e6-82d7-8b0a7e8f7f18", "4173177d-94f8-4ab5-9f67-5dc67663f88d", "6dcd9e5e-3d98-4367-bc14-1658ca426fd3", "f3075f49-a247-4593-a804-aad65c047981" ], "metrics": { "volume24Hour": 4823703275.182786, "trades24Hour": 7796284, "assetsCount": 2007, "marketsCount": 2432 } }, { "id": "46ebd2f8-fe09-4e8e-bc5c-b145a0d59a63", "name": "Bullish", "slug": "bullish", "type": "centralized", "yearEstablished": 2021, "region": "Europe", "country": "Gibraltar", "typeRank30D": 12, "globalRank30D": 12, "relatedExchangeIDs": [ "c8369e58-3483-4599-a8c8-05ee281e1cd8", "fa9a2579-646b-41ba-8ea1-5f0160fdb05e", "00161e5d-2ec2-470d-8f1f-dcb2b5de22a6", "7d2d72f0-b129-4845-bce2-23bb0058f0eb", "f06b8db0-bca0-4583-8f1d-5457ea5ea682", "3663f00d-91fc-48a2-98a2-8af76325927a", "c97f2a8e-3f26-4ffa-ba0f-801cdc5f7732", "2087a29e-6a27-4d51-ba3b-d9f112f93c38", "7cb419ab-1236-4e40-8674-7317e4e4d108", "c8369e58-3483-4599-a8c8-05ee281e1cd8" ], "metrics": { "volume24Hour": 3169092380.628646, "trades24Hour": 11053097, "assetsCount": 69, "marketsCount": 168 } }, { "id": "181f44f6-f9b7-4c11-9e44-7c7f803d808e", "name": "Coinbase", "slug": "coinbase", "type": "centralized", "yearEstablished": 2012, "region": "Americas", "country": "United States", "typeRank30D": 7, "globalRank30D": 7, "relatedExchangeIDs": [ "5204836b-f5ac-478e-bc50-b51c56cb97c6", "46cf2e61-9dd9-4640-8968-6c38bc441f53", "8f192f0d-76fb-45f5-a40b-8882a3f2966d", "0146e251-3361-449b-811e-5db5721f3f96", "2d9d2493-31ae-47b0-9943-dae8be78559d", "d8b0ea44-1963-451e-ac37-aead4ba3b4c7", "0db82dc0-fa38-4831-b50a-3ac803de1754", "9741f98b-7a9b-4564-921a-b52bf303fbfc", "174e0471-1033-4e12-97d5-9f234ed21142", "86f92f67-7968-4c8d-8cb6-a5b1c80ef185" ], "metrics": { "volume24Hour": 2746823215.4297657, "trades24Hour": 6681273, "assetsCount": 474, "marketsCount": 781 } } ], "metadata": { "pageSize": 10, "page": 1, "totalRows": 304, "totalPages": 31 } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get exchanges", "tags": [ "metrics/exchanges" ] } }, "/metrics/v1/exchanges/metrics": { "get": { "description": "Get metric catalog of datasets for exchanges.", "operationId": "getExchangesTimeseriesCatalog", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesCatalog" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "example": { "error": null, "data": { "datasets": [ { "slug": "futures-open-interest", "granularities": [ "1h", "1d" ], "metrics": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Open Interest", "slug": "open-interest", "description": "The open interest for the exchange", "is_timestamp": false } ] }, { "slug": "futures-volume", "granularities": [ "1h", "1d" ], "metrics": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Futures Trade Count", "slug": "trade-count", "description": "The number of trades on the exchange across all assets", "is_timestamp": false }, { "name": "Futures Volume (USD)", "slug": "volume-usd", "description": "The volume of the exchange across all assets in USD", "is_timestamp": false }, { "name": "Futures Volume Buy (USD)", "slug": "volume-buy-usd", "description": "The volume of the exchange across all assets in USD for buy trades", "is_timestamp": false }, { "name": "Futures Volume Sell (USD)", "slug": "volume-sell-usd", "description": "The volume of the exchange across all assets in USD for sell trades", "is_timestamp": false } ] }, { "slug": "volume", "granularities": [ "5m", "1h", "1d", "1w" ], "metrics": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Trade Count", "slug": "trade-count", "description": "Trade count during the candle.", "is_timestamp": false }, { "name": "Volume", "slug": "volume", "description": "Volume traded during candle.", "is_timestamp": false } ] } ] } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get timeseries metrics catalog", "tags": [ "metrics/exchanges" ] } }, "/metrics/v1/exchanges/{entityIdentifier}/metrics/{datasetSlug}/time-series": { "get": { "description": "Retrieve a specific exchange's timeseries data", "operationId": "getExchangeTimeseries", "parameters": [ { "description": "Entity ID or slug", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string", "example": "binance", "default": "binance" } }, { "description": "Dataset slug", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string", "enum": [ "volume", "futures-volume", "futures-open-interest" ], "example": "volume", "default": "volume" } }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" }, "example": { "error": null, "data": { "points": [ [ 1748736000, 42522347, 9216853399.631496 ], [ 1748822400, 49639718, 13496478083.937649 ], [ 1748908800, 49929928, 14503394750.363638 ], [ 1748995200, 42680039, 13154648940.668606 ], [ 1749081600, 62562278, 21404240391.30481 ] ] }, "metadata": { "pointSchemas": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Trade Count", "slug": "trade-count", "description": "Trade count during the candle.", "is_timestamp": false }, { "name": "Volume", "slug": "volume", "description": "Volume traded during candle.", "is_timestamp": false } ], "granularity": "1d" } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get exchange timeseries data", "tags": [ "metrics/exchanges" ] } }, "/metrics/v1/exchanges/{entityIdentifier}/metrics/{datasetSlug}/time-series/{granularity}": { "get": { "description": "Retrieve a specific exchange's timeseries data", "operationId": "getExchangeTimeseriesWithGranularity", "parameters": [ { "description": "Entity ID or slug", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string", "example": "binance", "default": "binance" } }, { "description": "Dataset slug", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string", "enum": [ "volume", "futures-volume", "futures-open-interest" ], "example": "volume", "default": "volume" } }, { "description": "Granularity - time interval for data points", "in": "path", "name": "granularity", "required": true, "schema": { "enum": [ "5m", "1h", "1d", "1w" ], "type": "string", "default": "1d" }, "example": "1d" }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" }, "example": { "error": null, "data": { "points": [ [ 1748736000, 42522347, 9216853399.631496 ], [ 1748822400, 49639718, 13496478083.937649 ], [ 1748908800, 49929928, 14503394750.363638 ], [ 1748995200, 42680039, 13154648940.668606 ], [ 1749081600, 62562278, 21404240391.30481 ] ] }, "metadata": { "pointSchemas": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Trade Count", "slug": "trade-count", "description": "Trade count during the candle.", "is_timestamp": false }, { "name": "Volume", "slug": "volume", "description": "Volume traded during candle.", "is_timestamp": false } ], "granularity": "1d" } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get exchange timeseries data", "tags": [ "metrics/exchanges" ] } }, "/metrics/v1/exchanges/{exchangeIdentifier}": { "get": { "description": "Retrieve a specific exchange", "operationId": "getExchange", "parameters": [ { "description": "Exchange ID or slug", "in": "path", "name": "exchangeIdentifier", "required": true, "schema": { "type": "string", "example": "binance", "default": "binance" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Exchange" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "example": { "error": null, "data": { "id": "d8b0ea44-1963-451e-ac37-aead4ba3b4c7", "name": "Binance", "slug": "binance", "type": "centralized", "yearEstablished": 2017, "region": "Americas", "country": "Cayman Islands", "typeRank30D": 1, "globalRank30D": 1, "relatedExchangeIDs": [ "86f92f67-7968-4c8d-8cb6-a5b1c80ef185", "eabe49f0-c1a3-4166-b773-780fe809ac93", "b196e8a3-34cc-40bd-a6cb-bb8283958021", "181f44f6-f9b7-4c11-9e44-7c7f803d808e", "0db82dc0-fa38-4831-b50a-3ac803de1754", "9741f98b-7a9b-4564-921a-b52bf303fbfc", "174e0471-1033-4e12-97d5-9f234ed21142", "86f92f67-7968-4c8d-8cb6-a5b1c80ef185", "5204836b-f5ac-478e-bc50-b51c56cb97c6", "7ac870f5-a3ff-486d-a5a1-5d58140da970" ], "metrics": { "volume24Hour": 14218617591.159819, "trades24Hour": 50769613, "assetsCount": 651, "marketsCount": 3282 } } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get exchange", "tags": [ "metrics/exchanges" ] } }, "/metrics/v1/markets": { "get": { "description": "Retrieve a list of markets", "operationId": "getMarkets", "parameters": [ { "description": "Number of items per page", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "integer", "example": 10, "default": 10 } }, { "description": "Number of items per page. Kept for backward compatibility", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "integer" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer", "example": 1, "default": 1 } }, { "in": "query", "name": "exchangeId", "schema": { "type": "string" } }, { "in": "query", "name": "exchangeSlug", "schema": { "type": "string" } }, { "in": "query", "name": "quoteAssetId", "schema": { "type": "string" } }, { "in": "query", "name": "quoteAssetSlug", "schema": { "type": "string" } }, { "in": "query", "name": "baseAssetId", "schema": { "type": "string" } }, { "in": "query", "name": "baseAssetSlug", "schema": { "type": "string" } }, { "in": "query", "name": "volume24hAbove", "schema": { "format": "double", "type": "number" } }, { "in": "query", "name": "volume24hBelow", "schema": { "format": "double", "type": "number" } }, { "in": "query", "name": "liveness", "description": "Comma-separated list of liveness statuses to filter by. Possible values:\n- `live`: The market has had a trade in approximately the last 10 minutes.\n- `stale`: The market has had a trade in the last 24 hours, but not in the last ~10 minutes.\n- `inactive`: The market has not had any trades for more than 24 hours.", "schema": { "type": "string", "example": "live,stale" } }, { "in": "query", "name": "activitySince", "description": "Filter to markets that have had a trade since this date. Accepts RFC3339 (e.g. `2024-01-15T00:00:00Z`), `YYYY-MM-DD`, or a unix timestamp.", "schema": { "type": "string", "example": "2024-01-15" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Market" }, "type": "array" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/SnapshotListingMetadata" } }, "required": [ "data" ], "type": "object", "example": { "error": null, "data": [ { "id": "6057-649-44", "baseAsset": { "id": "1e31218a-e44e-4285-820c-8282ee222035", "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "baseAssetSector": "Cryptocurrency", "quoteAsset": { "id": "60dcd17b-00f3-49f8-907c-f390c2521c59", "name": "United States Dollar", "slug": "fedcoin", "symbol": "USD" }, "quoteAssetSector": "", "exchange": { "id": "181f44f6-f9b7-4c11-9e44-7c7f803d808e", "name": "Coinbase", "slug": "coinbase" }, "network": null, "sectors": [ "Cryptocurrency" ], "firstTradeAt": "2014-12-01T06:00:00Z", "lastTradeAt": "2026-03-04T23:34:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 44.03, "latestPrice24hOpen": 68435.06, "latestPrice24hHigh": 74100, "latestPrice24hLow": 67391.17, "latestPrice24hClose": 72432.08, "premiumDiscount": -0.015, "volume24h": 1496297599.8, "tradeCount24h": 1219331 } } ], "metadata": { "pageSize": 1, "page": 1, "totalRows": 742, "totalPages": 742 } } }, "example": { "error": null, "data": [ { "id": "6071-140-68", "baseAsset": { "id": "4515ba15-2719-4183-b0ca-b9255d55b67e", "name": "USDC", "slug": "circle-usdc-stablecoin", "symbol": "USDC" }, "baseAssetSector": "Stablecoins", "quoteAsset": { "id": "51f8ea5e-f426-4f40-939a-db7e05495374", "name": "Tether", "slug": "tether", "symbol": "USDT" }, "quoteAssetSector": "Stablecoins", "exchange": { "id": "d8b0ea44-1963-451e-ac37-aead4ba3b4c7", "name": "Binance", "slug": "binance" }, "network": null, "sectors": [ "Stablecoins" ], "firstTradeAt": "2018-12-15T04:00:00Z", "lastTradeAt": "2026-08-25T01:53:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 30.9443843000696, "latestPrice24hOpen": 1.0001146574421833, "latestPrice24hHigh": 1.00108691224939, "latestPrice24hLow": 0.998843764114286, "latestPrice24hClose": 0.9999239113853846, "premiumDiscount": 0.0008230461030325513, "volume24h": 4424750740.452992, "tradeCount24h": 669801 } }, { "id": "128-6071-265", "baseAsset": { "id": "9034399e-e229-48ca-8ff3-5ea5fc599080", "name": "Zcash", "slug": "zcash", "symbol": "ZEC" }, "baseAssetSector": "Cryptocurrency", "quoteAsset": { "id": "4515ba15-2719-4183-b0ca-b9255d55b67e", "name": "USDC", "slug": "circle-usdc-stablecoin", "symbol": "USDC" }, "quoteAssetSector": "Stablecoins", "exchange": { "id": "2b482c0b-592c-47a3-bc24-33c8788feea7", "name": "Bitrue", "slug": "bitrue" }, "network": null, "sectors": [ "Cryptocurrency", "Stablecoins" ], "firstTradeAt": "2025-12-25T04:00:00Z", "lastTradeAt": "2026-08-25T01:53:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 38.0734001200449, "latestPrice24hOpen": 827.9676744692978, "latestPrice24hHigh": 869.2423560257628, "latestPrice24hLow": 797.7113310026093, "latestPrice24hClose": 831.2904666889657, "premiumDiscount": 0.14060152343539953, "volume24h": 3015111976.3514977, "tradeCount24h": 4657362 } }, { "id": "6057-140-68", "baseAsset": { "id": "1e31218a-e44e-4285-820c-8282ee222035", "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "baseAssetSector": "Cryptocurrency", "quoteAsset": { "id": "51f8ea5e-f426-4f40-939a-db7e05495374", "name": "Tether", "slug": "tether", "symbol": "USDT" }, "quoteAssetSector": "Stablecoins", "exchange": { "id": "d8b0ea44-1963-451e-ac37-aead4ba3b4c7", "name": "Binance", "slug": "binance" }, "network": null, "sectors": [ "Cryptocurrency", "Stablecoins" ], "firstTradeAt": "2017-08-17T05:00:00Z", "lastTradeAt": "2026-08-25T01:53:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 16.929235555820586, "latestPrice24hOpen": 76941.28223001234, "latestPrice24hHigh": 80002.3783316743, "latestPrice24hLow": 76677.26106967995, "latestPrice24hClose": 79562.31754820744, "premiumDiscount": 0.040390388297554355, "volume24h": 2420718629.737021, "tradeCount24h": 6532330 } }, { "id": "6057-140-265", "baseAsset": { "id": "1e31218a-e44e-4285-820c-8282ee222035", "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "baseAssetSector": "Cryptocurrency", "quoteAsset": { "id": "51f8ea5e-f426-4f40-939a-db7e05495374", "name": "Tether", "slug": "tether", "symbol": "USDT" }, "quoteAssetSector": "Stablecoins", "exchange": { "id": "2b482c0b-592c-47a3-bc24-33c8788feea7", "name": "Bitrue", "slug": "bitrue" }, "network": null, "sectors": [ "Cryptocurrency", "Stablecoins" ], "firstTradeAt": "2018-04-05T13:00:00Z", "lastTradeAt": "2026-08-25T01:53:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 29.625395838778573, "latestPrice24hOpen": 76929.39110455786, "latestPrice24hHigh": 80001.39812377431, "latestPrice24hLow": 76681.25144703439, "latestPrice24hClose": 79552.88805637053, "premiumDiscount": 0.028533895505518665, "volume24h": 2346096894.8404427, "tradeCount24h": 228986 } }, { "id": "6057-140-113", "baseAsset": { "id": "1e31218a-e44e-4285-820c-8282ee222035", "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "baseAssetSector": "Cryptocurrency", "quoteAsset": { "id": "51f8ea5e-f426-4f40-939a-db7e05495374", "name": "Tether", "slug": "tether", "symbol": "USDT" }, "quoteAssetSector": "Stablecoins", "exchange": { "id": "bd9ed9e8-b95f-43e8-b156-654e62fc556f", "name": "XT.com", "slug": "xt-com" }, "network": null, "sectors": [ "Cryptocurrency", "Stablecoins" ], "firstTradeAt": "2021-11-02T14:00:00Z", "lastTradeAt": "2026-08-25T01:53:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 28.817619918534813, "latestPrice24hOpen": 76977.5756650622, "latestPrice24hHigh": 80001.3881216529, "latestPrice24hLow": 76681.21144325139, "latestPrice24hClose": 79552.84972635316, "premiumDiscount": 0.028485699952403496, "volume24h": 1429127877.1373124, "tradeCount24h": 153815 } } ], "metadata": { "pageSize": 10, "page": 1, "totalRows": 252802, "totalPages": 25281 } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get markets", "tags": [ "metrics/markets" ] } }, "/metrics/v1/markets/metrics": { "get": { "description": "Get the catalog of available timeseries datasets and granularities for markets. Use this to discover valid `datasetSlug` and `granularity` values for the market timeseries endpoints.", "operationId": "getMarketsTimeseriesCatalog", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesCatalog" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object", "example": { "error": null, "data": { "datasets": [ { "slug": "price", "granularities": [ "1d", "1h" ], "metrics": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Open Price", "slug": "open-price", "description": "USD price at the candle open.", "is_timestamp": false }, { "name": "High Price", "slug": "high-price", "description": "High USD price during the candle.", "is_timestamp": false }, { "name": "Low Price", "slug": "low-price", "description": "Low USD price during the candle.", "is_timestamp": false }, { "name": "Close Price", "slug": "close-price", "description": "USD price at the candle close.", "is_timestamp": false } ] }, { "slug": "volume", "granularities": [ "1d", "1h" ], "metrics": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Volume", "slug": "volume", "description": "Volume traded during candle.", "is_timestamp": false } ] } ] } } }, "example": { "error": null, "data": { "datasets": [ { "slug": "price", "granularities": [ "5m", "1h", "1d", "1w" ], "metrics": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Open Price", "slug": "open-price", "description": "USD price at the candle open.", "is_timestamp": false }, { "name": "High Price", "slug": "high-price", "description": "High USD price during the candle.", "is_timestamp": false }, { "name": "Low Price", "slug": "low-price", "description": "Low USD price during the candle.", "is_timestamp": false }, { "name": "Close Price", "slug": "close-price", "description": "USD price at the candle close.", "is_timestamp": false } ] }, { "slug": "volume", "granularities": [ "5m", "1h", "1d", "1w" ], "metrics": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Volume", "slug": "volume", "description": "Volume traded during candle.", "is_timestamp": false } ] } ] } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get timeseries metrics catalog", "tags": [ "metrics/markets" ] } }, "/metrics/v1/markets/{entityIdentifier}/metrics/{datasetSlug}/time-series": { "get": { "description": "Retrieve a specific market's timeseries data. Price data is denominated in USD. Volume data is denominated in USD.", "operationId": "getMarketTimeseries", "parameters": [ { "description": "Market ID (e.g., 6057-140-265 for BTC/USDT on Bitrue)", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string", "example": "6057-140-265", "default": "6057-140-265" } }, { "description": "Dataset slug: 'price' returns OHLC prices in USD, 'volume' returns trading volume in USD", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string", "enum": [ "price", "volume" ], "example": "volume", "default": "volume" } }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" }, "example": { "error": null, "data": { "points": [ [ 1748736000, 1674014684.4481711 ], [ 1748822400, 2131215625.3342063 ], [ 1748908800, 2365233260.212919 ], [ 1748995200, 2741424611.580782 ], [ 1749081600, 2688205439.7842703 ] ] }, "metadata": { "pointSchemas": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Volume", "slug": "volume", "description": "Volume traded during candle.", "is_timestamp": false } ], "granularity": "1d" } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get market timeseries data", "tags": [ "metrics/markets" ] } }, "/metrics/v1/markets/{entityIdentifier}/metrics/{datasetSlug}/time-series/{granularity}": { "get": { "description": "Retrieve a specific market's timeseries data with specified granularity. Price data is denominated in USD. Volume data is denominated in USD.", "operationId": "getMarketTimeseriesWithGranularity", "parameters": [ { "description": "Market ID (e.g., 6057-140-265 for BTC/USDT on Bitrue)", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string", "example": "6057-140-265", "default": "6057-140-265" } }, { "description": "Dataset slug: 'price' returns OHLC prices in USD, 'volume' returns trading volume in USD", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string", "enum": [ "price", "volume" ], "example": "price", "default": "price" } }, { "description": "Granularity - time interval for data points.", "in": "path", "name": "granularity", "required": true, "schema": { "enum": [ "5m", "1h", "1d", "1w" ], "type": "string", "example": "1d", "default": "1d" } }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" }, "example": { "error": null, "data": { "points": [ [ 1748736000, 1674014684.4481711 ], [ 1748822400, 2131215625.3342063 ], [ 1748908800, 2365233260.212919 ], [ 1748995200, 2741424611.580782 ], [ 1749081600, 2688205439.7842703 ] ] }, "metadata": { "pointSchemas": [ { "name": "Timestamp", "slug": "time", "description": "Timestamp of the data point.", "is_timestamp": true }, { "name": "Volume", "slug": "volume", "description": "Volume traded during candle.", "is_timestamp": false } ], "granularity": "1d" } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get market timeseries data with granularity", "tags": [ "metrics/markets" ] } }, "/metrics/v1/markets/{marketIdentifier}": { "get": { "description": "Retrieve a specific market", "operationId": "getMarket", "parameters": [ { "in": "path", "name": "marketIdentifier", "required": true, "schema": { "type": "string", "example": "6057-649-44" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Market" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object", "example": { "error": null, "data": { "id": "6057-649-44", "baseAsset": { "id": "1e31218a-e44e-4285-820c-8282ee222035", "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "baseAssetSector": "Cryptocurrency", "quoteAsset": { "id": "60dcd17b-00f3-49f8-907c-f390c2521c59", "name": "United States Dollar", "slug": "fedcoin", "symbol": "USD" }, "quoteAssetSector": "", "exchange": { "id": "181f44f6-f9b7-4c11-9e44-7c7f803d808e", "name": "Coinbase", "slug": "coinbase" }, "network": null, "sectors": [ "Cryptocurrency" ], "firstTradeAt": "2014-12-01T06:00:00Z", "lastTradeAt": "2026-03-04T23:34:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 44.03, "latestPrice24hOpen": 68394.99, "latestPrice24hHigh": 74100, "latestPrice24hLow": 67391.17, "latestPrice24hClose": 72411.99, "premiumDiscount": -0.136, "volume24h": 1496297599.8, "tradeCount24h": 1219331 } } } }, "example": { "error": null, "data": { "id": "6057-140-265", "baseAsset": { "id": "1e31218a-e44e-4285-820c-8282ee222035", "name": "Bitcoin", "slug": "bitcoin", "symbol": "BTC" }, "baseAssetSector": "Cryptocurrency", "quoteAsset": { "id": "51f8ea5e-f426-4f40-939a-db7e05495374", "name": "Tether", "slug": "tether", "symbol": "USDT" }, "quoteAssetSector": "Stablecoins", "exchange": { "id": "2b482c0b-592c-47a3-bc24-33c8788feea7", "name": "Bitrue", "slug": "bitrue" }, "network": null, "sectors": [ "Cryptocurrency", "Stablecoins" ], "firstTradeAt": "2018-04-05T13:00:00Z", "lastTradeAt": "2026-08-25T01:53:00Z", "isNewMarket": false, "isRecentlyListed": false, "liveness": "live", "metrics": { "exchangeVolumePercentage24h": 29.625395838778573, "latestPrice24hOpen": 76929.39110455786, "latestPrice24hHigh": 80001.39812377431, "latestPrice24hLow": 76681.25144703439, "latestPrice24hClose": 79552.88805637053, "premiumDiscount": 0.028533895505518665, "volume24h": 2346096894.8404427, "tradeCount24h": 228986 } } } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get market", "tags": [ "metrics/markets" ] } }, "/metrics/v1/networks": { "get": { "description": "Retrieve a list of networks", "operationId": "getNetworks", "parameters": [ { "description": "Number of items per page", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "integer", "example": 10, "default": 10 } }, { "description": "Number of items per page. Kept for backward compatibility", "in": "query", "name": "pageSize", "schema": { "format": "int64", "type": "integer" } }, { "description": "Page number", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer", "example": 1, "default": 1 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Network" }, "type": "array" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/SnapshotListingMetadata" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get networks", "tags": [ "metrics/networks" ] } }, "/metrics/v1/networks/metrics": { "get": { "description": "Get metric catalog of datasets for networks.", "operationId": "getNetworksTimeseriesCatalog", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesCatalog" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get timeseries metrics catalog", "tags": [ "metrics/networks" ] } }, "/metrics/v1/networks/{entityIdentifier}/metrics/{datasetSlug}/time-series": { "get": { "description": "Retrieve a specific network's timeseries data", "operationId": "getNetworkTimeseries", "parameters": [ { "description": "Entity ID or slug", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string" } }, { "description": "Dataset slug", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get network timeseries data", "tags": [ "metrics/networks" ] } }, "/metrics/v1/networks/{entityIdentifier}/metrics/{datasetSlug}/time-series/{granularity}": { "get": { "description": "Retrieve a specific network's timeseries data", "operationId": "getNetworkTimeseriesWithGranularity", "parameters": [ { "description": "Entity ID or slug", "in": "path", "name": "entityIdentifier", "required": true, "schema": { "type": "string" } }, { "description": "Dataset slug", "in": "path", "name": "datasetSlug", "required": true, "schema": { "type": "string" } }, { "description": "Granularity", "in": "path", "name": "granularity", "required": true, "schema": { "enum": [ "1m", "5m", "15m", "30m", "1h", "6h", "1d", "1w", "30d", "1q", "1y" ], "type": "string", "example": "1d", "default": "1d" } }, { "description": "Time range start", "in": "query", "name": "start", "schema": { "type": "string", "example": "2025-06-01T00:00:00Z", "default": "2025-06-01T00:00:00Z" } }, { "description": "Time range end", "in": "query", "name": "end", "schema": { "type": "string", "example": "2025-06-07T00:00:00Z", "default": "2025-06-07T00:00:00Z" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/TimeseriesData" }, "error": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/metricsTimeseriesMetadata" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get network timeseries data", "tags": [ "metrics/networks" ] } }, "/metrics/v1/networks/{networkIdentifier}": { "get": { "description": "Retrieve a specific network", "operationId": "getNetwork", "parameters": [ { "description": "Network ID or slug", "in": "path", "name": "networkIdentifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Network" }, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Default response" }, "400": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Unauthorized" }, "500": { "content": { "application/json": { "schema": { "properties": { "data": {}, "error": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Internal Server Error" } }, "security": [ { "apiKey": [] } ], "summary": "Get network", "tags": [ "metrics/networks" ] } } }, "components": { "schemas": { "metricsAsset": { "properties": { "allTimeHigh": { "$ref": "#/components/schemas/AssetATH" }, "category": { "type": "string" }, "contractAddresses": { "items": { "$ref": "#/components/schemas/ContractAddress" }, "type": "array" }, "description": { "type": "string" }, "id": { "type": "string" }, "links": { "items": { "$ref": "#/components/schemas/metricsLink" }, "type": "array" }, "marketData": { "$ref": "#/components/schemas/AssetMarketData" }, "name": { "type": "string" }, "networkSlugs": { "items": { "type": "string" }, "type": "array" }, "protocolSlugs": { "items": { "type": "string" }, "type": "array" }, "rank": { "format": "int64", "type": "integer" }, "returnOnInvestment": { "$ref": "#/components/schemas/AssetROI" }, "sector": { "type": "string" }, "slug": { "type": "string" }, "symbol": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "required": [ "allTimeHigh", "category", "contractAddresses", "description", "id", "links", "marketData", "name", "networkSlugs", "protocolSlugs", "returnOnInvestment", "sector", "slug", "symbol", "tags" ], "type": "object" }, "TimeseriesCatalog": { "properties": { "datasets": { "items": { "$ref": "#/components/schemas/TimeseriesDataset" }, "type": "array" } }, "required": [ "datasets" ], "type": "object" }, "Market": { "properties": { "baseAsset": { "$ref": "#/components/schemas/AssetEntity" }, "baseAssetSector": { "type": "string" }, "exchange": { "$ref": "#/components/schemas/ExchangeEntity" }, "firstTradeAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "isNewMarket": { "type": "boolean" }, "isRecentlyListed": { "type": "boolean" }, "lastTradeAt": { "format": "date-time", "type": "string" }, "liveness": { "type": "string" }, "metrics": { "$ref": "#/components/schemas/MarketMetrics" }, "network": { "$ref": "#/components/schemas/NetworkEntity" }, "quoteAsset": { "$ref": "#/components/schemas/AssetEntity" }, "quoteAssetSector": { "type": "string" }, "sectors": { "items": { "type": "string" }, "type": "array" } }, "required": [ "baseAsset", "baseAssetSector", "exchange", "firstTradeAt", "id", "isNewMarket", "isRecentlyListed", "lastTradeAt", "liveness", "metrics", "quoteAsset", "quoteAssetSector", "sectors" ], "type": "object" }, "Exchange": { "properties": { "country": { "type": "string" }, "globalRank30D": { "format": "int64", "type": "integer" }, "id": { "type": "string" }, "metrics": { "$ref": "#/components/schemas/ExchangeMetrics" }, "name": { "type": "string" }, "region": { "type": "string" }, "relatedExchangeIDs": { "items": { "type": "string" }, "type": "array" }, "slug": { "type": "string" }, "type": { "type": "string" }, "typeRank30D": { "format": "int64", "type": "integer" }, "yearEstablished": { "format": "int64", "type": "integer" } }, "required": [ "country", "globalRank30D", "id", "metrics", "name", "region", "relatedExchangeIDs", "slug", "type", "typeRank30D", "yearEstablished" ], "type": "object" }, "Network": { "properties": { "id": { "type": "string" }, "metrics": { "$ref": "#/components/schemas/NetworkMetrics" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "metrics", "name", "slug" ], "type": "object" }, "SnapshotListingMetadata": { "properties": { "page": { "format": "int64", "type": "integer", "description": "Current page number" }, "pageSize": { "format": "int64", "type": "integer", "description": "Number of results per page" }, "totalPages": { "format": "int64", "type": "integer", "description": "Total number of pages" }, "totalRows": { "format": "int64", "type": "integer", "description": "Total number of rows" } }, "required": [ "page", "pageSize", "totalPages", "totalRows" ], "type": "object", "description": "Pagination metadata" }, "metricsTimeseriesMetadata": { "properties": { "granularity": { "enum": [ "1m", "5m", "15m", "30m", "1h", "6h", "1d", "1w", "30d", "1q", "1y" ], "type": "string" }, "pointSchemas": { "items": { "$ref": "#/components/schemas/metricsPointSchema" }, "type": "array" } }, "required": [ "granularity", "pointSchemas" ], "type": "object" }, "TimeseriesData": { "properties": { "points": { "items": { "items": {}, "type": "array" }, "type": "array" } }, "required": [ "points" ], "type": "object" }, "ExchangeMetrics": { "type": "object", "description": "Schema for ExchangeMetrics", "properties": {}, "additionalProperties": true }, "NetworkEntity": { "type": "object", "description": "Schema for NetworkEntity", "properties": {}, "additionalProperties": true }, "ExchangeEntity": { "type": "object", "description": "Schema for ExchangeEntity", "properties": {}, "additionalProperties": true }, "AssetMarketData": { "type": "object", "description": "Latest prices, trailing volume, candles, supply and marketcap for an asset.", "properties": { "priceUsd": { "type": "number", "format": "double", "description": "Latest price of the asset, in USD." }, "priceBtc": { "type": "number", "format": "double", "description": "Latest price of the asset, denominated in BTC." }, "priceEth": { "type": "number", "format": "double", "description": "Latest price of the asset, denominated in ETH." }, "priceAt": { "type": "string", "format": "date-time", "nullable": true, "description": "When the latest price was recorded. Null when no price is on record for the asset." }, "firstPriceAt": { "type": "string", "format": "date-time", "nullable": true, "description": "When the earliest price on record for the asset was observed. This marks the start of the price coverage of the asset. Null when no price is on record." }, "volume24Hour": { "type": "number", "format": "double", "description": "Traded volume over the trailing 24 hours, in USD." }, "ohlcv1HourUsd": { "allOf": [ { "$ref": "#/components/schemas/OHLCV" } ], "description": "Candle over the trailing hour." }, "ohlcv24HourUsd": { "allOf": [ { "$ref": "#/components/schemas/OHLCV" } ], "description": "Candle over the trailing 24 hours." }, "ohlcvTodayUsd": { "allOf": [ { "$ref": "#/components/schemas/OHLCV" } ], "description": "Most recent daily candle." }, "supply": { "$ref": "#/components/schemas/Supply" }, "marketcap": { "$ref": "#/components/schemas/MarketCap" } } }, "OHLCV": { "type": "object", "description": "Open, high, low, close and volume over one window, in USD.", "properties": { "open": { "type": "number", "format": "double", "description": "Price at the start of the window." }, "high": { "type": "number", "format": "double", "description": "Highest price in the window." }, "low": { "type": "number", "format": "double", "description": "Lowest price in the window." }, "close": { "type": "number", "format": "double", "description": "Price at the end of the window, which is the latest price of the asset." }, "volume": { "type": "number", "format": "double", "description": "Traded volume in the window, in USD." } } }, "Supply": { "type": "object", "description": "Token supply of the asset.", "properties": { "circulating": { "type": "number", "format": "double", "description": "Tokens available to the market." }, "total": { "type": "number", "format": "double", "description": "Tokens that exist, minus the tokens burned." }, "max": { "type": "number", "format": "double", "description": "Tokens that can ever exist. Zero when the asset has no cap." } } }, "MarketCap": { "type": "object", "description": "Marketcap of the asset.", "properties": { "circulatingUsd": { "type": "number", "format": "double", "description": "Circulating supply valued at the latest price, in USD." }, "fullyDilutedUsd": { "type": "number", "format": "double", "description": "Total supply valued at the latest price, in USD." }, "dominance": { "type": "number", "format": "double", "description": "Percent of total crypto marketcap held by the asset." } } }, "metricsLink": { "type": "object", "description": "Schema for metricsLink", "properties": {}, "additionalProperties": true }, "AssetATH": { "type": "object", "description": "All-time high of an asset, and the cycle low that follows it.", "properties": { "allTimeHigh": { "type": "number", "format": "double", "description": "Highest price on record, in USD." }, "allTimeHighDate": { "type": "string", "format": "date-time", "nullable": true, "description": "When the asset reached its all-time high. Null when no price is on record." }, "allTimeHighTimeSinceSeconds": { "type": "number", "format": "double", "description": "Seconds since the all-time high." }, "allTimeHighPercentDown": { "type": "number", "format": "double", "description": "Percent the latest price sits below the all-time high." }, "breakevenMultiple": { "type": "number", "format": "double", "description": "Multiple the latest price must gain to return to the all-time high." }, "cycleLow": { "type": "number", "format": "double", "description": "Lowest price since the all-time high, in USD." }, "cycleLowDate": { "type": "string", "format": "date-time", "nullable": true, "description": "When the asset reached its cycle low. Null when no price is on record." }, "cycleLowTimeSinceSeconds": { "type": "number", "format": "double", "description": "Seconds since the cycle low." }, "cycleLowPercentUp": { "type": "number", "format": "double", "description": "Percent the latest price sits above the cycle low." } } }, "AssetROI": { "type": "object", "description": "Schema for AssetROI", "properties": {}, "additionalProperties": true }, "metricsPointSchema": { "type": "object", "description": "Schema for metricsPointSchema", "properties": {}, "additionalProperties": true }, "ContractAddress": { "type": "object", "description": "Schema for ContractAddress", "properties": {}, "additionalProperties": true }, "MarketMetrics": { "type": "object", "description": "Schema for MarketMetrics", "properties": {}, "additionalProperties": true }, "AssetEntity": { "type": "object", "properties": { "id": { "type": "string", "description": "Asset UUID" }, "name": { "type": "string", "description": "Asset name" }, "symbol": { "type": "string", "description": "Asset symbol" }, "slug": { "type": "string", "description": "Asset slug" } } }, "NetworkMetrics": { "type": "object", "description": "Schema for NetworkMetrics", "properties": {}, "additionalProperties": true }, "TimeseriesDataset": { "type": "object", "description": "Schema for TimeseriesDataset", "properties": {}, "additionalProperties": true } }, "securitySchemes": { "apiKey": { "in": "header", "name": "X-Messari-API-Key", "type": "apiKey" } } } }