{ "openapi": "3.1.1", "info": { "title": "CoinMarketCap Cryptocurrency API Documentation", "version": "3.0.3", "description": "Modern API for cryptocurrency data. Get real-time prices, market data, listings, and historical information through powerful developer endpoints.", "contact": { "email": "api@coinmarketcap.com" }, "termsOfService": "https://coinmarketcap.com/terms/" }, "tags": [ { "name": "Cryptocurrency", "description": "##### Endpoints for cryptocurrency data. This category includes 19 endpoints:\n- [/v1/cryptocurrency/map](/pro-api-reference/cryptocurrency#cryptocurrency-id-map) - Cryptocurrency ID Map\n- [/v3/cryptocurrency/listings/latest](/pro-api-reference/cryptocurrency#listings-latest) - Listings Latest\n- [/v1/cryptocurrency/listings/new](/pro-api-reference/cryptocurrency#listings-new) - Listings New\n- [/v1/cryptocurrency/listings/historical](/pro-api-reference/cryptocurrency#listings-historical) - Listings Historical\n- [/v3/cryptocurrency/quotes/latest](/pro-api-reference/cryptocurrency#quotes-latest) - Quotes Latest\n- [/v3/cryptocurrency/quotes/historical](/pro-api-reference/cryptocurrency#quotes-historical) - Quotes Historical\n- [/v2/cryptocurrency/ohlcv/latest](/pro-api-reference/cryptocurrency#ohlcv-latest) - OHLCV Latest\n- [/v2/cryptocurrency/ohlcv/historical](/pro-api-reference/cryptocurrency#ohlcv-historical) - OHLCV Historical\n- [/v2/cryptocurrency/market-pairs/latest](/pro-api-reference/cryptocurrency#market-pairs-latest) - Market Pairs Latest\n- [/v2/cryptocurrency/price-performance-stats/latest](/pro-api-reference/cryptocurrency#price-performance-stats) - Price Performance Stats\n- [/v2/cryptocurrency/info](/pro-api-reference/cryptocurrency#metadata) - Metadata\n- [/v1/cryptocurrency/trending/latest](/pro-api-reference/cryptocurrency#trending-latest) - Trending Latest\n- [/v1/cryptocurrency/trending/gainers-losers](/pro-api-reference/cryptocurrency#trending-gainers-losers) - Trending Gainers & Losers\n- [/v1/cryptocurrency/trending/most-visited](/pro-api-reference/cryptocurrency#trending-most-visited) - Trending Most Visited\n- [/v2/simple/price](/pro-api-reference/cryptocurrency#simple-price) - Simple Price\n- [/v1/cryptocurrency/categories](/pro-api-reference/cryptocurrency#categories) - Categories\n- [/v1/cryptocurrency/category](/pro-api-reference/cryptocurrency#category) - Category\n- [/v1/cryptocurrency/airdrops](/pro-api-reference/cryptocurrency#airdrops) - Airdrops\n- [/v1/cryptocurrency/airdrop](/pro-api-reference/cryptocurrency#airdrop) - Airdrop" }, { "name": "Exchange", "description": "##### Endpoints for cryptocurrency exchanges. This category includes 7 endpoints:\n- [/v1/exchange/map](/pro-api-reference/exchange#exchange-id-map) - Exchange ID Map\n- [/v1/exchange/listings/latest](/pro-api-reference/exchange#listings-latest-2) - Listings Latest\n- [/v1/exchange/quotes/latest](/pro-api-reference/exchange#quotes-latest-2) - Quotes Latest\n- [/v1/exchange/quotes/historical](/pro-api-reference/exchange#quotes-historical-2) - Quotes Historical\n- [/v1/exchange/market-pairs/latest](/pro-api-reference/exchange#market-pairs-latest-2) - Market Pairs Latest\n- [/v1/exchange/assets](/pro-api-reference/exchange#exchange-assets) - Exchange Assets\n- [/v1/exchange/info](/pro-api-reference/exchange#metadata-2) - Metadata" }, { "name": "Real World Assets", "description": "##### Endpoints for tokenized Real-World Asset (RWA) data — equities, commodities, currencies, government securities, ETFs, and real estate. This category includes 7 endpoints:\n- [/v5/real-world-assets/map](/pro-api-reference/real-world-assets#rwa-id-map) - RWA ID Map\n- [/v5/real-world-assets/info](/pro-api-reference/real-world-assets#metadata-3) - Metadata\n- [/v5/real-world-assets/assets/list](/pro-api-reference/real-world-assets#rwa-list) - RWA List\n- [/v5/real-world-assets/market-pairs/list](/pro-api-reference/real-world-assets#market-pairs) - Market Pairs\n- [/v5/real-world-assets/quotes/latest](/pro-api-reference/real-world-assets#quotes-latest-5) - Quotes Latest\n- [/v5/real-world-assets/issuers/list](/pro-api-reference/real-world-assets#issuers-list) - Issuers List\n- [/v5/real-world-assets/issuers](/pro-api-reference/real-world-assets#issuer) - Issuer" }, { "name": "Derivatives", "description": "##### Endpoints for derivatives market data (perpetuals and futures). This category includes 6 endpoints:\n- [/v5/exchange/derivatives/list](/pro-api-reference/derivatives#list-derivatives-exchanges) - List derivatives exchanges\n- [/v5/exchange/derivatives/market-pairs/list/latest](/pro-api-reference/derivatives#derivative-market-pairs-by-exchange) - Derivative market pairs by exchange\n- [/v5/cryptocurrency/derivatives/market-pairs/list/latest](/pro-api-reference/derivatives#derivative-market-pairs-by-cryptocurrency) - Derivative market pairs by cryptocurrency\n- [/v5/derivatives/liquidations/quotes/latest](/pro-api-reference/derivatives#latest-total-liquidations) - Latest Total Liquidations\n- [/v5/derivatives/liquidations/exchange/list/latest](/pro-api-reference/derivatives#latest-liquidations-by-exchange) - Latest Liquidations by Exchange\n- [/v5/derivatives/liquidations/cryptocurrency/list/latest](/pro-api-reference/derivatives#latest-liquidations-by-cryptocurrency) - Latest Liquidations by Cryptocurrency" }, { "name": "CMC AI", "description": "##### Endpoints for CMC AI question-and-answer content shown on the CoinMarketCap homepage and Coin Detail Pages. This category includes **3** endpoints:\n- [/v5/cmc-ai/coins/map](/pro-api-reference/cmc-ai#cmc-ai-map) - CMC AI Map\n- [/v5/cmc-ai/latest](/pro-api-reference/cmc-ai#market-feed-latest) - Market Feed Latest\n- [/v5/cmc-ai/coins/latest](/pro-api-reference/cmc-ai#coin-insights-latest) - Coin Insights Latest" }, { "name": "Global Metrics", "description": "##### Endpoints for global aggregate market data. This category includes 6 endpoints:\n- [/v1/global-metrics/quotes/latest](/pro-api-reference/global-metrics#quotes-latest-3) - Quotes Latest\n- [/v1/global-metrics/quotes/historical](/pro-api-reference/global-metrics#quotes-historical-3) - Quotes Historical\n- [/v3/fear-and-greed/latest](/pro-api-reference/global-metrics#cmc-crypto-fear-and-greed-latest) - CMC Crypto Fear and Greed Latest\n- [/v3/fear-and-greed/historical](/pro-api-reference/global-metrics#cmc-crypto-fear-and-greed-historical) - CMC Crypto Fear and Greed Historical\n- [/v1/altcoin-season-index/latest](/pro-api-reference/global-metrics#altcoin-season-index-latest) - Altcoin Season Index Latest\n- [/v1/altcoin-season-index/historical](/pro-api-reference/global-metrics#altcoin-season-index-historical) - Altcoin Season Index Historical" }, { "name": "Content", "description": "##### Endpoints for content data. This category includes 4 endpoints:\n- [/v1/content/latest](/pro-api-reference/content#content-latest) - Content Latest\n- [/v1/content/posts/top](/pro-api-reference/content#content-top-posts) - Content Top Posts\n- [/v1/content/posts/latest](/pro-api-reference/content#content-latest-posts) - Content Latest Posts\n- [/v1/content/posts/comments](/pro-api-reference/content#content-post-comments) - Content Post Comments" }, { "name": "Community", "description": "##### Endpoints for community data. This category includes 2 endpoints:\n- [/v1/community/trending/topic](/pro-api-reference/community#community-trending-topics) - Community Trending Topics\n- [/v1/community/trending/token](/pro-api-reference/community#community-trending-tokens) - Community Trending Tokens" }, { "name": "CMC Index", "description": "##### CoinMarketCap market indices. This category includes 4 endpoints:\n- [/v3/index/cmc100-latest](/pro-api-reference/cmc-index#coinmarketcap-100-index-latest) - CoinMarketCap 100 Index Latest\n- [/v3/index/cmc100-historical](/pro-api-reference/cmc-index#coinmarketcap-100-index-historical) - CoinMarketCap 100 Index Historical\n- [/v3/index/cmc20-latest](/pro-api-reference/cmc-index#coinmarketcap-20-index-latest) - CoinMarketCap 20 Index Latest\n- [/v3/index/cmc20-historical](/pro-api-reference/cmc-index#coinmarketcap-20-index-historical) - CoinMarketCap 20 Index Historical" }, { "name": "Token", "description": "Comprehensive multi-market DEX trading and on-chain data covering hundreds of DEXs across Ethereum, Solana, BNB Chain, and more.\n\n##### This category includes 16 endpoints:\n- [/v4/dex/spot-pairs/latest](/pro-api-reference/token#pairs-listings-latest) - Pairs Listings Latest\n- [/v4/dex/pairs/quotes/latest](/pro-api-reference/token#quotes-latest-4) - Quotes Latest\n- [/v1/dex/token](/pro-api-reference/token#get-token-detail) - Get Token Detail\n- [/v1/dex/token/price](/pro-api-reference/token#get-token-price) - Get Token Price\n- [/v1/dex/token/price/batch](/pro-api-reference/token#batch-get-token-prices) - Batch Get Token Prices\n- [/v1/dex/tokens/batch-query](/pro-api-reference/token#batch-query-tokens) - Batch Query Tokens\n- [/v1/dex/token/pools](/pro-api-reference/token#get-token-pools) - Get Token Pools\n- [/v1/dex/token-liquidity/query](/pro-api-reference/token#query-token-liquidity) - Query Token Liquidity\n- [/v1/dex/tokens/transactions](/pro-api-reference/token#get-swap-list) - Get Swap List\n- [/v1/dex/tokens/trending/list](/pro-api-reference/token#get-trending-tokens) - Get Trending Tokens\n- [/v1/dex/new/list](/pro-api-reference/token#get-new-tokens) - Get New Tokens\n- [/v1/dex/meme/list](/pro-api-reference/token#get-meme-tokens) - Get Meme Tokens\n- [/v1/dex/gainer-loser/list](/pro-api-reference/token#get-top-gainers-and-losers) - Get Top Gainers and Losers\n- [/v1/dex/security/detail](/pro-api-reference/token#get-security-detail) - Get Security Detail\n- [/v1/dex/search](/pro-api-reference/token#search-tokens) - Search Tokens\n- [/v1/dex/liquidity-change/list](/pro-api-reference/token#get-liquidity-change-list) - Get Liquidity Change List" }, { "name": "Platform", "description": "##### DEX platform and network information. This category includes 2 endpoints:\n- [/v1/dex/platform/list](/pro-api-reference/platform#get-platform-list) - Get Platform List\n- [/v1/dex/platform/detail](/pro-api-reference/platform#get-platform-detail) - Get Platform Detail" }, { "name": "Holder", "description": "##### Token holder analytics and distribution data. This category includes 5 endpoints:\n- [/v1/dex/holders/list](/pro-api-reference/holder#get-holders-list) - Get Holders List\n- [/v1/dex/holders/detail](/pro-api-reference/holder#get-holder-detail) - Get Holder Detail\n- [/v1/dex/holders/trend/list](/pro-api-reference/holder#get-holder-trend-list) - Get Holder Trend List\n- [/v1/dex/holders/tag_count](/pro-api-reference/holder#get-holder-tag-count) - Get Holder Tag Count\n- [/v1/dex/holders/count](/pro-api-reference/holder#get-holder-count) - Get Holder Count" }, { "name": "OHLCV", "description": "##### K-line candlestick and OHLCV price data for DEX pairs. This category includes 2 endpoints:\n- [/v1/k-line/points](/pro-api-reference/ohlcv#get-k-line-points) - Get K-line Points\n- [/v1/k-line/candles](/pro-api-reference/ohlcv#get-k-line-candles) - Get K-line Candles" }, { "name": "Others", "description": "##### Additional DEX endpoints. This category includes 2 endpoints:\n- [/v1/blockchain/statistics/latest](/pro-api-reference/crypto-others#statistics-latest) - Statistics Latest\n- [/v4/dex/pairs/trade/latest](/pro-api-reference/deprecated#trades-latest) - Trades Latest" }, { "name": "Tools", "description": "##### Utility endpoints. This category includes 4 endpoints:\n- [/v2/tools/price-conversion](/pro-api-reference/tools#price-conversion-v2) - Price Conversion v2\n- [/v1/fiat/map](/pro-api-reference/tools#fiat-id-map) - Fiat ID Map (Fiat)\n- [/v1/key/info](/pro-api-reference/tools#key-info) - Key Info\n- [/v1/tools/postman](/pro-api-reference/tools#postman-conversion-v1) - Postman Conversion v1" }, { "name": "Deprecated", "description": "##### Deprecated (V1) Endpoints\n\nThese endpoints have been replaced by their V2/V3 versions and are no longer actively supported. We strongly recommend migrating to the latest versions.\n\n- [/v1/cryptocurrency/info](/pro-api-reference/deprecated#metadata-v1-deprecated) - Metadata v1\n- [/v1/tools/price-conversion](/pro-api-reference/deprecated#price-conversion-v1-deprecated) - Price Conversion v1\n- [/v1/cryptocurrency/listings/latest](/pro-api-reference/deprecated#listings-latest-v1-deprecated) - Listings Latest v1\n- [/v1/cryptocurrency/market-pairs/latest](/pro-api-reference/deprecated#market-pairs-latest-v1-deprecated) - Market Pairs Latest v1\n- [/v1/cryptocurrency/ohlcv/historical](/pro-api-reference/deprecated#ohlcv-historical-v1-deprecated) - OHLCV Historical v1\n- [/v1/cryptocurrency/ohlcv/latest](/pro-api-reference/deprecated#ohlcv-latest-v1-deprecated) - OHLCV Latest v1\n- [/v1/cryptocurrency/price-performance-stats/latest](/pro-api-reference/deprecated#price-performance-stats-v1-deprecated) - Price Performance Stats v1\n- [/v1/cryptocurrency/quotes/historical](/pro-api-reference/deprecated#quotes-historical-v1-deprecated) - Quotes Historical v1\n- [/v1/cryptocurrency/quotes/latest](/pro-api-reference/deprecated#quotes-latest-v1-deprecated) - Quotes Latest v1\n- [/v1/partners/flipside-crypto/fcas/listings/latest](/pro-api-reference/deprecated#fcas-listings-latest-deprecated) - FCAS Listings Latest\n- [/v1/partners/flipside-crypto/fcas/quotes/latest](/pro-api-reference/deprecated#fcas-quotes-latest-deprecated) - FCAS Quotes Latest\n- [/v1/simple/price](/pro-api-reference/deprecated#simple-price-v1-deprecated) - Simple Price v1\n\n##### Legacy cryptocurrency quotes (V2)\n\nPrefer [/v3/cryptocurrency/quotes/latest](/pro-api-reference/cryptocurrency#quotes-latest) and [/v3/cryptocurrency/quotes/historical](/pro-api-reference/cryptocurrency#quotes-historical).\n\n- [/v2/cryptocurrency/quotes/latest](/pro-api-reference/deprecated#quotes-latest-v2) - Quotes Latest v2\n- [/v2/cryptocurrency/quotes/historical](/pro-api-reference/deprecated#quotes-historical-v2) - Quotes Historical v2\n\n##### Legacy ERC-8056 UI multiplier endpoints\n\n- [/v1/cryptocurrency/multiplier](/pro-api-reference/deprecated#cryptocurrency-multiplier) - Cryptocurrency Multiplier\n- [/v2/dex/multiplier](/pro-api-reference/deprecated#get-token-multiplier) - Get Token Multiplier" } ], "paths": { "/v1/content/latest": { "get": { "summary": "Content Latest", "operationId": "getV1ContentLatest", "description": "Returns a paginated list of content pulled from CMC News/Headlines and Alexandria articles.\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Five Minutes\n**Plan credit use:** 0 credit", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } }, { "description": "Optionally pass a comma-separated list of CoinMarketCap cryptocurrency IDs. Example: \"1,1027\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Optionally pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Optionally pass a comma-separated list of cryptocurrency symbols. Example: \"BTC,ETH\". Optionally pass \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields: `news`, `community`, or `alexandria` to filter news sources. Pass `all` or leave it blank to include all news types.", "name": "news_type", "in": "query", "schema": { "type": "string", "pattern": "^(news|community|alexandria|all)+(?:,(news|community|alexandria|all)+)*$", "default": "all" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields: `news`, `video`, or `audio` to filter news's content. Pass `all` or leave it blank to include all content types.", "name": "content_type", "in": "query", "schema": { "type": "string", "pattern": "^(audio|news|video|all)+(?:,(audio|news|video|all)+)*$", "default": "all" } }, { "description": "Optionally pass a comma-separated list of categories. Example: \"GameFi,NFT\".", "name": "category", "in": "query", "schema": { "type": "string" } }, { "description": "Optionally pass a language code. Example: \"en\". If not specified the default value is \"en\".", "name": "language", "in": "query", "schema": { "type": "string", "enum": [ "en", "zh", "zh-tw", "de", "id", "ja", "ko", "es", "th", "tr", "vi", "ru", "fr", "nl", "ar", "pt-br", "hi", "pl", "uk", "fil-rph", "it" ], "default": "en" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Content_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["Content"] } }, "/v1/cryptocurrency/map": { "get": { "summary": "Cryptocurrency ID Map", "operationId": "getV1CryptocurrencyMap", "x-keyless": true, "description": "Returns a mapping of all cryptocurrencies to unique CoinMarketCap `id`s. Per our [Best practices](/guides/best-practices) we recommend utilizing CMC ID instead of cryptocurrency symbols to securely identify cryptocurrencies with our other endpoints and in your own application logic. Each cryptocurrency returned includes typical identifiers such as `name`, `symbol`, and `token_address` for flexible mapping to `id`. \n \n By default this endpoint returns cryptocurrencies that have actively tracked markets on supported exchanges. You may receive a map of all inactive cryptocurrencies by passing `listing_status=inactive`. You may also receive a map of registered cryptocurrency projects that are listed but do not yet meet methodology requirements to have tracked markets via `listing_status=untracked`. Please review our methodology documentation for additional details on listing states. \n \n Cryptocurrencies returned include `first_historical_data` and `last_historical_data` timestamps to conveniently reference historical date ranges available to query with historical time-series data endpoints. You may also use the `aux` parameter to only include properties you require to slim down the payload if calling this endpoint frequently. \n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n **No credit is needed when querying this endpoint.**\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/cryptocurrency/map`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Mapping data is updated only as needed, every 30 seconds. \n**CMC equivalent pages:** No equivalent, this data is only available via API.", "parameters": [ { "description": "Only active cryptocurrencies are returned by default. Pass `inactive` to get a list of cryptocurrencies that are no longer active. Pass `untracked` to get a list of cryptocurrencies that are listed but do not yet meet methodology requirements to have tracked markets available. You may pass one or more comma-separated values.", "name": "listing_status", "in": "query", "schema": { "type": "string", "pattern": "^(active|inactive|untracked)+(?:,(active|inactive|untracked)+)*$", "default": "active" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000 } }, { "description": "What field to sort the list of cryptocurrencies by.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["cmc_rank", "id"], "default": "id" } }, { "description": "Optionally pass a comma-separated list of cryptocurrency symbols to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `platform,first_historical_data,last_historical_data,is_active,status` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(platform|first_historical_data|last_historical_data|is_active|status)+(?:,(platform|first_historical_data|last_historical_data|is_active|status)+)*$", "default": "platform,first_historical_data,last_historical_data,is_active" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Map_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v3/cryptocurrency/listings/latest": { "get": { "tags": ["Cryptocurrency"], "summary": "Listings Latest", "description": "Returns a paginated list of all active cryptocurrencies with latest market data. The default \"market_cap\" sort returns cryptocurrency in order of CoinMarketCap's market cap rank (as outlined in [our methodology](https://coinmarketcap.com/methodology/)) but you may configure this call to order by another market ranking field. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n\nYou may sort against any of the following: \n**market_cap**: CoinMarketCap's market cap rank as outlined in [our methodology](https://coinmarketcap.com/methodology/). \n**market_cap_strict**: A strict market cap sort (latest trade price x circulating supply). \n**name**: The cryptocurrency name. \n**symbol**: The cryptocurrency symbol. \n**date_added**: Date cryptocurrency was added to the system. \n**price**: latest average trade price across markets. \n**circulating_supply**: approximate number of coins currently in circulation. \n**total_supply**: approximate total amount of coins in existence right now (minus any coins that have been verifiably burned). \n**max_supply**: our best approximation of the maximum amount of coins that will ever exist in the lifetime of the currency. \n**num_market_pairs**: number of market pairs across all exchanges trading each currency. \n**market_cap_by_total_supply_strict**: market cap by total supply. \n**volume_24h**: rolling 24 hour adjusted trading volume. \n**volume_7d**: rolling 24 hour adjusted trading volume. \n**volume_30d**: rolling 24 hour adjusted trading volume. \n**percent_change_1h**: 1 hour trading price percentage change for each currency. \n**percent_change_24h**: 24 hour trading price percentage change for each currency. \n**percent_change_7d**: 7 day trading price percentage change for each currency. \n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/cryptocurrency/listings/latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per \\`convert\\` option beyond the first.\n**CMC equivalent pages:** Our latest cryptocurrency listing and ranking pages like [coinmarketcap.com/all/views/all/](https://coinmarketcap.com/all/views/all/), [coinmarketcap.com/tokens/](https://coinmarketcap.com/tokens/), [coinmarketcap.com/gainers-losers/](https://coinmarketcap.com/gainers-losers/), [coinmarketcap.com/new/](https://coinmarketcap.com/new/). \n \n***NOTE:** Use this endpoint if you need a sorted and paginated list of all cryptocurrencies. If you want to query for market data on a few specific cryptocurrencies use `/v3/cryptocurrency/quotes/latest` which is optimized for that purpose. The response data between these endpoints is otherwise the same.* ", "operationId": "getV3CryptocurrencyListingsLatest", "x-keyless": true, "parameters": [ { "name": "start", "in": "query", "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "required": false, "example": "50", "schema": { "type": "string", "default": "1" } }, { "name": "limit", "in": "query", "description": "Optionally specify the number of results to return. Use this parameter and the \\\"start\\\" parameter to determine your own pagination size.", "required": false, "example": "100", "schema": { "type": "string", "default": "100" } }, { "name": "price_min", "in": "query", "description": "Optionally specify a threshold of minimum USD price to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "price_max", "in": "query", "description": "Optionally specify a threshold of maximum USD price to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "market_cap_min", "in": "query", "description": "Optionally specify a threshold of minimum market cap to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "market_cap_max", "in": "query", "description": "Optionally specify a threshold of maximum market cap to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "volume_24h_min", "in": "query", "description": "Optionally specify a threshold of minimum 24 hour USD volume to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "volume_24h_max", "in": "query", "description": "Optionally specify a threshold of maximum 24 hour USD volume to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "circulating_supply_min", "in": "query", "description": "Optionally specify a threshold of minimum circulating supply to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "circulating_supply_max", "in": "query", "description": "Optionally specify a threshold of maximum circulating supply to filter results by.", "required": false, "example": "50000", "schema": { "type": "string" } }, { "name": "percent_change_24h_min", "in": "query", "description": "Optionally specify a threshold of minimum 24 hour percent change to filter results by.", "required": false, "example": "-10", "schema": { "type": "string" } }, { "name": "percent_change_24h_max", "in": "query", "description": "Optionally specify a threshold of maximum 24 hour percent change to filter results by.", "required": false, "example": "15", "schema": { "type": "string" } }, { "name": "convert", "in": "query", "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. Each conversion is returned in its own \"quote\" object.", "required": false, "example": "USD,BTC", "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "required": false, "example": "1,1027", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "What field to sort the list of cryptocurrencies by.", "required": false, "example": "market_cap", "schema": { "type": "string", "default": "market_cap" } }, { "name": "sort_dir", "in": "query", "description": "The direction in which to order cryptocurrencies against the specified sort.", "required": false, "example": "desc", "schema": { "type": "string", "default": "desc" } }, { "name": "cryptocurrency_type", "in": "query", "description": "The type of cryptocurrency to include.", "required": false, "example": "all", "schema": { "type": "string", "default": "all" } }, { "name": "tag", "in": "query", "description": "The tag of cryptocurrency to include.", "required": false, "example": "all", "schema": { "type": "string", "default": "all" } }, { "name": "aux", "in": "query", "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_market_cap_included_in_calc to include all auxiliary fields.", "required": false, "example": "num_market_pairs,cmc_rank,date_added", "schema": { "type": "string", "default": "num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CryptoListingDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "example": { "data": [ { "tags": ["mineable"], "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "infinite_supply": false, "circulating_supply": 20044984, "total_supply": 20044984, "max_supply": 21000000, "date_added": "2010-07-13T00:00:00.000Z", "num_market_pairs": 12660, "cmc_rank": 1, "last_updated": "2026-06-19T14:02:00.000Z", "tvl_ratio": null, "platform": null, "self_reported_circulating_supply": null, "self_reported_market_cap": null, "minted_market_cap": 1265258535378.41, "quote": [ { "id": 2781, "symbol": "USD", "price": 63120.95511667226, "volume_24h": 29127614493.57435608, "volume_change_24h": -8.4273, "cex_volume_24h": 29080164577.90644455, "dex_volume_24h": 47449915.66790789, "percent_change_1h": 0.61500999, "percent_change_24h": -1.19783194, "percent_change_7d": -0.28271701, "percent_change_30d": -18.14292343, "percent_change_60d": -16.03754846, "percent_change_90d": -10.78181948, "market_cap": 1265258535378.41358494384, "market_cap_dominance": 58.2494, "fully_diluted_market_cap": 1325540057450.12, "minted_market_cap": 1265258535378.41, "tvl": null, "last_updated": "2026-06-19T14:02:00.000Z" } ] }, { "tags": ["stablecoin"], "id": 825, "name": "Tether USDt", "symbol": "USDT", "slug": "tether", "infinite_supply": true, "circulating_supply": 186471454928.25273965, "total_supply": 193153431960.50647024, "max_supply": null, "date_added": "2015-02-25T00:00:00.000Z", "num_market_pairs": 186448, "cmc_rank": 3, "last_updated": "2026-06-19T14:01:00.000Z", "tvl_ratio": null, "platform": { "id": 1027, "slug": "ethereum", "name": "Ethereum", "symbol": "ETH", "token_address": "0xdac17f958d2ee523a2206206994597c13d831ec7" }, "self_reported_circulating_supply": null, "self_reported_market_cap": null, "minted_market_cap": 192954912191.18, "quote": [ { "id": 2781, "symbol": "USD", "price": 0.9989722172300717, "volume_24h": 62071695050.04424286, "volume_change_24h": -12.0707, "cex_volume_24h": 60510731381.50478363, "dex_volume_24h": 1560963668.53940129, "percent_change_1h": -0.0150212, "percent_change_24h": 0.02100214, "percent_change_7d": 0.00457887, "percent_change_30d": -0.00471566, "percent_change_60d": -0.14441328, "percent_change_90d": -0.08226185, "market_cap": 186279802779.794019901300789891, "market_cap_dominance": 8.5763, "fully_diluted_market_cap": 192954912191.18, "minted_market_cap": 192954912191.18, "tvl": null, "last_updated": "2026-06-19T14:01:00.000Z" } ] }, { "tags": ["stablecoin"], "id": 3408, "name": "USDC", "symbol": "USDC", "slug": "usd-coin", "infinite_supply": false, "circulating_supply": 74934715491.34196091, "total_supply": 74934715491.34196091, "max_supply": null, "date_added": "2018-10-08T00:00:00.000Z", "num_market_pairs": 40513, "cmc_rank": 5, "last_updated": "2026-06-19T14:01:00.000Z", "tvl_ratio": null, "platform": { "id": 1027, "slug": "ethereum", "name": "Ethereum", "symbol": "ETH", "token_address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48" }, "self_reported_circulating_supply": 60901219650.23, "self_reported_market_cap": 60891043102.079188390595587485, "minted_market_cap": 74922193956.56, "quote": [ { "id": 2781, "symbol": "USD", "price": 0.9998329007496195, "volume_24h": 9375210843.24513054, "volume_change_24h": -22.0589, "cex_volume_24h": 7294870263.14053154, "dex_volume_24h": 2080340580.10459399, "percent_change_1h": 0.00101421, "percent_change_24h": 0.01332693, "percent_change_7d": 0.00411852, "percent_change_30d": 0.0208214, "percent_change_60d": -0.00167445, "percent_change_90d": -0.00818018, "market_cap": 74922193956.555881627593954066, "market_cap_dominance": 3.4492, "fully_diluted_market_cap": 74922193956.56, "minted_market_cap": 74922193956.56, "tvl": null, "last_updated": "2026-06-19T14:01:00.000Z" } ] }, { "tags": ["ethereum-ecosystem"], "id": 5176, "name": "Tether Gold", "symbol": "XAUt", "slug": "tether-gold", "infinite_supply": false, "circulating_supply": 612823.659532, "total_supply": 707747.089, "max_supply": null, "date_added": "2020-02-07T00:00:00.000Z", "num_market_pairs": 401, "cmc_rank": 33, "last_updated": "2026-06-19T14:01:00.000Z", "tvl_ratio": 0.85231497, "platform": { "id": 1027, "slug": "ethereum", "name": "Ethereum", "symbol": "ETH", "token_address": "0x68749665FF8D2d112Fa859AA293F07A622782F38" }, "self_reported_circulating_supply": 48450, "self_reported_market_cap": 200583379.141852878, "minted_market_cap": 2930078486.88, "quote": [ { "id": 2781, "symbol": "USD", "price": 4140.00782542524, "volume_24h": 192201727.25124744, "volume_change_24h": -34.2878, "cex_volume_24h": 181966210.11893946, "dex_volume_24h": 10235517.13230798, "percent_change_1h": -0.57455114, "percent_change_24h": -2.25096351, "percent_change_7d": -0.78415585, "percent_change_30d": -7.59755401, "percent_change_60d": -13.72518949, "percent_change_90d": -7.84994801, "market_cap": 2537094746.06821297087938768, "market_cap_dominance": 0.1168, "fully_diluted_market_cap": 2930078486.88, "minted_market_cap": 2930078486.88, "tvl": 2976710281, "last_updated": "2026-06-19T14:01:00.000Z" } ] } ], "status": { "timestamp": "2026-06-19T14:03:33.664Z", "error_code": 0, "error_message": "", "elapsed": 8, "credit_count": 1 } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/listings/new": { "get": { "summary": "Listings New", "operationId": "getV1CryptocurrencyListingsNew", "description": "Returns a paginated list of most recently added cryptocurrencies.\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our \"new\" cryptocurrency page [coinmarketcap.com/new/](https://coinmarketcap.com/new)\n \n***NOTE:** Use this endpoint if you need a sorted and paginated list of all recently added cryptocurrencies.* ", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "The direction in which to order cryptocurrencies against the specified sort.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"] } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Listings_New_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/listings/historical": { "get": { "summary": "Listings Historical", "operationId": "getV1CryptocurrencyListingsHistorical", "description": "Returns a ranked and sorted list of all cryptocurrencies for a historical UTC date. \n\n\n**Technical Notes**\n- This endpoint is identical in format to our `/cryptocurrency/listings/latest` endpoint but is used to retrieve historical daily ranking snapshots from the end of each UTC day. \n- Daily snapshots reflect market data at the end of each UTC day and may be requested as far back as 2013-04-28 (as supported by your plan's historical limits). \n- The required \"date\" parameter can be passed as a Unix timestamp or ISO 8601 date but only the date portion of the timestamp will be referenced. It is recommended to send an ISO date format like \"2019-10-10\" without time.\n- This endpoint is for retrieving paginated and sorted lists of all currencies. If you require historical market data on specific cryptocurrencies you should use `/cryptocurrency/quotes/historical`.\n \n\n\nCryptocurrencies are listed by cmc_rank by default. You may optionally sort against any of the following: \n**cmc_rank**: CoinMarketCap's market cap rank as outlined in [our methodology](https://coinmarketcap.com/methodology/). \n**name**: The cryptocurrency name. \n**symbol**: The cryptocurrency symbol. \n**market_cap**: market cap (latest trade price x circulating supply). \n**price**: latest average trade price across markets. \n**circulating_supply**: approximate number of coins currently in circulation. \n**total_supply**: approximate total amount of coins in existence right now (minus any coins that have been verifiably burned). \n**max_supply**: our best approximation of the maximum amount of coins that will ever exist in the lifetime of the currency. \n**num_market_pairs**: number of market pairs across all exchanges trading each currency. \n**volume_24h**: 24 hour trading volume for each currency. \n**percent_change_1h**: 1 hour trading price percentage change for each currency. \n**percent_change_24h**: 24 hour trading price percentage change for each currency. \n**percent_change_7d**: 7 day trading price percentage change for each currency. \n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (1 year)\n- Builder (3 years)\n- Startup (from 2013)\n- Growth (from 2013)\n- Professional (from 2013)\n- Enterprise (from 2013)\n\n**Cache / Update frequency:** The last completed UTC day is available 30 minutes after midnight on the next UTC day. \n**Plan credit use:** 1 call credit per 100 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our historical daily crypto ranking snapshot pages like this one on [February 02, 2014](https://coinmarketcap.com/historical/20140202/).", "parameters": [ { "description": "date (Unix or ISO 8601) to reference day of snapshot.", "name": "date", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "What field to sort the list of cryptocurrencies by.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "cmc_rank", "name", "symbol", "market_cap", "price", "circulating_supply", "total_supply", "max_supply", "num_market_pairs", "volume_24h", "percent_change_1h", "percent_change_24h", "percent_change_7d" ], "default": "cmc_rank" } }, { "description": "The direction in which to order cryptocurrencies against the specified sort.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"] } }, { "description": "The type of cryptocurrency to include.", "name": "cryptocurrency_type", "in": "query", "schema": { "type": "string", "enum": ["all", "coins", "tokens"], "default": "all" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `platform,tags,date_added,circulating_supply,total_supply,max_supply,cmc_rank,num_market_pairs` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(platform|tags|date_added|circulating_supply|total_supply|max_supply|cmc_rank|num_market_pairs)+(?:,(platform|tags|date_added|circulating_supply|total_supply|max_supply|cmc_rank|num_market_pairs)+)*$", "default": "platform,tags,date_added,circulating_supply,total_supply,max_supply,cmc_rank,num_market_pairs" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v3/cryptocurrency/quotes/latest": { "get": { "tags": ["Cryptocurrency"], "summary": "Quotes Latest", "description": "Returns the latest market quote for 1 or more cryptocurrencies. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**Please note**: This documentation relates to our updated V3 endpoint, which may be incompatible with our V2 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic\n- Startup\n- Builder\n- Growth\n- Professional\n- Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/cryptocurrency/quotes/latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per \\`convert\\` option beyond the first. \n**CMC equivalent pages:** Latest market data pages for specific cryptocurrencies like [coinmarketcap.com/currencies/bitcoin/](https://coinmarketcap.com/currencies/bitcoin/). \n \n***NOTE:** Use this endpoint to request the latest quote for specific cryptocurrencies. If you need to request all cryptocurrencies use `/v3/cryptocurrency/listings/latest` which is optimized for that purpose. The response data between these endpoints is otherwise the same.*", "operationId": "getV3CryptocurrencyQuotesLatest", "x-keyless": true, "parameters": [ { "name": "id", "in": "query", "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs.", "required": false, "schema": { "type": "string" } }, { "name": "slug", "in": "query", "description": "Alternatively pass a comma-separated list of cryptocurrency slugs.", "required": false, "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "Alternatively pass one or more comma-separated cryptocurrency symbols.", "required": false, "schema": { "type": "string" } }, { "name": "convert", "in": "query", "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols.", "required": false, "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol.", "required": false, "schema": { "type": "string" } }, { "name": "aux", "in": "query", "description": "Optionally specify a comma-separated list of supplemental data fields to return.", "required": false, "schema": { "type": "string" } }, { "name": "skip_invalid", "in": "query", "description": "Pass true to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V3_Cryptocurrency_Quotes_Latest_-_Response_Model" } } } } } } }, "/v3/cryptocurrency/quotes/historical": { "get": { "summary": "Quotes Historical", "operationId": "getV3CryptocurrencyQuotesHistorical", "description": "Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.\n\n**Please note**: This documentation relates to our updated V3 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n**Technical Notes** \n- A historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned. \n- If a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\". \n- If \"time_end\" is not supplied, it defaults to the current time. \n- At each \"interval\" period, the historic quote that is closest in time to the requested time will be returned. \n- If no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped. \n\n**Implementation Tips**\n- Want to get the last quote of each UTC day? Don't use \"interval=daily\" as that returns the first quote. Instead use \"interval=24h\" to repeat a specific timestamp search every 24 hours and pass ex. \"time_start=2019-01-04T23:59:00.000Z\" to query for the last record of each UTC day.\n- This endpoint supports requesting multiple cryptocurrencies in the same call. Please note the API response will be wrapped in an additional object in this case. \n \n**Interval Options** \nThere are 2 types of time interval formats that may be used for \"interval\".\n\nThe first are calendar year and time constants in UTC time: \n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour. \n**\"daily\"** - Get the first quote available at the beginning of each calendar day. \n**\"weekly\"** - Get the first quote available at the beginning of each calendar week. \n**\"monthly\"** - Get the first quote available at the beginning of each calendar month. \n**\"yearly\"** - Get the first quote available at the beginning of each calendar year. \n\nThe second are relative time intervals. \n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\". \n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"4h\", \"6h\", \"12h\". \n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\". \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (intraday: 1 month, daily: 1 year)\n- Builder (intraday: 1 month, daily: 3 years)\n- Startup (intraday: 1 month, daily: from 2010)\n- Growth (intraday: 3 months, daily: from 2010)\n- Professional (intraday: 12 months, daily: from 2010)\n- Enterprise (intraday: from 2010, daily: from 2010)\n\n**Note:** Intraday = `5m-12h` intervals, Daily = `1d-1y` intervals\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 call credit per 100 historical data points returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our historical cryptocurrency charts like [coinmarketcap.com/currencies/bitcoin/#charts](https://coinmarketcap.com/currencies/bitcoin/#charts). ", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".", "name": "time_start", "in": "query", "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.", "name": "time_end", "in": "query", "schema": { "type": "string" } }, { "description": "The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 10 items. The current query limit is 10000.", "name": "count", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 10000, "default": 10 } }, { "description": "Interval of time to return data points for. See details in endpoint description.", "name": "interval", "in": "query", "schema": { "type": "string", "enum": [ "yearly", "monthly", "weekly", "daily", "hourly", "5m", "10m", "15m", "30m", "45m", "1h", "2h", "3h", "4h", "6h", "12h", "24h", "1d", "2d", "3d", "7d", "14d", "15d", "30d", "60d", "90d", "365d" ], "default": "5m" } }, { "description": "By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "(^\\d+(?:,\\d+)*$|(\\d,)*PLATFORM_ID+(?:,\\d+)*$)" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat,search_interval` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(price|volume|market_cap|circulating_supply|total_supply|quote_timestamp|is_active|is_fiat|search_interval)+(?:,(price|volume|market_cap|circulating_supply|total_supply|quote_timestamp|is_active|is_fiat|search_interval)+)*$", "default": "price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/cryptocurrency/ohlcv/latest": { "get": { "summary": "OHLCV Latest", "operationId": "getV2CryptocurrencyOhlcvLatest", "description": "Returns the latest OHLCV (Open, High, Low, Close, Volume) market values for one or more cryptocurrencies for the current UTC day. Since the current UTC day is still active these values are updated frequently. You can find the final calculated OHLCV values for the last completed UTC day along with all historic days using /cryptocurrency/ohlcv/historical. \n\n**Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n **Cache / Update frequency:** Every 10 minutes. Additional OHLCV intervals and 1 minute updates will be available in the future. \n **Plan credit use:** 1 call credit per 250 OHLCV values returned (rounded up) and 1 call credit per `convert` option beyond the first. \n **CMC equivalent pages:** No equivalent, this data is only available via API.", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"symbol\" is required.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/cryptocurrency/ohlcv/historical": { "get": { "summary": "OHLCV Historical", "operationId": "getV2CryptocurrencyOhlcvHistorical", "description": "Returns historical OHLCV (Open, High, Low, Close, Volume) data along with market cap for any cryptocurrency using time interval parameters. Currently daily and hourly OHLCV periods are supported. Volume is not currently supported for hourly OHLCV intervals before 2020-09-22.\n\n**Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n \n**Technical Notes**\n- Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like \"2018-09-19\" without time for this \"time_period\". \n- One OHLCV quote will be returned for every \"time_period\" between your \"time_start\" (exclusive) and \"time_end\" (inclusive). \n- If a \"time_start\" is not supplied, the \"time_period\" will be calculated in reverse from \"time_end\" using the \"count\" parameter which defaults to 10 results. \n- If \"time_end\" is not supplied, it defaults to the current time. \n- If you don't need every \"time_period\" between your dates you may adjust the frequency that \"time_period\" is sampled using the \"interval\" parameter. For example with \"time_period\" set to \"daily\" you may set \"interval\" to \"2d\" to get the daily OHLCV for every other day. You could set \"interval\" to \"monthly\" to get the first daily OHLCV for each month, or set it to \"yearly\" to get the daily OHLCV value against the same date every year. \n\n**Implementation Tips**\n- If querying for a specific OHLCV date your \"time_start\" should specify a timestamp of 1 interval prior as \"time_start\" is an exclusive time parameter (as opposed to \"time_end\" which is inclusive to the search). This means that when you pass a \"time_start\" results will be returned for the *next* complete \"time_period\". For example, if you are querying for a daily OHLCV datapoint for 2018-11-30 your \"time_start\" should be \"2018-11-29\". \n- If only specifying a \"count\" parameter to return latest OHLCV periods, your \"count\" should be 1 number higher than the number of results you expect to receive. \"Count\" defines the number of \"time_period\" intervals queried, *not* the number of results to return, and this includes the currently active time period which is incomplete when working backwards from current time. For example, if you want the last daily OHLCV value available simply pass \"count=2\" to skip the incomplete active time period.\n- This endpoint supports requesting multiple cryptocurrencies in the same call. Please note the API response will be wrapped in an additional object in this case. \n \n**Interval Options** \n \nThere are 2 types of time interval formats that may be used for \"time_period\" and \"interval\" parameters. For \"time_period\" these return aggregate OHLCV data from the beginning to end of each interval period. Apply these time intervals to \"interval\" to adjust how frequently \"time_period\" is sampled. \n \nThe first are calendar year and time constants in UTC time: \n**\"hourly\"** - Hour intervals in UTC. \n**\"daily\"** - Calendar day intervals for each UTC day. \n**\"weekly\"** - Calendar week intervals for each calendar week. \n**\"monthly\"** - Calendar month intervals for each calendar month. \n**\"yearly\"** - Calendar year intervals for each calendar year. \n \nThe second are relative time intervals. \n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"4h\", \"6h\", \"12h\". \n**\"d\"**: Time periods that repeat every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\". \n \nPlease note that \"time_period\" currently supports the \"daily\" and \"hourly\" options. \"interval\" supports all interval options. \n \n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- ~~Basic~~\n- ~~Builder~~\n- Startup (intraday: 1 month, daily: from 2010)\n- Growth (intraday: 3 months, daily: from 2010)\n- Professional (intraday: 12 months, daily: from 2010)\n- Enterprise (intraday: from 2010, daily: from 2010)\n\n**Note:** Intraday = `5m-12h` intervals, Daily = `1d-1y` intervals\n\n**Cache / Update frequency:** Latest Daily OHLCV record is available ~5 to ~10 minutes after each midnight UTC. The latest hourly OHLCV record is available 5 minutes after each UTC hour. \n**Plan credit use:** 1 call credit per 100 OHLCV data points returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our historical cryptocurrency data pages like [coinmarketcap.com/currencies/bitcoin/historical-data/](https://coinmarketcap.com/currencies/bitcoin/historical-data/).", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,1027\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Time period to return OHLCV data for. The default is \"daily\". If hourly, the open will be 01:00 and the close will be 01:59. If daily, the open will be 00:00:00 for the day and close will be 23:59:99 for the same day. See the main endpoint description for details.", "name": "time_period", "in": "query", "schema": { "type": "string", "enum": ["daily", "hourly"], "default": "daily" } }, { "description": "Timestamp (Unix or ISO 8601) to start returning OHLCV time periods for. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like \"2018-09-19\" without time.", "name": "time_start", "in": "query", "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning OHLCV time periods for (inclusive). Optional, if not passed we'll default to the current time. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like \"2018-09-19\" without time.", "name": "time_end", "in": "query", "schema": { "type": "string" } }, { "description": "Optionally limit the number of time periods to return results for. The default is 10 items. The current query limit is 10000 items.", "name": "count", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 10000, "default": 10 } }, { "description": "Optionally adjust the interval that \"time_period\" is sampled. For example with interval=monthly&time_period=daily you will see a daily OHLCV record for January, February, March and so on. See main endpoint description for available options.", "name": "interval", "in": "query", "schema": { "type": "string", "enum": [ "hourly", "daily", "weekly", "monthly", "yearly", "1h", "2h", "3h", "4h", "6h", "12h", "1d", "2d", "3d", "7d", "14d", "15d", "30d", "60d", "90d", "365d" ], "default": "daily" } }, { "description": "By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 fiat currencies or cryptocurrencies.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/cryptocurrency/market-pairs/latest": { "get": { "summary": "Market Pairs Latest", "operationId": "getV2CryptocurrencyMarketpairsLatest", "description": "Lists all active market pairs that CoinMarketCap tracks for a given cryptocurrency or fiat currency. All markets with this currency as the pair base *or* pair quote will be returned. The latest price and volume information is returned for each market. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n\n**Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - ~~Startup~~\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 1 minute. \n**Plan credit use:** 1 call credit per 250 market pairs returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our active cryptocurrency markets pages like [coinmarketcap.com/currencies/bitcoin/#markets](https://coinmarketcap.com/currencies/bitcoin/#markets). ", "parameters": [ { "description": "A cryptocurrency or fiat currency by CoinMarketCap ID to list market pairs for. Example: \"1\"", "name": "id", "in": "query", "schema": { "type": "string" } }, { "description": "Alternatively pass a cryptocurrency by slug. Example: \"bitcoin\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]*$" } }, { "description": "Alternatively pass a cryptocurrency by symbol. Fiat currencies are not supported by this field. Example: \"BTC\". A single cryptocurrency \"id\", \"slug\", *or* \"symbol\" is required.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]*$" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify the sort direction of markets returned.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" } }, { "description": "Optionally specify the sort order of markets returned. By default we return a strict sort on 24 hour reported volume. Pass `cmc_rank` to return a CMC methodology based sort where markets with excluded volumes are returned last.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "volume_24h_strict", "cmc_rank", "cmc_rank_advanced", "effective_liquidity", "market_score", "market_reputation" ], "default": "volume_24h_strict" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,category,fee_type,market_url,currency_name,currency_slug,price_quote,notice,cmc_rank,effective_liquidity,market_score,market_reputation` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|category|fee_type|market_url|currency_name|currency_slug|price_quote|notice|cmc_rank|effective_liquidity|market_score|market_reputation)+(?:,(num_market_pairs|category|fee_type|market_url|currency_name|currency_slug|price_quote|notice|cmc_rank|effective_liquidity|market_score|market_reputation)+)*$", "default": "num_market_pairs,category,fee_type" } }, { "description": "Optionally include one or more fiat or cryptocurrency IDs to filter market pairs by. For example `?id=1&matched_id=2781` would only return BTC markets that matched: \"BTC/USD\" or \"USD/BTC\". This parameter cannot be used when `matched_symbol` is used.", "name": "matched_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Optionally include one or more fiat or cryptocurrency symbols to filter market pairs by. For example `?symbol=BTC&matched_symbol=USD` would only return BTC markets that matched: \"BTC/USD\" or \"USD/BTC\". This parameter cannot be used when `matched_id` is used.", "name": "matched_symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.", "name": "category", "in": "query", "schema": { "type": "string", "enum": ["all", "spot", "derivatives", "otc", "perpetual"], "default": "all" } }, { "description": "The fee type the exchange enforces for this market.", "name": "fee_type", "in": "query", "schema": { "type": "string", "enum": ["all", "percentage", "no-fees", "transactional-mining", "unknown"], "default": "all" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/cryptocurrency/price-performance-stats/latest": { "get": { "summary": "Price Performance Stats", "operationId": "getV2CryptocurrencyPriceperformancestatsLatest", "description": "Returns price performance statistics for one or more cryptocurrencies including launch price ROI and all-time high / all-time low. Stats are returned for an `all_time` period by default. UTC `yesterday` and a number of *rolling time periods* may be requested using the `time_period` parameter. Utilize the `convert` parameter to translate values into multiple fiats or cryptocurrencies using historical rates.\n\n\n**Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** The statistics module displayed on cryptocurrency pages like [Bitcoin](https://coinmarketcap.com/currencies/bitcoin/). \n \n***NOTE:** You may also use `/cryptocurrency/ohlcv/historical` for traditional OHLCV data at historical daily and hourly intervals. You may also use `/v1/cryptocurrency/ohlcv/latest` for OHLCV data for the current UTC day.* ", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Specify one or more comma-delimited time periods to return stats for. `all_time` is the default. Pass `all_time,yesterday,24h,7d,30d,90d,365d` to return all supported time periods. All rolling periods have a rolling close time of the current request time. For example `24h` would have a close time of now and an open time of 24 hours before now. *Please note: `yesterday` is a UTC period and currently does not currently support `high` and `low` timestamps.*", "name": "time_period", "in": "query", "schema": { "type": "string", "pattern": "^(all_time|yesterday|24h|7d|30d|90d|365d)+(?:,(all_time|yesterday|24h|7d|30d|90d|365d)+)*$", "default": "all_time" } }, { "description": "Optionally calculate quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/cryptocurrency/info": { "get": { "summary": "Metadata", "operationId": "getV2CryptocurrencyInfo", "x-keyless": true, "description": "Returns all static metadata available for one or more cryptocurrencies. This information includes details like logo, description, official website URL, social links, and links to a cryptocurrency's technical documentation.\n\n**Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic\n- Startup\n- Builder\n- Growth\n- Professional\n- Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v2/cryptocurrency/info`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Static data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up). \n**CMC equivalent pages:** Cryptocurrency detail page metadata like [coinmarketcap.com/currencies/bitcoin/](https://coinmarketcap.com/currencies/bitcoin/). ", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each data response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Alternatively pass in a contract address. Example: \"0xc40af1e4fecfa05ce6bab79dcd8b373d2e436c4e\"", "name": "address", "in": "query", "schema": { "type": "string" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": false } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `urls,logo,description,tags,platform,date_added,notice,status` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(urls|logo|description|tags|platform|date_added|notice|status)+(?:,(urls|logo|description|tags|platform|date_added|notice|status)+)*$", "default": "urls,logo,description,tags,platform,date_added,notice" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrencies_Info_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/trending/latest": { "get": { "summary": "Trending Latest", "operationId": "getV1CryptocurrencyTrendingLatest", "description": "Returns a paginated list of all trending cryptocurrency market data, determined and sorted by CoinMarketCap search volume.\n\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 10 minutes. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our cryptocurrency Trending page [coinmarketcap.com/trending-cryptocurrencies/](https://coinmarketcap.com/trending-cryptocurrencies/).", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "description": "Adjusts the overall window of time for the latest trending coins.", "name": "time_period", "in": "query", "schema": { "type": "string", "enum": ["24h", "30d", "7d"], "default": "24h" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Trending_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/trending/gainers-losers": { "get": { "summary": "Trending Gainers & Losers", "operationId": "getV1CryptocurrencyTrendingGainerslosers", "description": "Returns a paginated list of all trending cryptocurrencies, determined and sorted by the largest price gains or losses.\n\n\nYou may sort against any of the following: \n**percent_change_24h**: 24 hour trading price percentage change for each currency.\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 10 minutes. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our cryptocurrency Gainers & Losers page [coinmarketcap.com/gainers-losers/](https://coinmarketcap.com/gainers-losers/).", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "description": "Adjusts the overall window of time for the biggest gainers and losers.", "name": "time_period", "in": "query", "schema": { "type": "string", "enum": ["1h", "24h", "30d", "7d"], "default": "24h" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "What field to sort the list of cryptocurrencies by.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["percent_change_24h"], "default": "percent_change_24h" } }, { "description": "The direction in which to order cryptocurrencies against the specified sort.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"] } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Trending_Gainers_Losers_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/trending/most-visited": { "get": { "summary": "Trending Most Visited", "operationId": "getV1CryptocurrencyTrendingMostvisited", "description": "Returns a paginated list of all trending cryptocurrency market data, determined and sorted by traffic to coin detail pages.\n\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 24 hours. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** The CoinMarketCap “Most Visited” trending list. [coinmarketcap.com/most-viewed-pages/](https://coinmarketcap.com/most-viewed-pages/).", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "description": "Adjusts the overall window of time for most visited currencies.", "name": "time_period", "in": "query", "schema": { "type": "string", "enum": ["24h", "30d", "7d"], "default": "24h" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Trending_Most_Visited_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/simple/price": { "get": { "summary": "Simple Price", "operationId": "getV2SimplePrice", "x-keyless": true, "description": "Returns a lightweight latest price for one or more cryptocurrencies, with optional inline market cap, 24h volume, 24h change, and freshness timestamp. It is a slimmed-down alternative to [/v3/cryptocurrency/quotes/latest](/pro-api-reference/cryptocurrency#quotes-latest), optimized for the single most common question - \"what is X worth right now\" - without returning the full `quote` object.\n\nYou can look assets up by `id`, `slug`, or `symbol`, and at least one of those is required. The endpoint deliberately does not return supply, rank, market pairs, or descriptive metadata; for any of those, use [/v3/cryptocurrency/quotes/latest](/pro-api-reference/cryptocurrency#quotes-latest) or [/v2/cryptocurrency/info](/pro-api-reference/cryptocurrency#metadata) instead.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v2/simple/price`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up), plus 1 credit per `convert` / `convert_id` option beyond the first. The `include_*` flags do not add credits.", "parameters": [ { "name": "id", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: `1,1027`. The preferred identifier - stable and unambiguous. At least one of `id`, `slug`, or `symbol` is required.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "1,1027" } }, { "name": "slug", "in": "query", "description": "Alternatively pass comma-separated cryptocurrency slugs. Example: `bitcoin,ethereum`.", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "bitcoin,ethereum" } }, { "name": "symbol", "in": "query", "description": "Alternatively pass comma-separated cryptocurrency symbols. Example: `BTC,ETH`. When a symbol matches multiple assets the highest-market-cap match is returned; use `id` to disambiguate.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "BTC,ETH" } }, { "name": "convert", "in": "query", "description": "Optionally calculate price in up to 120 fiat or cryptocurrency conversions at once by passing a comma-separated list of symbols. Each conversion beyond the first costs 1 additional call credit and is returned as its own entry in `quotes[]`. Cannot be used with `convert_id`.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+(?:,[0-9A-Za-z$@\\-]+)*$", "default": "USD", "example": "USD" } }, { "name": "convert_id", "in": "query", "description": "Same as `convert`, but by CoinMarketCap currency ID instead of symbol. Example: `convert_id=2781`. Cannot be used with `convert`.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "2781" } }, { "name": "include_market_cap", "in": "query", "description": "Include `market_cap` in each quote object.", "schema": { "type": "boolean", "default": false } }, { "name": "include_24h_volume", "in": "query", "description": "Include `volume_24h` in each quote object.", "schema": { "type": "boolean", "default": false } }, { "name": "include_24h_change", "in": "query", "description": "Include `percent_change_24h` in each quote object.", "schema": { "type": "boolean", "default": false } }, { "name": "include_last_updated", "in": "query", "description": "Include `last_updated` (ISO 8601) in each quote object.", "schema": { "type": "boolean", "default": false } }, { "name": "include_all", "in": "query", "description": "Shortcut to enable `include_market_cap`, `include_24h_volume`, `include_24h_change`, and `include_last_updated` together. When `true` it wins over an individual flag set to `false`. Does not add credits.", "schema": { "type": "boolean", "default": false } }, { "name": "precision", "in": "query", "description": "Round all price, market-cap, and volume values to this many decimal places. Omit for full precision.", "schema": { "type": "integer", "minimum": 0, "maximum": 18 } }, { "name": "skip_invalid", "in": "query", "description": "When multiple assets are requested, skip invalid lookups and return the valid ones rather than failing the whole request.", "schema": { "type": "boolean", "default": true } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2_Simple_Price_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/simple/price": { "get": { "summary": "Simple Price v1 (deprecated)", "operationId": "getV1SimplePrice", "description": "**Deprecated.** Use [/v2/simple/price](/pro-api-reference/cryptocurrency#simple-price) instead - it accepts `id` / `slug` / `symbol` lookups (no `/map` round-trip), supports `convert` / `convert_id`, and returns the current v3-style response shape. `/v1/simple/price` stays live and unchanged for existing integrations.\n\nReturns current USD spot prices for one or more coins. Optimized for low latency and minimal payload size. Optional flags include market cap, 24h volume, 24h percent change, and last updated timestamp.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/simple/price`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 60 seconds.\n**Plan credit use:** 1 API call credit per request.", "parameters": [ { "name": "ids", "in": "query", "description": "Comma-separated list of CoinMarketCap cryptocurrency IDs. Example: \"1,1027\". Max query size 50.", "required": true, "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+){0,49}$" } }, { "name": "include_market_cap", "in": "query", "description": "Include market cap values in the response.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "include_volume_24h", "in": "query", "description": "Include 24-hour volume in the response.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "include_percent_change_24h", "in": "query", "description": "Include 24-hour price change percentage in the response.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "include_last_updated", "in": "query", "description": "Include last updated timestamp in the response.", "required": false, "schema": { "type": "boolean", "default": false } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Simple_Price_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/categories": { "get": { "summary": "Categories", "operationId": "getV1CryptocurrencyCategories", "x-keyless": true, "description": "Returns information about all coin categories available on CoinMarketCap. Includes a paginated list of cryptocurrency quotes and metadata from each category.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Free\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/cryptocurrency/categories`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 API call credit per request + 1 call credit per 200 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our free airdrops page [coinmarketcap.com/cryptocurrency-category/](https://coinmarketcap.com/cryptocurrency-category/).", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000 } }, { "description": "Filtered categories by one or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively filter categories by a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively filter categories one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\".", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Categories_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/category": { "get": { "summary": "Category", "operationId": "getV1CryptocurrencyCategory", "x-keyless": true, "description": "Returns information about a single coin category available on CoinMarketCap. Includes a paginated list of the cryptocurrency quotes and metadata for the category.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Free\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/cryptocurrency/category`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our Cryptocurrency Category page [coinmarketcap.com/cryptocurrency-category/](https://coinmarketcap.com/cryptocurrency-category/).", "parameters": [ { "description": "The Category ID. This can be found using the Categories API.", "name": "id", "in": "query", "required": true, "schema": { "type": "string" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of coins to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of coins to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/airdrops": { "get": { "summary": "Airdrops", "operationId": "getV1CryptocurrencyAirdrops", "description": "Returns a list of past, present, or future airdrops which have run on CoinMarketCap.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 API call credit per request no matter query size. \n**CMC equivalent pages:** Our free airdrops page [coinmarketcap.com/airdrop/](https://coinmarketcap.com/airdrop/).", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "What status of airdrops.", "name": "status", "in": "query", "schema": { "type": "string", "enum": ["ENDED", "ONGOING", "UPCOMING"], "default": "ONGOING" } }, { "description": "Filtered airdrops by one cryptocurrency CoinMarketCap IDs. Example: 1", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } }, { "description": "Alternatively filter airdrops by a cryptocurrency slug. Example: \"bitcoin\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]*$" } }, { "description": "Alternatively filter airdrops one cryptocurrency symbol. Example: \"BTC\".", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]*$" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Airdrops_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/airdrop": { "get": { "summary": "Airdrop", "operationId": "getV1CryptocurrencyAirdrop", "description": "Returns information about a single airdrop available on CoinMarketCap. Includes the cryptocurrency metadata. \n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 API call credit per request no matter query size. \n**CMC equivalent pages:** Our free airdrops page [coinmarketcap.com/airdrop/](https://coinmarketcap.com/airdrop/).", "parameters": [ { "description": "Airdrop Unique ID. This can be found using the Airdrops API.", "name": "id", "in": "query", "required": true, "schema": { "type": "string" } } ], "tags": ["Cryptocurrency"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Airdrop_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/multiplier": { "get": { "summary": "Cryptocurrency Multiplier", "operationId": "getV1CryptocurrencyMultiplier", "description": "Returns a paginated list of cryptocurrencies that has a **ERC-8056 UI multiplier**.\n\n**Filtering and pagination**\n- Use `crypto_id`, `crypto_slug`, `symbol`, or `token_address` to look up specific cryptocurrencies. These four filters are **mutually exclusive**, pass only one per request. Omit all four to page through every cryptocurrency that currently has a UI multiplier, sorted by ascending CoinMarketCap ID.\n- `total_size` is the total number of results before pagination.\n- `start` and `limit` paginate the list (1-based `start`, default `start=1`, `limit=100`). `has_more` is `true` when `start + limit` has not yet reached `total_size`.\n\n**No credit is needed when querying this endpoint.**\n\n**Cache / Update frequency:** Refreshed whenever multiplier changes are applied.\n**CMC equivalent pages:** Cryptocurrency detail pages that display adjusted supply or price using the UI multiplier.", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: `1,1027`. Mutually exclusive with `crypto_slug`, `symbol`, and `token_address`.", "name": "crypto_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "One or more comma-separated cryptocurrency slugs. Example: `bitcoin,ethereum`. Mutually exclusive with `crypto_id`, `symbol`, and `token_address`.", "x-convert": { "lowercase": true }, "name": "crypto_slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "One or more comma-separated cryptocurrency symbols. Example: `BTC,ETH`. Symbols are uppercased server-side. When multiple assets share a symbol, the lowest CoinMarketCap ID is used. Mutually exclusive with `crypto_id`, `crypto_slug`, and `token_address`.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "One or more comma-separated contract addresses. Mutually exclusive with `crypto_id`, `crypto_slug`, and `symbol`.", "name": "token_address", "in": "query", "schema": { "type": "string" } }, { "description": "Pass `true` to skip invalid `crypto_id`, `crypto_slug`, `symbol`, or `token_address` values and return only resolvable matches. When `false` (default), the request fails with `400` if any lookup value is invalid.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": false } }, { "description": "Optionally offset the start (1-based index) of the paginated list. Non-positive values fall back to the default of `1`.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter for pagination. Non-positive values fall back to the default of `100`.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 2000, "default": 100 } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Multiplier_-_Response_Model" }, "examples": { "byId": { "summary": "Filtered by ID", "value": { "status": { "timestamp": "2026-05-11T07:30:00.123Z", "error_code": 0, "error_message": null, "elapsed": 12, "credit_count": 0, "notice": null }, "data": { "total_size": 2, "has_more": false, "items": [ { "crypto_id": 1, "crypto_slug": "bitcoin", "name": "Bitcoin", "symbol": "BTC", "multiplier": 1, "effective_at": "2026-05-10T10:30:00Z", "token_address": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599", "platform_id": 14 }, { "crypto_id": 1027, "crypto_slug": "ethereum", "name": "Ethereum", "symbol": "ETH", "multiplier": 1, "effective_at": "2026-05-10T13:30:00Z" } ] } } }, "paginated": { "summary": "Unfiltered pagination", "value": { "status": { "timestamp": "2026-05-14T07:55:20.434Z", "error_code": 0, "error_message": null, "elapsed": 20, "credit_count": 0, "notice": null }, "data": { "total_size": 21, "has_more": true, "items": [ { "crypto_id": 1727, "crypto_slug": "bancor", "name": "Bancor", "symbol": "BNT", "multiplier": 5, "effective_at": "2026-05-10T13:30:00Z" } ] } } }, "empty": { "summary": "No matches", "value": { "status": { "timestamp": "2026-05-11T07:32:00.789Z", "error_code": 0, "error_message": null, "elapsed": 3, "credit_count": 0, "notice": null }, "data": { "total_size": 0, "has_more": false, "items": [] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/info": { "get": { "summary": "Metadata v1 (deprecated)", "operationId": "getV1CryptocurrencyInfo", "description": "Returns all static metadata available for one or more cryptocurrencies. This information includes details like logo, description, official website URL, social links, and links to a cryptocurrency's technical documentation.\n\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic\n- Startup\n- Builder\n- Growth\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Static data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 call credit per 100 cryptocurrencies returned (rounded up). \n**CMC equivalent pages:** Cryptocurrency detail page metadata like [coinmarketcap.com/currencies/bitcoin/](https://coinmarketcap.com/currencies/bitcoin/). ", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each data response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Alternatively pass in a contract address. Example: \"0xc40af1e4fecfa05ce6bab79dcd8b373d2e436c4e\"", "name": "address", "in": "query", "schema": { "type": "string" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": false } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `urls,logo,description,tags,platform,date_added,notice,status` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(urls|logo|description|tags|platform|date_added|notice|status)+(?:,(urls|logo|description|tags|platform|date_added|notice|status)+)*$", "default": "urls,logo,description,tags,platform,date_added,notice" } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrencies_Info_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/exchange/map": { "get": { "summary": "Exchange ID Map", "operationId": "getV1ExchangeMap", "x-keyless": true, "description": "Returns a paginated list of all active cryptocurrency exchanges by ID. We recommend using this convenience endpoint to lookup and utilize our unique exchange `id` across all endpoints as typical exchange identifiers may change over time. As a convenience you may pass a comma-separated list of exchanges by `slug` to filter this list to only those you require or the `aux` parameter to slim down the payload.\n\nBy default this endpoint returns exchanges that have at least 1 actively tracked market. You may receive a map of all inactive cryptocurrencies by passing `listing_status=inactive`. You may also receive a map of registered exchanges that are listed but do not yet meet methodology requirements to have tracked markets available via `listing_status=untracked`. Please review **(3) Listing Tiers** in our methodology documentation for additional details on listing states. \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/exchange/map`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Mapping data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 call credit per call. \n**CMC equivalent pages:** No equivalent, this data is only available via API. ", "parameters": [ { "description": "Only active exchanges are returned by default. Pass `inactive` to get a list of exchanges that are no longer active. Pass `untracked` to get a list of exchanges that are registered but do not currently meet methodology requirements to have active markets tracked. You may pass one or more comma-separated values.", "name": "listing_status", "in": "query", "schema": { "type": "string", "pattern": "^(active|inactive|untracked)+(?:,(active|inactive|untracked)+)*$", "default": "active" } }, { "description": "Optionally pass a comma-separated list of exchange slugs (lowercase URL friendly shorthand name with spaces replaced with dashes) to return CoinMarketCap IDs for. If this option is passed, other options will be ignored.", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000 } }, { "description": "What field to sort the list of exchanges by.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["volume_24h", "id"], "default": "id" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `first_historical_data,last_historical_data,is_active,status` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(first_historical_data|last_historical_data|is_active|status)+(?:,(first_historical_data|last_historical_data|is_active|status)+)*$", "default": "first_historical_data,last_historical_data,is_active" } }, { "description": "Optionally include one fiat or cryptocurrency IDs to filter market pairs by. For example `?crypto_id=1` would only return exchanges that have BTC.", "name": "crypto_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } } ], "tags": ["Exchange"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchange_Map_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/exchange/listings/latest": { "get": { "summary": "Listings Latest", "operationId": "getV1ExchangeListingsLatest", "description": "Returns a paginated list of all cryptocurrency exchanges including the latest aggregate market data for each exchange. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - ~~Startup~~\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 1 minute.\n**Plan credit use:** 1 call credit per 250 exchanges returned (rounded up) and 1 call credit per `convert` option beyond the first.\n**CMC equivalent pages:** Our latest exchange listing and ranking pages like [coinmarketcap.com/rankings/exchanges/](https://coinmarketcap.com/rankings/exchanges/).\n\n***NOTE:** Use this endpoint if you need a sorted and paginated list of exchanges. If you want to query for market data on a few specific exchanges use /v1/exchange/quotes/latest which is optimized for that purpose. The response data between these endpoints is otherwise the same.*\n\n*“exchange_score\" will be deprecated on 4 November 2024.*\n\n*After this date, the \"exchange_score\" field return null from these endpoints. We encourage users to review and update their implementations accordingly to avoid any disruptions.*", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "What field to sort the list of exchanges by.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["name", "volume_24h", "volume_24h_adjusted", "exchange_score"], "default": "volume_24h" } }, { "description": "The direction in which to order exchanges against the specified sort.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"] } }, { "description": "The type of exchange markets to include in rankings. This field is deprecated. Please use \"all\" for accurate sorting.", "name": "market_type", "in": "query", "schema": { "type": "string", "enum": ["fees", "no_fees", "all"], "default": "all" } }, { "description": "The category for this exchange.", "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": ["all", "spot", "derivatives", "dex", "lending"], "default": "all" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,traffic_score,rank,exchange_score,effective_liquidity_24h,date_launched,fiats` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|traffic_score|rank|exchange_score|effective_liquidity_24h|date_launched|fiats)+(?:,(num_market_pairs|traffic_score|rank|exchange_score|effective_liquidity_24h|date_launched|fiats)+)*$", "default": "num_market_pairs,traffic_score,rank,exchange_score,effective_liquidity_24h" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Exchange"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchange_Listings_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/exchange/quotes/latest": { "get": { "summary": "Quotes Latest", "operationId": "getV1ExchangeQuotesLatest", "description": "Returns the latest aggregate market data for 1 or more exchanges. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- ~~Basic~~\n- ~~Builder~~\n- ~~Startup~~\n- Growth\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Every 60 seconds.\n**Plan credit use:** 1 call credit per 250 exchanges returned (rounded up) and 1 call credit per `convert` option beyond the first.\n**CMC equivalent pages:** Latest market data summary for specific exchanges like [coinmarketcap.com/rankings/exchanges/](https://coinmarketcap.com/rankings/exchanges/).\n\n***NOTE:** “exchange_score\" will be deprecated on 4 November 2024.*\n\n*After this date, the \"exchange_score\" field return null from these endpoints. We encourage users to review and update their implementations accordingly to avoid any disruptions.*", "parameters": [ { "description": "One or more comma-separated CoinMarketCap exchange IDs. Example: \"1,2\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively, pass a comma-separated list of exchange \"slugs\" (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens). Example: \"binance,gdax\". At least one \"id\" *or* \"slug\" is required.", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,traffic_score,rank,exchange_score,liquidity_score,effective_liquidity_24h` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|traffic_score|rank|exchange_score|liquidity_score|effective_liquidity_24h)+(?:,(num_market_pairs|traffic_score|rank|exchange_score|liquidity_score|effective_liquidity_24h)+)*$", "default": "num_market_pairs,traffic_score,rank,exchange_score,liquidity_score,effective_liquidity_24h" } } ], "tags": ["Exchange"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchange_Quotes_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/exchange/quotes/historical": { "get": { "summary": "Quotes Historical", "operationId": "getV1ExchangeQuotesHistorical", "description": "Returns an interval of historic quotes for any exchange based on time and interval parameters.\n\n**Technical Notes**\n- A historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned. \n- If a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\". \n- If \"time_end\" is not supplied, it defaults to the current time. \n- At each \"interval\" period, the historic quote that is closest in time to the requested time will be returned. \n- If no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped. \n- This endpoint supports requesting multiple exchanges in the same call. Please note the API response will be wrapped in an additional object in this case. \n\n**Interval Options** \nThere are 2 types of time interval formats that may be used for \"interval\". \n\nThe first are calendar year and time constants in UTC time: \n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour. \n**\"daily\"** - Get the first quote available at the beginning of each calendar day. \n**\"weekly\"** - Get the first quote available at the beginning of each calendar week. \n**\"monthly\"** - Get the first quote available at the beginning of each calendar month. \n**\"yearly\"** - Get the first quote available at the beginning of each calendar year. \n\nThe second are relative time intervals. \n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\". \n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"4h\", \"6h\", \"12h\". \n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\". \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (intraday: 1 month, daily: 1 year)\n- Builder (intraday: 1 month, daily: 3 years)\n- Startup (intraday: 1 month, daily: from 2018)\n- Growth (intraday: 3 months, daily: from 2018)\n- Professional (intraday: 12 months, daily: from 2018)\n- Enterprise (intraday: from 2018, daily: from 2018)\n\n**Note:** Intraday = `5m-12h` intervals, Daily = `1d-1y` intervals\n\n**Note:** You may use the /exchange/map endpoint to receive a list of earliest historical dates that may be fetched for each exchange as `first_historical_data`. This timestamp will either be the date CoinMarketCap first started tracking the exchange or 2018-04-26T00:45:00.000Z, the earliest date this type of historical data is available for.\n \n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 call credit per 100 historical data points returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** No equivalent, this data is only available via API outside of our volume sparkline charts in [coinmarketcap.com/rankings/exchanges/](https://coinmarketcap.com/rankings/exchanges/). ", "parameters": [ { "description": "One or more comma-separated exchange CoinMarketCap ids. Example: \"24,270\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively, one or more comma-separated exchange names in URL friendly shorthand \"slug\" format (all lowercase, spaces replaced with hyphens). Example: \"binance,kraken\". At least one \"id\" *or* \"slug\" is required.", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".", "name": "time_start", "in": "query", "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.", "name": "time_end", "in": "query", "schema": { "type": "string" } }, { "description": "The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 10 items. The current query limit is 10000.", "name": "count", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 10000, "default": 10 } }, { "description": "Interval of time to return data points for. See details in endpoint description.", "name": "interval", "in": "query", "schema": { "type": "string", "enum": [ "yearly", "monthly", "weekly", "daily", "hourly", "5m", "10m", "15m", "30m", "45m", "1h", "2h", "3h", "4h", "6h", "12h", "24h", "1d", "2d", "3d", "7d", "14d", "15d", "30d", "60d", "90d", "365d" ], "default": "5m" } }, { "description": "By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Exchange"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/exchange/market-pairs/latest": { "get": { "summary": "Market Pairs Latest", "operationId": "getV1ExchangeMarketpairsLatest", "description": "Returns all active market pairs that CoinMarketCap tracks for a given exchange. The latest price and volume information is returned for each market. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.'\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - ~~Startup~~\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 market pairs returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our exchange level active markets pages like [coinmarketcap.com/exchanges/binance/](https://coinmarketcap.com/exchanges/binance/). ", "parameters": [ { "description": "A CoinMarketCap exchange ID. Example: \"1\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } }, { "description": "Alternatively pass an exchange \"slug\" (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens). Example: \"binance\". One \"id\" *or* \"slug\" is required.", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]*$" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,category,fee_type,market_url,currency_name,currency_slug,price_quote,effective_liquidity,market_score,market_reputation` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|category|fee_type|market_url|currency_name|currency_slug|price_quote|effective_liquidity|market_score|market_reputation)+(?:,(num_market_pairs|category|fee_type|market_url|currency_name|currency_slug|price_quote|effective_liquidity|market_score|market_reputation)+)*$", "default": "num_market_pairs,category,fee_type" } }, { "description": "Optionally include one or more comma-delimited fiat or cryptocurrency IDs to filter market pairs by. For example `?matched_id=2781` would only return BTC markets that matched: \"BTC/USD\" or \"USD/BTC\" for the requested exchange. This parameter cannot be used when `matched_symbol` is used.", "name": "matched_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Optionally include one or more comma-delimited fiat or cryptocurrency symbols to filter market pairs by. For example `?matched_symbol=USD` would only return BTC markets that matched: \"BTC/USD\" or \"USD/BTC\" for the requested exchange. This parameter cannot be used when `matched_id` is used.", "name": "matched_symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.", "name": "category", "in": "query", "schema": { "type": "string", "enum": ["all", "spot", "derivatives", "otc", "futures", "perpetual"], "default": "all" } }, { "description": "The fee type the exchange enforces for this market.", "name": "fee_type", "in": "query", "schema": { "type": "string", "enum": ["all", "percentage", "no-fees", "transactional-mining", "unknown"], "default": "all" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Exchange"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/exchange/assets": { "get": { "summary": "Exchange Assets", "operationId": "getV1ExchangeAssets", "description": "Returns the exchange assets in the form of token holdings. This information includes details like wallet address, cryptocurrency, blockchain platform, balance, and etc.\n\n\n * Only wallets containing at least 100,000 USD in balance are shown\n * Balances from wallets might be delayed\n \n ** Disclaimer:\n All information and data relating to the holdings in the third-party wallet addresses are provided by the third parties to CoinMarketCap, and CoinMarketCap does not confirm or verify the accuracy or timeliness of such information and data.\n The information and data are provided \"as is\" without warranty of any kind. CoinMarketCap shall have no responsibility or liability for these third parties’ information and data or have the duty to review, confirm, verify or otherwise perform any inquiry or investigation as to the completeness, accuracy, sufficiency, integrity, reliability or timeliness of any such information or data provided.\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Free\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n \n **Cache / Update frequency:** Balance data is updated statically based on the source. Price data is updated every 5 minutes. \n **Plan credit use:** 1 credit. \n **CMC equivalent pages:** Exchange detail page like [coinmarketcap.com/exchanges/binance/](https://coinmarketcap.com/exchanges/binance/)", "parameters": [ { "description": "A CoinMarketCap exchange ID. Example: 270", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } } ], "tags": ["Exchange"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchange_Assets_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/exchange/info": { "get": { "summary": "Metadata", "operationId": "getV1ExchangeInfo", "description": "Returns all static metadata for one or more exchanges. This information includes details like launch date, logo, official website URL, social links, and market fee documentation URL.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Static data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 call credit per 250 exchanges returned (rounded up). \n**CMC equivalent pages:** Exchange detail page metadata like [coinmarketcap.com/exchanges/binance/](https://coinmarketcap.com/exchanges/binance/). ", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency exchange ids. Example: \"1,2\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively, one or more comma-separated exchange names in URL friendly shorthand \"slug\" format (all lowercase, spaces replaced with hyphens). Example: \"binance,gdax\". At least one \"id\" *or* \"slug\" is required.", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `urls,logo,description,date_launched,notice,status` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(urls|logo|description|date_launched|notice|status)+(?:,(urls|logo|description|date_launched|notice|status)+)*$", "default": "urls,logo,description,date_launched,notice" } } ], "tags": ["Exchange"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exchanges_Info_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/fiat/map": { "get": { "summary": "Fiat ID Map", "operationId": "getV1FiatMap", "description": "Returns a mapping of all supported fiat currencies to unique CoinMarketCap ids. Per our Best Practices we recommend utilizing CMC ID instead of currency symbols to securely identify assets with our other endpoints and in your own application logic. \n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Mapping data is updated only as needed, every 30 seconds. \n**Plan credit use:** 1 API call credit per request no matter query size. \n**CMC equivalent pages:** No equivalent, this data is only available via API.", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000 } }, { "description": "What field to sort the list by.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["name", "id"], "default": "id" } }, { "description": "Pass `true` to include precious metals.", "name": "include_metals", "in": "query", "schema": { "type": "boolean", "default": false } } ], "tags": ["Tools"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fiat_Map_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/key/info": { "get": { "summary": "Key Info", "operationId": "getV1KeyInfo", "description": "Returns API key details and usage stats. This endpoint can be used to programmatically monitor your key usage compared to the rate limit and daily/monthly credit limits available to your API plan. You may use the Developer Portal's account dashboard as an alternative to this endpoint.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n **Cache / Update frequency:** No cache, this endpoint updates as requests are made with your key. \n **Plan credit use:** No API credit cost. Requests to this endpoint do contribute to your minute based rate limit however. \n **CMC equivalent pages:** Our Developer Portal dashboard for your API Key at [pro.coinmarketcap.com/account](https://pro.coinmarketcap.com/account).", "tags": ["Tools"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account_Info_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/tools/postman": { "get": { "summary": "Postman Conversion v1", "operationId": "getV1ToolsPostman", "description": "Convert APIs into postman format. You can reference the operation from [this article](https://coinmarketcap.com/alexandria/article/register-for-coinmarketcap-api).\n \n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Free\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n **Technical Notes**\n - Set the env variables in the postman: {{baseUrl}}, {{API_KEY}}\n", "tags": ["Tools"], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/tools/price-conversion": { "get": { "summary": "Price Conversion v1 (deprecated)", "operationId": "getV1ToolsPriceconversion", "description": "Convert an amount of one cryptocurrency or fiat currency into one or more different currencies utilizing the latest market rate for each currency. You may optionally pass a historical timestamp as `time` to convert values based on historical rates (as your API plan supports). \n \n \n**Technical Notes**\n- Latest market rate conversions are accurate to 1 minute of specificity. Historical conversions are accurate to 1 minute of specificity outside of non-USD fiat conversions which have 5 minute specificity. \n- You may reference a current list of all supported cryptocurrencies via the [cryptocurrency/map](/pro-api-reference/cryptocurrency#cryptocurrency-id-map) endpoint. This endpoint also returns the supported date ranges for historical conversions via the `first_historical_data` and `last_historical_data` properties. \n- Conversions are supported in 93 different fiat currencies and 4 precious metals [as outlined here](/guides/standards-and-conventions). Historical fiat conversions are supported as far back as 2013-04-28.\n- A `last_updated` timestamp is included for both your source currency and each conversion currency. This is the timestamp of the closest market rate record referenced for each currency during the conversion. \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (Latest market price conversions)\n- Builder (Latest market price conversions + 1 month historical)\n- Startup (Latest market price conversions + 1 month historical)\n- Growth (Latest market price conversions + 3 months historical)\n- Professional (Latest market price conversions + 12 months historical)\n- Enterprise (Latest market price conversions + up to 6 years historical)\n\n**Cache / Update frequency:** Every 60 seconds for the lastest cryptocurrency and fiat currency rates. \n**Plan credit use:** 1 call credit per call and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our cryptocurrency conversion page at [coinmarketcap.com/converter/](https://coinmarketcap.com/converter/). ", "parameters": [ { "description": "An amount of currency to convert. Example: 10.43", "name": "amount", "in": "query", "required": true, "schema": { "type": "number", "minimum": 1e-8, "maximum": 1000000000000 } }, { "description": "The CoinMarketCap currency ID of the base cryptocurrency or fiat to convert from. Example: \"1\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } }, { "description": "Alternatively the currency symbol of the base cryptocurrency or fiat to convert from. Example: \"BTC\". One \"id\" *or* \"symbol\" is required. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each quote response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]*$" } }, { "description": "Optional timestamp (Unix or ISO 8601) to reference historical pricing during conversion. If not passed, the current time will be used. If passed, we'll reference the closest historic values available for this conversion.", "name": "time", "in": "query", "schema": { "type": "string" } }, { "description": "Pass up to 120 comma-separated fiat or cryptocurrency symbols to convert the source amount to.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tools_Price_Conversion_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/tools/price-conversion": { "get": { "summary": "Price Conversion v2", "operationId": "getV2ToolsPriceconversion", "x-keyless": true, "description": "Convert an amount of one cryptocurrency or fiat currency into one or more different currencies utilizing the latest market rate for each currency. You may optionally pass a historical timestamp as `time` to convert values based on historical rates (as your API plan supports). \n \n **Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n**Technical Notes**\n- Latest market rate conversions are accurate to 1 minute of specificity. Historical conversions are accurate to 1 minute of specificity outside of non-USD fiat conversions which have 5 minute specificity. \n- You may reference a current list of all supported cryptocurrencies via the [cryptocurrency/map](/pro-api-reference/cryptocurrency#cryptocurrency-id-map) endpoint. This endpoint also returns the supported date ranges for historical conversions via the `first_historical_data` and `last_historical_data` properties. \n- Conversions are supported in 93 different fiat currencies and 4 precious metals [as outlined here](/guides/standards-and-conventions). Historical fiat conversions are supported as far back as 2013-04-28.\n- A `last_updated` timestamp is included for both your source currency and each conversion currency. This is the timestamp of the closest market rate record referenced for each currency during the conversion. \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (Latest market price conversions)\n- Builder (Latest market price conversions + 1 month historical)\n- Startup (Latest market price conversions + 1 month historical)\n- Growth (Latest market price conversions + 3 months historical)\n- Professional (Latest market price conversions + 12 months historical)\n- Enterprise (Latest market price conversions + up to 6 years historical)\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v2/tools/price-conversion`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 60 seconds for the lastest cryptocurrency and fiat currency rates. \n**Plan credit use:** 1 call credit per call and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our cryptocurrency conversion page at [coinmarketcap.com/converter/](https://coinmarketcap.com/converter/). ", "parameters": [ { "description": "An amount of currency to convert. Example: 10.43", "name": "amount", "in": "query", "required": true, "schema": { "type": "number", "minimum": 1e-8, "maximum": 1000000000000 } }, { "description": "The CoinMarketCap currency ID of the base cryptocurrency or fiat to convert from. Example: \"1\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } }, { "description": "Alternatively the currency symbol of the base cryptocurrency or fiat to convert from. Example: \"BTC\". One \"id\" *or* \"symbol\" is required. Please note that starting in the v2 endpoint, due to the fact that a symbol is not unique, if you request by symbol each quote response will contain an array of objects containing all of the coins that use each requested symbol. The v1 endpoint will still return a single object, the highest ranked coin using that symbol.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]*$" } }, { "description": "Optional timestamp (Unix or ISO 8601) to reference historical pricing during conversion. If not passed, the current time will be used. If passed, we'll reference the closest historic values available for this conversion.", "name": "time", "in": "query", "schema": { "type": "string" } }, { "description": "Pass up to 120 comma-separated fiat or cryptocurrency symbols to convert the source amount to.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Tools"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tools_Price_Conversion_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v3/fear-and-greed/historical": { "get": { "summary": "CMC Crypto Fear and Greed Historical", "operationId": "getV3FearandgreedHistorical", "x-keyless": true, "description": "Returns a paginated list of all CMC Crypto Fear and Greed values at 12am UTC time. \t\t\t\n\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Startup\n - Builder\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/fear-and-greed/historical`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 15 seconds. \n**Plan credit use:** 1 API call credit per request no matter query size. \n**CMC equivalent pages:** Our CMC Crypto Fear and Greed Index card on https://coinmarketcap.com/charts/.", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 } } ], "tags": ["Global Metrics"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fear_and_Greed_Historical_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v3/fear-and-greed/latest": { "get": { "summary": "CMC Crypto Fear and Greed Latest", "operationId": "getV3FearandgreedLatest", "x-keyless": true, "description": "Returns the lastest CMC Crypto Fear and Greed value. \t\t\n\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Startup\n - Builder\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/fear-and-greed/latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 15 minutes. \n**Plan credit use:** 1 call credit per request. \n**CMC equivalent pages:** Our CMC Crypto Fear and Greed Index card on https://coinmarketcap.com/charts/.", "tags": ["Global Metrics"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fear_and_Greed_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/blockchain/statistics/latest": { "get": { "summary": "Statistics Latest", "operationId": "getV1BlockchainStatisticsLatest", "description": "Returns the latest blockchain statistics data for 1 or more blockchains. Bitcoin, Litecoin, and Ethereum are currently supported. Additional blockchains will be made available on a regular basis. \n\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - ~~Startup~~\n - ~~Growth~~\n - ~~Professional~~\n - Enterprise\n\n**Cache / Update frequency:** Every 15 seconds. \n**Plan credit use:** 1 call credit per request. \n**CMC equivalent pages:** Our blockchain explorer pages like [blockchain.coinmarketcap.com/](https://blockchain.coinmarketcap.com/).", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs to return blockchain data for. Pass `1,2,1027` to request all currently supported blockchains.", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Pass `BTC,LTC,ETH` to request all currently supported blockchains.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Pass `bitcoin,litecoin,ethereum` to request all currently supported blockchains.", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } } ], "tags": ["Crypto Others"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blockchain_Statistics_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/community/trending/token": { "get": { "summary": "Community Trending Tokens", "operationId": "getV1CommunityTrendingToken", "description": "Returns the latest trending tokens from the CMC Community.\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** One Minute\n**Plan credit use:** 0 credit", "parameters": [ { "description": "Optionally specify the number of results to return.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5 } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Community_Trending_Token_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["Community"] } }, "/v1/community/trending/topic": { "get": { "summary": "Community Trending Topics", "operationId": "getV1CommunityTrendingTopic", "description": "Returns the latest trending topics from the CMC Community.\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** One Minute\n**Plan credit use:** 0 credit", "parameters": [ { "description": "Optionally specify the number of results to return.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5, "default": 5 } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Community_Trending_Topic_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["Community"] } }, "/v1/content/posts/comments": { "get": { "summary": "Content Post Comments", "operationId": "getV1ContentPostsComments", "description": "Returns comments of the CMC Community post.\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Five Minutes\n**Plan credit use:** 0 credit", "parameters": [ { "description": "Required post ID. Example: 325670123", "name": "post_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^\\d*$" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Content_Post_Comments_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["Content"] } }, "/v1/content/posts/latest": { "get": { "summary": "Content Latest Posts", "operationId": "getV1ContentPostsLatest", "description": "Returns the latest crypto-related posts from the CMC Community.\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Five Minutes\n**Plan credit use:** 0 credit", "parameters": [ { "description": "Optional one cryptocurrency CoinMarketCap ID. Example: 1027", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } }, { "description": "Alternatively pass one cryptocurrency slug. Example: \"ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]*$" } }, { "description": "Alternatively pass one cryptocurrency symbols. Example: \"ETH\"", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]*$" } }, { "description": "Optional. The score is given in the response for finding next batch posts. Example: 1662903634322", "name": "last_score", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Content_Latest_Posts_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["Content"] } }, "/v1/content/posts/top": { "get": { "summary": "Content Top Posts", "operationId": "getV1ContentPostsTop", "description": "Returns the top crypto-related posts from the CMC Community.\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Five Minutes\n**Plan credit use:** 0 credit", "parameters": [ { "description": "Optional one cryptocurrency CoinMarketCap ID. Example: 1027", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d*$" } }, { "description": "Alternatively pass one cryptocurrency slug. Example: \"ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]*$" } }, { "description": "Alternatively pass one cryptocurrency symbols. Example: \"ETH\"", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]*$" } }, { "description": "Optional. The score is given in the response for finding next batch of related posts. Example: 38507.8865", "name": "last_score", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Content_Top_Posts_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["Content"] } }, "/v1/cryptocurrency/listings/latest": { "get": { "summary": "Listings Latest v1 (deprecated)", "operationId": "getV1CryptocurrencyListingsLatest", "description": "Returns a paginated list of all active cryptocurrencies with latest market data. The default \"market_cap\" sort returns cryptocurrency in order of CoinMarketCap's market cap rank (as outlined in [our methodology](https://coinmarketcap.com/methodology/)) but you may configure this call to order by another market ranking field. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n\nYou may sort against any of the following: \n**market_cap**: CoinMarketCap's market cap rank as outlined in [our methodology](https://coinmarketcap.com/methodology/). \n**market_cap_strict**: A strict market cap sort (latest trade price x circulating supply). \n**name**: The cryptocurrency name. \n**symbol**: The cryptocurrency symbol. \n**date_added**: Date cryptocurrency was added to the system. \n**price**: latest average trade price across markets. \n**circulating_supply**: approximate number of coins currently in circulation. \n**total_supply**: approximate total amount of coins in existence right now (minus any coins that have been verifiably burned). \n**max_supply**: our best approximation of the maximum amount of coins that will ever exist in the lifetime of the currency. \n**num_market_pairs**: number of market pairs across all exchanges trading each currency. \n**market_cap_by_total_supply_strict**: market cap by total supply. \n**volume_24h**: rolling 24 hour adjusted trading volume. \n**volume_7d**: rolling 24 hour adjusted trading volume. \n**volume_30d**: rolling 24 hour adjusted trading volume. \n**percent_change_1h**: 1 hour trading price percentage change for each currency. \n**percent_change_24h**: 24 hour trading price percentage change for each currency. \n**percent_change_7d**: 7 day trading price percentage change for each currency. \n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 200 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first.\n**CMC equivalent pages:** Our latest cryptocurrency listing and ranking pages like [coinmarketcap.com/all/views/all/](https://coinmarketcap.com/all/views/all/), [coinmarketcap.com/tokens/](https://coinmarketcap.com/tokens/), [coinmarketcap.com/gainers-losers/](https://coinmarketcap.com/gainers-losers/), [coinmarketcap.com/new/](https://coinmarketcap.com/new/). \n \n***NOTE:** Use this endpoint if you need a sorted and paginated list of all cryptocurrencies. If you want to query for market data on a few specific cryptocurrencies use `/v1/cryptocurrency/quotes/latest` which is optimized for that purpose. The response data between these endpoints is otherwise the same.* ", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify a threshold of minimum USD price to filter results by.", "name": "price_min", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum USD price to filter results by.", "name": "price_max", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of minimum market cap to filter results by.", "name": "market_cap_min", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum market cap to filter results by.", "name": "market_cap_max", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of minimum 24 hour USD volume to filter results by.", "name": "volume_24h_min", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum 24 hour USD volume to filter results by.", "name": "volume_24h_max", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of minimum circulating supply to filter results by.", "name": "circulating_supply_min", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum circulating supply to filter results by.", "name": "circulating_supply_max", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of minimum 24 hour percent change to filter results by.", "name": "percent_change_24h_min", "in": "query", "schema": { "type": "number", "minimum": -100 } }, { "description": "Optionally specify a threshold of maximum 24 hour percent change to filter results by.", "name": "percent_change_24h_max", "in": "query", "schema": { "type": "number", "minimum": -100 } }, { "description": "Optionally specify a threshold of minimum self reported circulating supply to filter results by.", "name": "self_reported_circulating_supply_min", "in": "query", "schema": { "type": ["number", "null"], "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum self reported circulating supply to filter results by.", "name": "self_reported_circulating_supply_max", "in": "query", "schema": { "type": ["number", "null"], "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of minimum self reported market cap to filter results by.", "name": "self_reported_market_cap_min", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum self reported market cap to filter results by.", "name": "self_reported_market_cap_max", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of minimum unlocked market cap to filter results by.", "name": "unlocked_market_cap_min", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum unlocked market cap to filter results by.", "name": "unlocked_market_cap_max", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of minimum unlocked circulating supply to filter results by.", "name": "unlocked_circulating_supply_min", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally specify a threshold of maximum unlocked circulating supply to filter results by.", "name": "unlocked_circulating_supply_max", "in": "query", "schema": { "type": "number", "minimum": 0, "maximum": 100000000000000000 } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "What field to sort the list of cryptocurrencies by.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "name", "symbol", "date_added", "market_cap", "market_cap_strict", "price", "circulating_supply", "total_supply", "max_supply", "num_market_pairs", "volume_24h", "percent_change_1h", "percent_change_24h", "percent_change_7d", "market_cap_by_total_supply_strict", "volume_7d", "volume_30d" ], "default": "market_cap" } }, { "description": "The direction in which to order cryptocurrencies against the specified sort.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"] } }, { "description": "The type of cryptocurrency to include.", "name": "cryptocurrency_type", "in": "query", "schema": { "type": "string", "enum": ["all", "coins", "tokens"], "default": "all" } }, { "description": "The tag of cryptocurrency to include.", "name": "tag", "in": "query", "schema": { "type": "string", "enum": ["all", "defi", "filesharing"], "default": "all" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_market_cap_included_in_calc` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|cmc_rank|date_added|tags|platform|max_supply|circulating_supply|total_supply|market_cap_by_total_supply|volume_24h_reported|volume_7d|volume_7d_reported|volume_30d|volume_30d_reported|is_market_cap_included_in_calc)+(?:,(num_market_pairs|cmc_rank|date_added|tags|platform|max_supply|circulating_supply|total_supply|market_cap_by_total_supply|volume_24h_reported|volume_7d|volume_7d_reported|volume_30d|volume_30d_reported|is_market_cap_included_in_calc)+)*$", "default": "num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply" } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Response_Model_1" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/market-pairs/latest": { "get": { "summary": "Market Pairs Latest v1 (deprecated)", "operationId": "getV1CryptocurrencyMarketpairsLatest", "description": "Lists all active market pairs that CoinMarketCap tracks for a given cryptocurrency or fiat currency. All markets with this currency as the pair base *or* pair quote will be returned. The latest price and volume information is returned for each market. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - ~~Startup~~\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 1 minute. \n**Plan credit use:** 1 call credit per 100 market pairs returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our active cryptocurrency markets pages like [coinmarketcap.com/currencies/bitcoin/#markets](https://coinmarketcap.com/currencies/bitcoin/#markets). ", "parameters": [ { "description": "A cryptocurrency or fiat currency by CoinMarketCap ID to list market pairs for. Example: \"1\"", "name": "id", "in": "query", "schema": { "type": "string" } }, { "description": "Alternatively pass a cryptocurrency by slug. Example: \"bitcoin\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]*$" } }, { "description": "Alternatively pass a cryptocurrency by symbol. Fiat currencies are not supported by this field. Example: \"BTC\". A single cryptocurrency \"id\", \"slug\", *or* \"symbol\" is required.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]*$" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify the sort direction of markets returned.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" } }, { "description": "Optionally specify the sort order of markets returned. By default we return a strict sort on 24 hour reported volume. Pass `cmc_rank` to return a CMC methodology based sort where markets with excluded volumes are returned last.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "volume_24h_strict", "cmc_rank", "cmc_rank_advanced", "effective_liquidity", "market_score", "market_reputation" ], "default": "volume_24h_strict" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,category,fee_type,market_url,currency_name,currency_slug,price_quote,notice,cmc_rank,effective_liquidity,market_score,market_reputation` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|category|fee_type|market_url|currency_name|currency_slug|price_quote|notice|cmc_rank|effective_liquidity|market_score|market_reputation)+(?:,(num_market_pairs|category|fee_type|market_url|currency_name|currency_slug|price_quote|notice|cmc_rank|effective_liquidity|market_score|market_reputation)+)*$", "default": "num_market_pairs,category,fee_type" } }, { "description": "Optionally include one or more fiat or cryptocurrency IDs to filter market pairs by. For example `?id=1&matched_id=2781` would only return BTC markets that matched: \"BTC/USD\" or \"USD/BTC\". This parameter cannot be used when `matched_symbol` is used.", "name": "matched_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Optionally include one or more fiat or cryptocurrency symbols to filter market pairs by. For example `?symbol=BTC&matched_symbol=USD` would only return BTC markets that matched: \"BTC/USD\" or \"USD/BTC\". This parameter cannot be used when `matched_id` is used.", "name": "matched_symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.", "name": "category", "in": "query", "schema": { "type": "string", "enum": ["all", "spot", "derivatives", "otc", "perpetual"], "default": "all" } }, { "description": "The fee type the exchange enforces for this market.", "name": "fee_type", "in": "query", "schema": { "type": "string", "enum": ["all", "percentage", "no-fees", "transactional-mining", "unknown"], "default": "all" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/ohlcv/historical": { "get": { "summary": "OHLCV Historical v1 (deprecated)", "operationId": "getV1CryptocurrencyOhlcvHistorical", "description": "Returns historical OHLCV (Open, High, Low, Close, Volume) data along with market cap for any cryptocurrency using time interval parameters. Currently daily and hourly OHLCV periods are supported. Volume is not currently supported for hourly OHLCV intervals before 2020-09-22.\n\n \n**Technical Notes**\n- Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like \"2018-09-19\" without time for this \"time_period\". \n- One OHLCV quote will be returned for every \"time_period\" between your \"time_start\" (exclusive) and \"time_end\" (inclusive). \n- If a \"time_start\" is not supplied, the \"time_period\" will be calculated in reverse from \"time_end\" using the \"count\" parameter which defaults to 10 results. \n- If \"time_end\" is not supplied, it defaults to the current time. \n- If you don't need every \"time_period\" between your dates you may adjust the frequency that \"time_period\" is sampled using the \"interval\" parameter. For example with \"time_period\" set to \"daily\" you may set \"interval\" to \"2d\" to get the daily OHLCV for every other day. You could set \"interval\" to \"monthly\" to get the first daily OHLCV for each month, or set it to \"yearly\" to get the daily OHLCV value against the same date every year. \n\n**Implementation Tips**\n- If querying for a specific OHLCV date your \"time_start\" should specify a timestamp of 1 interval prior as \"time_start\" is an exclusive time parameter (as opposed to \"time_end\" which is inclusive to the search). This means that when you pass a \"time_start\" results will be returned for the *next* complete \"time_period\". For example, if you are querying for a daily OHLCV datapoint for 2018-11-30 your \"time_start\" should be \"2018-11-29\". \n- If only specifying a \"count\" parameter to return latest OHLCV periods, your \"count\" should be 1 number higher than the number of results you expect to receive. \"Count\" defines the number of \"time_period\" intervals queried, *not* the number of results to return, and this includes the currently active time period which is incomplete when working backwards from current time. For example, if you want the last daily OHLCV value available simply pass \"count=2\" to skip the incomplete active time period.\n- This endpoint supports requesting multiple cryptocurrencies in the same call. Please note the API response will be wrapped in an additional object in this case. \n \n**Interval Options** \n \nThere are 2 types of time interval formats that may be used for \"time_period\" and \"interval\" parameters. For \"time_period\" these return aggregate OHLCV data from the beginning to end of each interval period. Apply these time intervals to \"interval\" to adjust how frequently \"time_period\" is sampled. \n \nThe first are calendar year and time constants in UTC time: \n**\"hourly\"** - Hour intervals in UTC. \n**\"daily\"** - Calendar day intervals for each UTC day. \n**\"weekly\"** - Calendar week intervals for each calendar week. \n**\"monthly\"** - Calendar month intervals for each calendar month. \n**\"yearly\"** - Calendar year intervals for each calendar year. \n \nThe second are relative time intervals. \n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"4h\", \"6h\", \"12h\". \n**\"d\"**: Time periods that repeat every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\". \n \nPlease note that \"time_period\" currently supports the \"daily\" and \"hourly\" options. \"interval\" supports all interval options. \n \n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):** \n- ~~Basic~~\n- ~~Builder~~\n- Startup (1 month)\n- Growth (3 months)\n- Professional (12 months)\n- Enterprise (Up to 6 years)\n\n**Cache / Update frequency:** Latest Daily OHLCV record is available ~5 to ~10 minutes after each midnight UTC. The latest hourly OHLCV record is available 5 minutes after each UTC hour. \n**Plan credit use:** 1 call credit per 100 OHLCV data points returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our historical cryptocurrency data pages like [coinmarketcap.com/currencies/bitcoin/historical-data/](https://coinmarketcap.com/currencies/bitcoin/historical-data/).", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,1027\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Time period to return OHLCV data for. The default is \"daily\". If hourly, the open will be 01:00 and the close will be 01:59. If daily, the open will be 00:00:00 for the day and close will be 23:59:99 for the same day. See the main endpoint description for details.", "name": "time_period", "in": "query", "schema": { "type": "string", "enum": ["daily", "hourly"], "default": "daily" } }, { "description": "Timestamp (Unix or ISO 8601) to start returning OHLCV time periods for. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like \"2018-09-19\" without time.", "name": "time_start", "in": "query", "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning OHLCV time periods for (inclusive). Optional, if not passed we'll default to the current time. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an ISO date format like \"2018-09-19\" without time.", "name": "time_end", "in": "query", "schema": { "type": "string" } }, { "description": "Optionally limit the number of time periods to return results for. The default is 10 items. The current query limit is 10000 items.", "name": "count", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 10000, "default": 10 } }, { "description": "Optionally adjust the interval that \"time_period\" is sampled. For example with interval=monthly&time_period=daily you will see a daily OHLCV record for January, February, March and so on. See main endpoint description for available options.", "name": "interval", "in": "query", "schema": { "type": "string", "enum": [ "hourly", "daily", "weekly", "monthly", "yearly", "1h", "2h", "3h", "4h", "6h", "12h", "1d", "2d", "3d", "7d", "14d", "15d", "30d", "60d", "90d", "365d" ], "default": "daily" } }, { "description": "By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 fiat currencies or cryptocurrencies.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/ohlcv/latest": { "get": { "summary": "OHLCV Latest v1 (deprecated)", "operationId": "getV1CryptocurrencyOhlcvLatest", "description": "Returns the latest OHLCV (Open, High, Low, Close, Volume) market values for one or more cryptocurrencies for the current UTC day. Since the current UTC day is still active these values are updated frequently. You can find the final calculated OHLCV values for the last completed UTC day along with all historic days using /cryptocurrency/ohlcv/historical. \n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n **Cache / Update frequency:** Every 10 minutes. Additional OHLCV intervals and 1 minute updates will be available in the future. \n **Plan credit use:** 1 call credit per 100 OHLCV values returned (rounded up) and 1 call credit per `convert` option beyond the first. \n **CMC equivalent pages:** No equivalent, this data is only available via API.", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"symbol\" is required.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if any invalid cryptocurrencies are requested or a cryptocurrency does not have matching records in the requested timeframe. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/price-performance-stats/latest": { "get": { "summary": "Price Performance Stats v1 (deprecated)", "operationId": "getV1CryptocurrencyPriceperformancestatsLatest", "description": "Returns price performance statistics for one or more cryptocurrencies including launch price ROI and all-time high / all-time low. Stats are returned for an `all_time` period by default. UTC `yesterday` and a number of *rolling time periods* may be requested using the `time_period` parameter. Utilize the `convert` parameter to translate values into multiple fiats or cryptocurrencies using historical rates.\n\n\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 100 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** The statistics module displayed on cryptocurrency pages like [Bitcoin](https://coinmarketcap.com/currencies/bitcoin/). \n \n***NOTE:** You may also use `/cryptocurrency/ohlcv/historical` for traditional OHLCV data at historical daily and hourly intervals. You may also use `/v1/cryptocurrency/ohlcv/latest` for OHLCV data for the current UTC day.* ", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Specify one or more comma-delimited time periods to return stats for. `all_time` is the default. Pass `all_time,yesterday,24h,7d,30d,90d,365d` to return all supported time periods. All rolling periods have a rolling close time of the current request time. For example `24h` would have a close time of now and an open time of 24 hours before now. *Please note: `yesterday` is a UTC period and currently does not currently support `high` and `low` timestamps.*", "name": "time_period", "in": "query", "schema": { "type": "string", "pattern": "^(all_time|yesterday|24h|7d|30d|90d|365d)+(?:,(all_time|yesterday|24h|7d|30d|90d|365d)+)*$", "default": "all_time" } }, { "description": "Optionally calculate quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/quotes/historical": { "get": { "summary": "Quotes Historical v1 (deprecated)", "operationId": "getV1CryptocurrencyQuotesHistorical", "description": "Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.\n\n\n**Technical Notes** \n- A historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned. \n- If a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\". \n- If \"time_end\" is not supplied, it defaults to the current time. \n- At each \"interval\" period, the historic quote that is closest in time to the requested time will be returned. \n- If no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped. \n\n**Implementation Tips**\n- Want to get the last quote of each UTC day? Don't use \"interval=daily\" as that returns the first quote. Instead use \"interval=24h\" to repeat a specific timestamp search every 24 hours and pass ex. \"time_start=2019-01-04T23:59:00.000Z\" to query for the last record of each UTC day.\n- This endpoint supports requesting multiple cryptocurrencies in the same call. Please note the API response will be wrapped in an additional object in this case. \n \n**Interval Options** \nThere are 2 types of time interval formats that may be used for \"interval\".\n\nThe first are calendar year and time constants in UTC time: \n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour. \n**\"daily\"** - Get the first quote available at the beginning of each calendar day. \n**\"weekly\"** - Get the first quote available at the beginning of each calendar week. \n**\"monthly\"** - Get the first quote available at the beginning of each calendar month. \n**\"yearly\"** - Get the first quote available at the beginning of each calendar year. \n\nThe second are relative time intervals. \n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\". \n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"4h\", \"6h\", \"12h\". \n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\". \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (intraday: 1 month, daily: 1 year)\n- Builder (intraday: 1 month, daily: 3 years)\n- Startup (intraday: 1 month, daily: from 2010)\n- Growth (intraday: 3 months, daily: from 2010)\n- Professional (intraday: 12 months, daily: from 2010)\n- Enterprise (intraday: from 2010, daily: from 2010)\n\n**Note:** Intraday = `5m-12h` intervals, Daily = `1d-1y` intervals\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 call credit per 100 historical data points returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our historical cryptocurrency charts like [coinmarketcap.com/currencies/bitcoin/#charts](https://coinmarketcap.com/currencies/bitcoin/#charts). ", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".", "name": "time_start", "in": "query", "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.", "name": "time_end", "in": "query", "schema": { "type": "string" } }, { "description": "The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 10 items. The current query limit is 10000.", "name": "count", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 10000, "default": 10 } }, { "description": "Interval of time to return data points for. See details in endpoint description.", "name": "interval", "in": "query", "schema": { "type": "string", "enum": [ "yearly", "monthly", "weekly", "daily", "hourly", "5m", "10m", "15m", "30m", "45m", "1h", "2h", "3h", "4h", "6h", "12h", "24h", "1d", "2d", "3d", "7d", "14d", "15d", "30d", "60d", "90d", "365d" ], "default": "5m" } }, { "description": "By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "(^\\d+(?:,\\d+)*$|(\\d,)*PLATFORM_ID+(?:,\\d+)*$)" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat,search_interval` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(price|volume|market_cap|circulating_supply|total_supply|quote_timestamp|is_active|is_fiat|search_interval)+(?:,(price|volume|market_cap|circulating_supply|total_supply|quote_timestamp|is_active|is_fiat|search_interval)+)*$", "default": "price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/cryptocurrency/quotes/latest": { "get": { "summary": "Quotes Latest v1 (deprecated)", "operationId": "getV1CryptocurrencyQuotesLatest", "description": "Returns the latest market quote for 1 or more cryptocurrencies. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic\n- Startup\n- Builder\n- Growth\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 100 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Latest market data pages for specific cryptocurrencies like [coinmarketcap.com/currencies/bitcoin/](https://coinmarketcap.com/currencies/bitcoin/). \n \n***NOTE:** Use this endpoint to request the latest quote for specific cryptocurrencies. If you need to request all cryptocurrencies use `/v1/cryptocurrency/listings/latest` which is optimized for that purpose. The response data between these endpoints is otherwise the same.*", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "(^\\d+(?:,\\d+)*$|(\\d,)*PLATFORM_ID+(?:,\\d+)*$)" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_active,is_fiat` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|cmc_rank|date_added|tags|platform|max_supply|circulating_supply|total_supply|market_cap_by_total_supply|volume_24h_reported|volume_7d|volume_7d_reported|volume_30d|volume_30d_reported|is_active|is_fiat)+(?:,(num_market_pairs|cmc_rank|date_added|tags|platform|max_supply|circulating_supply|total_supply|market_cap_by_total_supply|volume_24h_reported|volume_7d|volume_7d_reported|volume_30d|volume_30d_reported|is_active|is_fiat)+)*$", "default": "num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,is_active,is_fiat" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/exchange/derivatives/list": { "get": { "summary": "List derivatives exchanges", "operationId": "getV5ExchangeDerivativesList", "description": "Returns the list of derivatives exchanges CoinMarketCap tracks, sorted by 24-hour derivative volume in descending order by default. Only exchanges with active derivative trading (open interest or derivative volume > 0) are returned.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Free\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 exchanges returned (rounded up) and 1 additional call credit per `convert` option beyond the first. ", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify the field used to sort the list of exchanges. Options: `name`, `volume_24h`, `volume_24h_adjusted`, `exchange_score`.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["name", "volume_24h", "volume_24h_adjusted", "exchange_score"], "default": "volume_24h" } }, { "description": "Optionally specify the sort direction. Options: `asc`, `desc`.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" } }, { "description": "Optionally calculate market quotes in multiple currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own `quote` object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "USD,BTC" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: `convert_id=1,2781` would replace `convert=BTC,USD` in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "2781,1" } } ], "tags": ["Derivatives"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Derivatives_Exchanges_List_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/exchange/derivatives/market-pairs/list/latest": { "get": { "summary": "Derivative market pairs by exchange", "operationId": "getV5ExchangeDerivativesMarketPairsListLatest", "description": "Returns all active derivative market pairs that CoinMarketCap tracks for a given exchange.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Free\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 market pairs returned (rounded up) and 1 call credit per `convert` option beyond the first.", "parameters": [ { "description": "A CoinMarketCap exchange ID. Example: \"270\"", "name": "exchange_id", "in": "query", "schema": { "type": "integer", "example": 270 } }, { "description": "Alternatively pass an exchange \"slug\" (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens). Example: \"binance\". One \"exchange_id\" *or* \"exchange_slug\" is required.", "x-convert": { "lowercase": true }, "name": "exchange_slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+$", "example": "binance" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify the field used to sort market pairs. Options: `volume_24h_strict`, `cmc_rank`, `cmc_rank_advanced`, `effective_liquidity`.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["volume_24h_strict", "cmc_rank", "cmc_rank_advanced", "effective_liquidity"], "default": "volume_24h_strict" } }, { "description": "Optionally specify the sort direction. Options: `asc`, `desc`.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" } }, { "description": "The derivative category of trading this market falls under. Options: `all`, `perpetual`, `futures`.", "name": "category", "in": "query", "schema": { "type": "string", "enum": ["all", "perpetual", "futures"], "default": "all" } }, { "description": "The fee type the exchange enforces for this market.", "name": "fee_type", "in": "query", "schema": { "type": "string", "enum": ["all", "percentage", "no-fees", "transactional-mining", "unknown"], "default": "all" } }, { "description": "Optionally include one or more comma-delimited fiat or cryptocurrency IDs to filter market pairs by. For example `?matched_id=2781` would only return derivative markets matched against USD for the requested exchange. This parameter cannot be used when `matched_symbol` is used.", "name": "matched_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "2781" } }, { "description": "Optionally include one or more comma-delimited fiat or cryptocurrency symbols to filter market pairs by. For example `?matched_symbol=USD` would only return derivative markets matched against USD for the requested exchange. This parameter cannot be used when `matched_id` is used.", "name": "matched_symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "USD" } }, { "description": "Optionally calculate market quotes in multiple currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own `quote` object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "default": "USD" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: `convert_id=1,2781` would replace `convert=BTC,USD` in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Derivatives"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Derivatives_Market_Pairs_List_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/cryptocurrency/derivatives/market-pairs/list/latest": { "get": { "summary": "Derivative market pairs by cryptocurrency", "operationId": "getV5CryptocurrencyDerivativesMarketPairsListLatest", "description": "Returns all active derivative market pairs that CoinMarketCap tracks for a given cryptocurrency, across exchanges.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Free\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 market pairs returned (rounded up) and 1 call credit per `convert` option beyond the first.", "parameters": [ { "description": "A CoinMarketCap cryptocurrency ID. Example: \"1\"", "name": "crypto_id", "in": "query", "schema": { "type": "integer", "example": 1 } }, { "description": "Alternatively pass a cryptocurrency \"slug\" (URL friendly all lowercase shorthand version of name with spaces replaced with hyphens). Example: \"bitcoin\".", "x-convert": { "lowercase": true }, "name": "crypto_slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+$", "example": "bitcoin" } }, { "description": "Alternatively pass a cryptocurrency symbol. Example: \"BTC\". One \"crypto_id\", \"crypto_slug\", *or* \"crypto_symbol\" is required.", "name": "crypto_symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+$", "example": "BTC" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify the sort direction. Options: `asc`, `desc`.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" } }, { "description": "Optionally specify the field used to sort market pairs. Options: `volume_24h_strict`, `cmc_rank`, `cmc_rank_advanced`, `effective_liquidity`.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": ["volume_24h_strict", "cmc_rank", "cmc_rank_advanced", "effective_liquidity"], "default": "volume_24h_strict" } }, { "description": "The derivative category of trading this market falls under. Options: `all`, `perpetual`, `futures`.", "name": "category", "in": "query", "schema": { "type": "string", "enum": ["all", "perpetual", "futures"], "default": "all" } }, { "description": "The fee type the exchange enforces for this market.", "name": "fee_type", "in": "query", "schema": { "type": "string", "enum": ["all", "percentage", "no-fees", "transactional-mining", "unknown"], "default": "all" } }, { "description": "Optionally include one or more comma-delimited fiat or cryptocurrency IDs to filter market pairs by. For example `?matched_id=2781` would only return derivative markets matched against USD for the requested exchange. This parameter cannot be used when `matched_symbol` is used.", "name": "matched_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "2781" } }, { "description": "Optionally include one or more comma-delimited fiat or cryptocurrency symbols to filter market pairs by. For example `?matched_symbol=USD` would only return derivative markets matched against USD for the requested exchange. This parameter cannot be used when `matched_id` is used.", "name": "matched_symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "USD" } }, { "description": "Optionally filter by exchange center type. Options: `all`, `cex`, `dex`.", "name": "center_type", "in": "query", "schema": { "type": "string", "enum": ["all", "cex", "dex"], "default": "all" } }, { "description": "Optionally calculate market quotes in multiple currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own `quote` object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "default": "USD" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: `convert_id=1,2781` would replace `convert=BTC,USD` in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Derivatives"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Derivatives_Crypto_Market_Pairs_List_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/derivatives/liquidations/quotes/latest": { "get": { "summary": "Latest Total Liquidations", "operationId": "getV5DerivativesLiquidationsQuotesLatest", "description": "Returns aggregate perpetual and futures liquidation values across every exchange that CoinMarketCap tracks, summed over rolling 1-hour, 4-hour, and 24-hour windows. These are the global headline figures shown on the [CoinMarketCap liquidations chart](https://coinmarketcap.com/charts/liquidations/).\n\nEach window is reported three ways, and every value is denominated in the convert currency:\n\n- `long_liquidations_*` is the total value of long positions that were force-closed, meaning traders who were betting on a price increase had their positions liquidated through forced market sells.\n- `short_liquidations_*` is the total value of short positions that were force-closed, meaning traders who were betting on a price decrease had their positions liquidated through forced market buys.\n- `total_liquidations_*` is the combined value of the long and short liquidations in that same window.\n\nAll three windows are rolling and end at the moment your request is made, rather than aligning to fixed calendar boundaries. This endpoint returns the global totals only. If you need the same figures broken down per exchange or per cryptocurrency, use [/v5/derivatives/liquidations/exchange/list/latest](/pro-api-reference/derivatives#latest-liquidations-by-exchange) or [/v5/derivatives/liquidations/cryptocurrency/list/latest](/pro-api-reference/derivatives#latest-liquidations-by-cryptocurrency) instead.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per request, plus 1 credit per `convert` / `convert_id` option beyond the first. \n**CMC equivalent page:** [coinmarketcap.com/charts/liquidations/](https://coinmarketcap.com/charts/liquidations/)", "parameters": [ { "name": "convert", "in": "query", "description": "Optionally calculate values in up to 120 fiat or cryptocurrency conversions at once by passing a comma-separated list of symbols. Example: `EUR,BTC`. Each conversion beyond the first costs 1 additional call credit and is returned as its own entry in `quotes[]`. Cannot be used with `convert_id`. Defaults to USD when both are omitted.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+(?:,[0-9A-Za-z$@\\-]+)*$", "default": "USD", "example": "USD" } }, { "name": "convert_id", "in": "query", "description": "Same as `convert`, but by CoinMarketCap currency ID instead of symbol. Example: `convert_id=2781`. Cannot be used with `convert`. Defaults to `2781` (USD) when both are omitted.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "default": "2781", "example": "2781" } } ], "tags": ["Derivatives"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Liquidations_Total_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/derivatives/liquidations/exchange/list/latest": { "get": { "summary": "Latest Liquidations by Exchange", "operationId": "getV5DerivativesLiquidationsExchangeListLatest", "description": "Returns a paginated, sorted list of the derivatives exchanges that CoinMarketCap tracks, each with its perpetual and futures liquidation values over rolling 1-hour, 4-hour, and 24-hour windows. This is the per-exchange leaderboard shown on the [CoinMarketCap liquidations chart](https://coinmarketcap.com/charts/liquidations/). When you call it without any filters, it returns every tracked exchange sorted by `total_liquidations_24h` in descending order.\n\nOnly exchanges that have an integrated liquidation feed are included in the results, and an exchange that is otherwise valid but has recorded no liquidations across any of the tracked windows is left out of the list entirely. Because of this, a request whose filter matches only such exchanges still succeeds: it returns an empty list with `total_size` set to `0` rather than failing with an error.\n\nThis endpoint covers exchanges only. To see the same liquidation values aggregated per cryptocurrency, use [/v5/derivatives/liquidations/cryptocurrency/list/latest](/pro-api-reference/derivatives#latest-liquidations-by-cryptocurrency) instead.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 exchanges returned (rounded up), plus 1 credit per `convert` / `convert_id` option beyond the first. \n**CMC equivalent page:** [coinmarketcap.com/charts/liquidations/](https://coinmarketcap.com/charts/liquidations/)", "parameters": [ { "name": "exchange_id", "in": "query", "description": "Optionally filter to one or more comma-separated CoinMarketCap exchange IDs. Example: `270,294`. Cannot be used with `exchange_slug`.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "270,294" } }, { "name": "exchange_slug", "in": "query", "description": "Alternatively filter by comma-separated exchange slugs. Example: `binance,bybit`. Cannot be used with `exchange_id`.", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "binance,bybit" } }, { "name": "skip_invalid", "in": "query", "description": "Pass `true` to relax request validation: nonexistent identifiers in a filter list are skipped and valid ones are still returned. When `false`, any nonexistent value fails the request with `4001`.", "schema": { "type": "boolean", "default": false } }, { "name": "sort", "in": "query", "description": "Field to sort the list by (values compared in USD terms).", "schema": { "type": "string", "enum": ["total_liquidations_1h", "total_liquidations_4h", "total_liquidations_24h"], "default": "total_liquidations_24h" } }, { "name": "sort_dir", "in": "query", "description": "Direction to order against the `sort` field.", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" } }, { "name": "start", "in": "query", "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Optionally specify the number of results to return. Use with `start` to page through the list.", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } }, { "name": "convert", "in": "query", "description": "Optionally calculate values in up to 120 fiat or cryptocurrency conversions at once by passing a comma-separated list of symbols. Example: `EUR,BTC`. Each conversion beyond the first costs 1 additional call credit and is returned as its own entry in `quotes[]`. Cannot be used with `convert_id`. Defaults to USD when both are omitted.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+(?:,[0-9A-Za-z$@\\-]+)*$", "default": "USD", "example": "USD" } }, { "name": "convert_id", "in": "query", "description": "Same as `convert`, but by CoinMarketCap currency ID instead of symbol. Example: `convert_id=2781`. Cannot be used with `convert`. Defaults to `2781` (USD) when both are omitted.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "default": "2781", "example": "2781" } } ], "tags": ["Derivatives"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Liquidations_By_Exchange_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/derivatives/liquidations/cryptocurrency/list/latest": { "get": { "summary": "Latest Liquidations by Cryptocurrency", "operationId": "getV5DerivativesLiquidationsCryptocurrencyListLatest", "description": "Returns a paginated, sorted list of cryptocurrencies, each with its perpetual and futures liquidation values over rolling 1-hour, 4-hour, and 24-hour windows, aggregated across every exchange that trades its derivatives. This is the per-coin leaderboard shown on the [CoinMarketCap liquidations chart](https://coinmarketcap.com/charts/liquidations/). When you call it without any filters, it returns every tracked cryptocurrency sorted by `total_liquidations_24h` in descending order.\n\nA cryptocurrency that has no tracked derivative markets, or that has recorded no liquidations across any of the tracked windows, is left out of the list entirely. As a result, a request whose filter matches only such cryptocurrencies still succeeds: it returns an empty list with `total_size` set to `0` rather than failing with an error.\n\nWhen you filter by `symbol` and that symbol is shared by more than one active cryptocurrency, every matching coin is returned. To target a single coin unambiguously, filter by `crypto_id` instead.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 cryptocurrencies returned (rounded up), plus 1 credit per `convert` / `convert_id` option beyond the first. \n**CMC equivalent page:** [coinmarketcap.com/charts/liquidations/](https://coinmarketcap.com/charts/liquidations/)", "parameters": [ { "name": "crypto_id", "in": "query", "description": "Optionally filter to one or more comma-separated CoinMarketCap cryptocurrency IDs. Example: `1,1027`. Cannot be combined with `crypto_slug` or `symbol`.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "1,1027" } }, { "name": "crypto_slug", "in": "query", "description": "Alternatively filter by comma-separated cryptocurrency slugs. Example: `bitcoin,ethereum`. Cannot be combined with `crypto_id` or `symbol`.", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "bitcoin,ethereum" } }, { "name": "symbol", "in": "query", "description": "Alternatively filter by comma-separated cryptocurrency symbols. Example: `BTC,ETH`. Cannot be combined with `crypto_id` or `crypto_slug`.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "BTC,ETH" } }, { "name": "skip_invalid", "in": "query", "description": "Pass `true` to relax request validation: nonexistent identifiers in a filter list are skipped and valid ones are still returned. When `false`, any nonexistent value fails the request with `4001`.", "schema": { "type": "boolean", "default": false } }, { "name": "sort", "in": "query", "description": "Field to sort the list by (values compared in USD terms).", "schema": { "type": "string", "enum": ["total_liquidations_1h", "total_liquidations_4h", "total_liquidations_24h"], "default": "total_liquidations_24h" } }, { "name": "sort_dir", "in": "query", "description": "Direction to order against the `sort` field.", "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" } }, { "name": "start", "in": "query", "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Optionally specify the number of results to return. Use with `start` to page through the list.", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } }, { "name": "convert", "in": "query", "description": "Optionally calculate values in up to 120 fiat or cryptocurrency conversions at once by passing a comma-separated list of symbols. Example: `EUR,BTC`. Each conversion beyond the first costs 1 additional call credit and is returned as its own entry in `quotes[]`. Cannot be used with `convert_id`. Defaults to USD when both are omitted.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+(?:,[0-9A-Za-z$@\\-]+)*$", "default": "USD", "example": "USD" } }, { "name": "convert_id", "in": "query", "description": "Same as `convert`, but by CoinMarketCap currency ID instead of symbol. Example: `convert_id=2781`. Cannot be used with `convert`. Defaults to `2781` (USD) when both are omitted.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "default": "2781", "example": "2781" } } ], "tags": ["Derivatives"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Liquidations_By_Cryptocurrency_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/cmc-ai/coins/map": { "get": { "summary": "CMC AI Map", "operationId": "getV5CmcAiCoinsMap", "description": "Returns the cryptocurrencies for which CMC AI currently writes Coin Detail Page content. Call this before [/v5/cmc-ai/coins/latest](/pro-api-reference/cmc-ai#coin-insights-latest) when you need to know which coins are covered, and which of those currently have an empty `insights[]`. No answer bodies are returned here.\n\nCurrent coverage is the top 100 cryptocurrencies by market cap. The set rotates as the ranking changes. All filters are optional. A filter that matches a coin we do not cover is not an error. That coin is simply absent from `data.coins[]`, and `total_size` reflects the matched count. A param-less call returns the full supported set.\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- ~~Basic~~\n- ~~Builder~~\n- ~~Startup~~\n- ~~Growth~~\n- ~~Professional~~\n- Enterprise\n\n**Cache / Update frequency:** Responses may be up to 1 minute old. \n**Plan credit use:** 1 call credit per request. Repeat calls that return the same content are not charged. \n**CMC equivalent page:** No equivalent, API only.", "parameters": [ { "name": "crypto_id", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: `1,1027`. Mutually exclusive with `slug` and `symbol`.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "1,1027" } }, { "name": "slug", "in": "query", "description": "Alternatively pass comma-separated cryptocurrency slugs. Example: `bitcoin,ethereum`. Mutually exclusive with `crypto_id` and `symbol`.", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "bitcoin,ethereum" } }, { "name": "symbol", "in": "query", "description": "Alternatively pass comma-separated cryptocurrency symbols. Example: `BTC,ETH`. Mutually exclusive with `crypto_id` and `slug`.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "BTC,ETH" } }, { "name": "sort", "in": "query", "description": "Field used to sort the list. One of `cmc_rank`, `crypto_id`, `name`. Default `cmc_rank`.", "schema": { "type": "string", "enum": ["cmc_rank", "crypto_id", "name"], "default": "cmc_rank" } }, { "name": "start", "in": "query", "description": "1-based offset of the paginated list to return.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of results to return. Use with `start` to page through the list. Default 100, max 250.", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } } ], "tags": ["CMC AI"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CMC_AI_Coins_Map_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/cmc-ai/latest": { "get": { "summary": "Market Feed Latest", "operationId": "getV5CmcAiLatest", "description": "Returns the CMC AI questions, answers, and top news from the CoinMarketCap homepage. Use it when you want a market briefing as structured data in a dashboard, terminal, or research product.\n\nOn the homepage these insights appear as the blue question pills above the cryptocurrency list. Some questions are a fixed template. Others are written for current market conditions and then go away.\n\n- `fixed_question` is a stable template that stays in the rotation. Examples include \"What are the trending narratives?\", \"Are altcoins outperforming Bitcoin?\", and \"What is the market sentiment?\". The question text does not change. The answer is rewritten as the market moves.\n- `trending_question` is a market-dependent question with no fixed template. The question itself appears and disappears with current conditions, for example a one-off prompt about a sudden sector rotation or a catalyst dominating discussion that week.\n- `top_news` is a headline plus recap of a current story, for example \"BTC stuck near $63K as US spot ETFs see $390M outflows\". Headlines change as the news cycle changes.\n\nThis endpoint is market-wide. Coin-specific questions appear as blue pills below the charts on a Coin Detail Page. Use [/v5/cmc-ai/coins/latest](/pro-api-reference/cmc-ai#coin-insights-latest) and [/v5/cmc-ai/coins/map](/pro-api-reference/cmc-ai#cmc-ai-map) for those.\n\nRefresh cadence:\n\n- `fixed_question`: about every 30 minutes.\n- `trending_question`: about every 30 minutes.\n- `top_news`: about every 30 minutes.\n\nContent is fetched from the database. This endpoint does not generate answers on request. Answers are English only.\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- ~~Basic~~\n- ~~Builder~~\n- ~~Startup~~\n- ~~Growth~~\n- ~~Professional~~\n- Enterprise\n\n**Cache / Update frequency:** Responses may be up to 1 minute old. See the cadence list above for how often content is regenerated. \n**Plan credit use:** 1 call credit per request. Repeat calls that return the same content are not charged. \n**CMC equivalent page:** The blue question pills above the list on [coinmarketcap.com](https://coinmarketcap.com/).", "parameters": [ { "name": "type", "in": "query", "description": "Optionally filter by insight type. Comma-separated. Allowed: `fixed_question`, `trending_question`, `top_news`. Example: `top_news` or `fixed_question,trending_question`.", "schema": { "type": "string", "example": "fixed_question,top_news" } }, { "name": "sources_limit", "in": "query", "description": "Max source URLs to return per insight. Default 10, max 100. Pass `0` to return an empty `sources[]` while still populating `sources_count`.", "schema": { "type": "integer", "minimum": 0, "maximum": 100, "default": 10 } }, { "name": "start", "in": "query", "description": "1-based offset of the paginated list to return.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of results to return. Use with `start` to page through the list. Default 100, max 250.", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } } ], "tags": ["CMC AI"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CMC_AI_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/cmc-ai/coins/latest": { "get": { "summary": "Coin Insights Latest", "operationId": "getV5CmcAiCoinsLatest", "description": "Returns the CMC AI questions and answers for a cryptocurrency. Use it to attach explainers to any asset you already display, including why the price moved today, what people are saying, what is on the roadmap, and the latest news. Exactly one of `crypto_id`, `slug`, or `symbol` is required; they are mutually exclusive.\n\nOn a Coin Detail Page these insights appear as the blue question pills below the price chart, for example on [coinmarketcap.com/currencies/bitcoin/](https://coinmarketcap.com/currencies/bitcoin/). Some questions are a fixed template for that coin. Others are written for current market conditions and then go away.\n\n- `fixed_question` is a stable template. Examples include \"What is Bitcoin?\", \"What could affect BTC's future price?\", \"What is next on BTC's roadmap?\", and \"What is the latest update in BTC's codebase?\". Two templates depend on the day's move: \"Why is BTC's price up today?\" (`price_up`) or \"Why is BTC's price down today?\" (`price_down`). Only one of those is shown. A coin never returns both.\n- `trending_question` is a market-dependent question about that coin with no fixed template, for example a one-off prompt about a protocol incident or a catalyst unique to that asset.\n- `top_news` is a headline tied to the requested coin. These change as the news cycle changes.\n\nWhen a requested cryptocurrency is in the coverage set but has no content yet, it is still returned with an empty `insights[]` array rather than an error. Coins skipped by `skip_invalid`, and coins returned with an empty `insights[]`, are not charged. Pagination is over cryptocurrencies, not over individual insights. Coverage is the current top 100 by market cap and is not guaranteed per question. Use [/v5/cmc-ai/coins/map](/pro-api-reference/cmc-ai#cmc-ai-map) first if you need to know which coins currently have coverage. Market-wide homepage questions live on [/v5/cmc-ai/latest](/pro-api-reference/cmc-ai#market-feed-latest).\n\nRefresh cadence by question:\n\n- `price_up` and `price_down`: about every 1 hour.\n- `future_price`, `sentiment`, and `latest_news`: about every 8 hours.\n- `overview`, `roadmap`, and `codebase`: about every 24 hours.\n- `trending_question`: about every 24 hours.\n\nContent is fetched from the database. This endpoint does not generate answers on request. Answers are English only.\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- ~~Basic~~\n- ~~Builder~~\n- ~~Startup~~\n- ~~Growth~~\n- ~~Professional~~\n- Enterprise\n\n**Cache / Update frequency:** Responses may be up to 1 minute old. See the cadence list above for how often each question is regenerated. \n**Plan credit use:** 1 call credit per cryptocurrency returned. Skipped coins and empty-insight coins are free. Repeat calls that return the same content for a coin are not charged. \n**CMC equivalent page:** The blue question pills below the chart on Coin Detail Pages, e.g. [coinmarketcap.com/currencies/bitcoin/](https://coinmarketcap.com/currencies/bitcoin/).", "parameters": [ { "name": "crypto_id", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: `1,1027`. Mutually exclusive with `slug` and `symbol`.", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "1,1027" } }, { "name": "slug", "in": "query", "description": "Alternatively pass comma-separated cryptocurrency slugs. Example: `bitcoin,ethereum`. Mutually exclusive with `crypto_id` and `symbol`.", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "bitcoin,ethereum" } }, { "name": "symbol", "in": "query", "description": "Alternatively pass comma-separated cryptocurrency symbols. Example: `BTC,ETH`. Mutually exclusive with `crypto_id` and `slug`.", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "BTC,ETH" } }, { "name": "type", "in": "query", "description": "Optionally filter by insight type. Comma-separated. Allowed: `fixed_question`, `trending_question`, `top_news`. Example: `top_news` or `fixed_question,trending_question`.", "schema": { "type": "string", "example": "fixed_question,top_news" } }, { "name": "question_key", "in": "query", "description": "Optionally filter fixed questions by semantic key. Comma-separated. Allowed: `price_up`, `price_down`, `future_price`, `sentiment`, `latest_news`, `overview`, `roadmap`, `codebase`. Ignored for non-fixed types.", "schema": { "type": "string", "example": "price_up,overview" } }, { "name": "sources_limit", "in": "query", "description": "Max source URLs to return per insight. Default 10, max 100. Pass `0` to return an empty `sources[]` while still populating `sources_count`.", "schema": { "type": "integer", "minimum": 0, "maximum": 100, "default": 10 } }, { "name": "skip_invalid", "in": "query", "description": "When requesting multiple cryptocurrencies, pass `true` to skip unresolvable identifiers and still return the valid ones. When `false` (default), any unresolvable identifier fails the whole request with `4001`.", "schema": { "type": "boolean", "default": false } }, { "name": "start", "in": "query", "description": "1-based offset of the paginated list to return.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Number of results to return. Use with `start` to page through the list. Default 100, max 250.", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } } ], "tags": ["CMC AI"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CMC_AI_Coins_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/global-metrics/quotes/historical": { "get": { "summary": "Quotes Historical", "operationId": "getV1GlobalmetricsQuotesHistorical", "description": "Returns an interval of historical global cryptocurrency market metrics based on time and interval parameters.\n\n**Technical Notes**\n- A historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned.\n- If a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\".\n- If \"time_end\" is not supplied, it defaults to the current time.\n- At each \"interval\" period, the historic quote that is closest in time to the requested time will be returned.\n- If no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped.\n\n**Interval Options** \nThere are 2 types of time interval formats that may be used for \"interval\". \n\nThe first are calendar year and time constants in UTC time: \n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour. \n**\"daily\"** - Get the first quote available at the beginning of each calendar day. \n**\"weekly\"** - Get the first quote available at the beginning of each calendar week. \n**\"monthly\"** - Get the first quote available at the beginning of each calendar month. \n**\"yearly\"** - Get the first quote available at the beginning of each calendar year. \n \nThe second are relative time intervals. \n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\". \n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"4h\", \"6h\", \"12h\". \n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\". \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (intraday: 1 month, daily: 1 year)\n- Builder (intraday: 1 month, daily: 3 years)\n- Startup (intraday: 1 month, daily: from 2013)\n- Growth (intraday: 3 months, daily: from 2013)\n- Professional (intraday: 12 months, daily: from 2013)\n- Enterprise (intraday: from 2013, daily: from 2013)\n\n**Note:** Intraday = `5m-12h` intervals, Daily = `1d-1y` intervals\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 call credit per 100 historical data points returned (rounded up). \n**CMC equivalent pages:** Our Total Market Capitalization global chart [coinmarketcap.com/charts/](https://coinmarketcap.com/charts/). ", "parameters": [ { "description": "Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".", "name": "time_start", "in": "query", "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.", "name": "time_end", "in": "query", "schema": { "type": "string" } }, { "description": "The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 10 items. The current query limit is 10000.", "name": "count", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 10000, "default": 10 } }, { "description": "Interval of time to return data points for. See details in endpoint description.", "name": "interval", "in": "query", "schema": { "type": "string", "enum": [ "yearly", "monthly", "weekly", "daily", "hourly", "5m", "10m", "15m", "30m", "45m", "1h", "2h", "3h", "4h", "6h", "12h", "24h", "1d", "2d", "3d", "7d", "14d", "15d", "30d", "60d", "90d", "365d" ], "default": "1d" } }, { "description": "By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `btc_dominance,eth_dominance,active_cryptocurrencies,active_exchanges,active_market_pairs,total_volume_24h,total_volume_24h_reported,altcoin_market_cap,altcoin_volume_24h,altcoin_volume_24h_reported,search_interval` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(btc_dominance|eth_dominance|active_cryptocurrencies|active_exchanges|active_market_pairs|total_volume_24h|total_volume_24h_reported|altcoin_market_cap|altcoin_volume_24h|altcoin_volume_24h_reported|search_interval)+(?:,(btc_dominance|eth_dominance|active_cryptocurrencies|active_exchanges|active_market_pairs|total_volume_24h|total_volume_24h_reported|altcoin_market_cap|altcoin_volume_24h|altcoin_volume_24h_reported|search_interval)+)*$", "default": "btc_dominance,eth_dominance,active_cryptocurrencies,active_exchanges,active_market_pairs,total_volume_24h,total_volume_24h_reported,altcoin_market_cap,altcoin_volume_24h,altcoin_volume_24h_reported" } } ], "tags": ["Global Metrics"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Historic_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/global-metrics/quotes/latest": { "get": { "summary": "Quotes Latest", "operationId": "getV1GlobalmetricsQuotesLatest", "x-keyless": true, "description": "Returns the latest global cryptocurrency market metrics. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic\n- Builder\n- Startup\n- Growth\n- Professional\n- Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/global-metrics/quotes/latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 5 minute. \n**Plan credit use:** 1 call credit per call and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** The latest aggregate global market stats ticker across all CMC pages like [coinmarketcap.com](https://coinmarketcap.com/). ", "parameters": [ { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } } ], "tags": ["Global Metrics"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/cryptocurrency/quotes/historical": { "get": { "summary": "Quotes Historical v2", "operationId": "getV2CryptocurrencyQuotesHistorical", "description": "Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.\n\n**Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n**Technical Notes** \n- A historic quote for every \"interval\" period between your \"time_start\" and \"time_end\" will be returned. \n- If a \"time_start\" is not supplied, the \"interval\" will be applied in reverse from \"time_end\". \n- If \"time_end\" is not supplied, it defaults to the current time. \n- At each \"interval\" period, the historic quote that is closest in time to the requested time will be returned. \n- If no historic quotes are available in a given \"interval\" period up until the next interval period, it will be skipped. \n\n**Implementation Tips**\n- Want to get the last quote of each UTC day? Don't use \"interval=daily\" as that returns the first quote. Instead use \"interval=24h\" to repeat a specific timestamp search every 24 hours and pass ex. \"time_start=2019-01-04T23:59:00.000Z\" to query for the last record of each UTC day.\n- This endpoint supports requesting multiple cryptocurrencies in the same call. Please note the API response will be wrapped in an additional object in this case. \n \n**Interval Options** \nThere are 2 types of time interval formats that may be used for \"interval\".\n\nThe first are calendar year and time constants in UTC time: \n**\"hourly\"** - Get the first quote available at the beginning of each calendar hour. \n**\"daily\"** - Get the first quote available at the beginning of each calendar day. \n**\"weekly\"** - Get the first quote available at the beginning of each calendar week. \n**\"monthly\"** - Get the first quote available at the beginning of each calendar month. \n**\"yearly\"** - Get the first quote available at the beginning of each calendar year. \n\nThe second are relative time intervals. \n**\"m\"**: Get the first quote available every \"m\" minutes (60 second intervals). Supported minutes are: \"5m\", \"10m\", \"15m\", \"30m\", \"45m\". \n**\"h\"**: Get the first quote available every \"h\" hours (3600 second intervals). Supported hour intervals are: \"1h\", \"2h\", \"3h\", \"4h\", \"6h\", \"12h\". \n**\"d\"**: Get the first quote available every \"d\" days (86400 second intervals). Supported day intervals are: \"1d\", \"2d\", \"3d\", \"7d\", \"14d\", \"15d\", \"30d\", \"60d\", \"90d\", \"365d\". \n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic (intraday: 1 month, daily: 1 year)\n- Builder (intraday: 1 month, daily: 3 years)\n- Startup (intraday: 1 month, daily: from 2010)\n- Growth (intraday: 3 months, daily: from 2010)\n- Professional (intraday: 12 months, daily: from 2010)\n- Enterprise (intraday: from 2010, daily: from 2010)\n\n**Note:** Intraday = `5m-12h` intervals, Daily = `1d-1y` intervals\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 call credit per 100 historical data points returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Our historical cryptocurrency charts like [coinmarketcap.com/currencies/bitcoin/#charts](https://coinmarketcap.com/currencies/bitcoin/#charts). ", "parameters": [ { "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs. Example: \"1,2\"", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Timestamp (Unix or ISO 8601) to start returning quotes for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".", "name": "time_start", "in": "query", "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning quotes for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.", "name": "time_end", "in": "query", "schema": { "type": "string" } }, { "description": "The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 10 items. The current query limit is 10000.", "name": "count", "in": "query", "schema": { "type": "number", "minimum": 1, "maximum": 10000, "default": 10 } }, { "description": "Interval of time to return data points for. See details in endpoint description.", "name": "interval", "in": "query", "schema": { "type": "string", "enum": [ "yearly", "monthly", "weekly", "daily", "hourly", "5m", "10m", "15m", "30m", "45m", "1h", "2h", "3h", "4h", "6h", "12h", "24h", "1d", "2d", "3d", "7d", "14d", "15d", "30d", "60d", "90d", "365d" ], "default": "5m" } }, { "description": "By default market quotes are returned in USD. Optionally calculate market quotes in up to 3 other fiat currencies or cryptocurrencies.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "(^\\d+(?:,\\d+)*$|(\\d,)*PLATFORM_ID+(?:,\\d+)*$)" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat,search_interval` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(price|volume|market_cap|circulating_supply|total_supply|quote_timestamp|is_active|is_fiat|search_interval)+(?:,(price|volume|market_cap|circulating_supply|total_supply|quote_timestamp|is_active|is_fiat|search_interval)+)*$", "default": "price,volume,market_cap,circulating_supply,total_supply,quote_timestamp,is_active,is_fiat" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v2/cryptocurrency/quotes/latest": { "get": { "summary": "Quotes Latest v2", "operationId": "getV2CryptocurrencyQuotesLatest", "description": "Returns the latest market quote for 1 or more cryptocurrencies. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\n**Please note**: This documentation relates to our updated V2 endpoint, which may be incompatible with our V1 versions. Documentation for deprecated endpoints can be found [the deprecated section](/pro-api-reference/deprecated).\n\n\n**This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n- Basic\n- Startup\n- Builder\n- Growth\n- Professional\n- Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 100 cryptocurrencies returned (rounded up) and 1 call credit per `convert` option beyond the first. \n**CMC equivalent pages:** Latest market data pages for specific cryptocurrencies like [coinmarketcap.com/currencies/bitcoin/](https://coinmarketcap.com/currencies/bitcoin/). \n \n***NOTE:** Use this endpoint to request the latest quote for specific cryptocurrencies. If you need to request all cryptocurrencies use `/v1/cryptocurrency/listings/latest` which is optimized for that purpose. The response data between these endpoints is otherwise the same.*", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found [here](/guides/standards-and-conventions). Each conversion is returned in its own \"quote\" object.", "name": "convert", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "(^\\d+(?:,\\d+)*$|(\\d,)*PLATFORM_ID+(?:,\\d+)*$)" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,market_cap_by_total_supply,volume_24h_reported,volume_7d,volume_7d_reported,volume_30d,volume_30d_reported,is_active,is_fiat` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(num_market_pairs|cmc_rank|date_added|tags|platform|max_supply|circulating_supply|total_supply|market_cap_by_total_supply|volume_24h_reported|volume_7d|volume_7d_reported|volume_30d|volume_30d_reported|is_active|is_fiat)+(?:,(num_market_pairs|cmc_rank|date_added|tags|platform|max_supply|circulating_supply|total_supply|market_cap_by_total_supply|volume_24h_reported|volume_7d|volume_7d_reported|volume_30d|volume_30d_reported|is_active|is_fiat)+)*$", "default": "num_market_pairs,cmc_rank,date_added,tags,platform,max_supply,circulating_supply,total_supply,is_active,is_fiat" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple cryptocurrencies an error is returned if no match is found for 1 or more requested cryptocurrencies. If set to true, invalid lookups will be skipped allowing valid cryptocurrencies to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "boolean", "default": true } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/partners/flipside-crypto/fcas/listings/latest": { "get": { "summary": "FCAS Listings Latest (deprecated)", "operationId": "getV1PartnersFlipsidecryptoFcasListingsLatest", "description": "Returns a paginated list of FCAS scores for all cryptocurrencies currently supported by FCAS. FCAS ratings are on a 0-1000 point scale with a corresponding letter grade and is updated once a day at UTC midnight. \n\n\n \nFCAS stands for Fundamental Crypto Asset Score, a single, consistently comparable value for measuring cryptocurrency project health. FCAS measures User Activity, Developer Behavior and Market Maturity and is provided by FlipSide Crypto. Find out more about FCAS methodology. Users interested in FCAS historical data including sub-component scoring may inquire through our CSV Data Delivery request form. \n \n*Disclaimer: Ratings that are calculated by third party organizations and are not influenced or endorsed by CoinMarketCap in any way.* \n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Once a day at UTC midnight. \n**Plan credit use:** 1 call credit per 100 FCAS scores returned (rounded up). \n**CMC equivalent pages:** The FCAS ratings available under our cryptocurrency ratings tab like [coinmarketcap.com/currencies/bitcoin/#ratings](https://coinmarketcap.com/currencies/bitcoin/#ratings). \n \n***NOTE:** Use this endpoint to request the latest FCAS score for all supported cryptocurrencies at the same time. If you require FCAS for only specific cryptocurrencies use `/v1/partners/flipside-crypto/fcas/quotes/latest` which is optimized for that purpose. The response data between these endpoints is otherwise the same.* ", "parameters": [ { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 100 } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `point_change_24h,percent_change_24h` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(point_change_24h|percent_change_24h)+(?:,(point_change_24h|percent_change_24h)+)*$", "default": "point_change_24h,percent_change_24h" } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FCAS_Listings_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/partners/flipside-crypto/fcas/quotes/latest": { "get": { "summary": "FCAS Quotes Latest (deprecated)", "operationId": "getV1PartnersFlipsidecryptoFcasQuotesLatest", "description": "Returns the latest FCAS score for 1 or more cryptocurrencies. FCAS ratings are on a 0-1000 point scale with a corresponding letter grade and is updated once a day at UTC midnight. \n\n\n \nFCAS stands for Fundamental Crypto Asset Score, a single, consistently comparable value for measuring cryptocurrency project health. FCAS measures User Activity, Developer Behavior and Market Maturity and is provided by FlipSide Crypto. Find out more about FCAS methodology. Users interested in FCAS historical data including sub-component scoring may inquire through our CSV Data Delivery request form. \n\n*Disclaimer: Ratings that are calculated by third party organizations and are not influenced or endorsed by CoinMarketCap in any way.* \n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Once a day at UTC midnight. \n**Plan credit use:** 1 call credit per 100 FCAS scores returned (rounded up). \n**CMC equivalent pages:** The FCAS ratings available under our cryptocurrency ratings tab like [coinmarketcap.com/currencies/bitcoin/#ratings](https://coinmarketcap.com/currencies/bitcoin/#ratings). \n \n***NOTE:** Use this endpoint to request the latest FCAS score for specific cryptocurrencies. If you require FCAS for all supported cryptocurrencies use `/v1/partners/flipside-crypto/fcas/listings/latest` which is optimized for that purpose. The response data between these endpoints is otherwise the same.*", "parameters": [ { "description": "One or more comma-separated cryptocurrency CoinMarketCap IDs. Example: 1,2", "name": "id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$" } }, { "description": "Alternatively pass a comma-separated list of cryptocurrency slugs. Example: \"bitcoin,ethereum\"", "x-convert": { "lowercase": true }, "name": "slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$" } }, { "description": "Alternatively pass one or more comma-separated cryptocurrency symbols. Example: \"BTC,ETH\". At least one \"id\" *or* \"slug\" *or* \"symbol\" is required for this request.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$" } }, { "description": "Optionally specify a comma-separated list of supplemental data fields to return. Pass `point_change_24h,percent_change_24h` to include all auxiliary fields.", "name": "aux", "in": "query", "schema": { "type": "string", "pattern": "^(point_change_24h|percent_change_24h)+(?:,(point_change_24h|percent_change_24h)+)*$", "default": "point_change_24h,percent_change_24h" } } ], "tags": ["Deprecated"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FCAS_Quote_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v3/index/cmc100-historical": { "get": { "parameters": [ { "description": "Timestamp (Unix or ISO 8601) to start returning CoinMarketCap 100 Index data for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".", "in": "query", "name": "time_start", "required": false, "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning CoinMarketCap 100 Index data for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.", "in": "query", "name": "time_end", "required": false, "schema": { "type": "string" } }, { "description": "The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 5 items. If \"time_start\" and \"time_end\" are supplied, the query limit is 10 and the count starts from \"time_start\".", "in": "query", "name": "count", "required": false, "schema": { "type": "string" } }, { "description": "Optionally adjust the interval of data returned.Valid values:\"5m\",\"15m\",\"daily\".", "in": "query", "name": "interval", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Succeeded response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseOfIndexHistoricalResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["CMC Index"], "description": "Returns an interval of historic CoinMarketCap 100 Index values based on the interval parameter. \t\t\n\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Startup\n - Builder\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/index/cmc100-historical`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 API call credit per request no matter query size. \n**CMC equivalent pages:** Our CoinMarketCap 100 Index on https://coinmarketcap.com/charts/cmc100/.", "operationId": "getV3IndexCMC100Historical", "x-keyless": true, "summary": "CoinMarketCap 100 Index Historical" } }, "/v3/index/cmc100-latest": { "get": { "responses": { "200": { "description": "Succeeded response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseOfIndexLatestResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["CMC Index"], "description": "Returns the lastest CoinMarketCap 100 Index value, constituents, and constituent weights. \t\t\n\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Startup\n - Builder\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/index/cmc100-latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 call credit per API call. \n**CMC equivalent pages:** Our CoinMarketCap 100 Index on https://coinmarketcap.com/charts/cmc100/.", "operationId": "getV3IndexCMC100Latest", "x-keyless": true, "summary": "CoinMarketCap 100 Index Latest" } }, "/v3/index/cmc20-historical": { "get": { "parameters": [ { "description": "Timestamp (Unix or ISO 8601) to start returning CoinMarketCap 20 Index data for. Optional, if not passed, we'll return quotes calculated in reverse from \"time_end\".", "in": "query", "name": "time_start", "required": false, "schema": { "type": "string" } }, { "description": "Timestamp (Unix or ISO 8601) to stop returning CoinMarketCap 20 Index data for (inclusive). Optional, if not passed, we'll default to the current time. If no \"time_start\" is passed, we return quotes in reverse order starting from this time.", "in": "query", "name": "time_end", "required": false, "schema": { "type": "string" } }, { "description": "The number of interval periods to return results for. Optional, required if both \"time_start\" and \"time_end\" aren't supplied. The default is 5 items. If \"time_start\" and \"time_end\" are supplied, the query limit is 10 and the count starts from \"time_start\".", "in": "query", "name": "count", "required": false, "schema": { "type": "string" } }, { "description": "Optionally adjust the interval of data returned.Valid values:\"5m\",\"15m\",\"daily\".", "in": "query", "name": "interval", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Succeeded response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseOfCMC20IndexHistoricalResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["CMC Index"], "description": "Returns an interval of historic CoinMarketCap 20 Index values based on the interval parameter. \t\t\n\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Startup\n - Builder\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/index/cmc20-historical`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 API call credit per request no matter query size. \n**CMC equivalent pages:** Our CoinMarketCap 20 Index on https://coinmarketcap.com/charts/cmc20/.", "operationId": "getV3IndexCMC20Historical", "x-keyless": true, "summary": "CoinMarketCap 20 Index Historical" } }, "/v3/index/cmc20-latest": { "get": { "responses": { "200": { "description": "Succeeded response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseOfCMC20IndexLatestResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } }, "tags": ["CMC Index"], "description": "Returns the lastest CoinMarketCap 20 Index value, constituents, and constituent weights. \t\t\n\n\n \n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Startup\n - Builder\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v3/index/cmc20-latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 5 minutes. \n**Plan credit use:** 1 call credit per API call. \n**CMC equivalent pages:** Our CoinMarketCap 20 Index on https://coinmarketcap.com/charts/cmc20/.", "operationId": "getV3IndexCMC20Latest", "x-keyless": true, "summary": "CoinMarketCap 20 Index Latest" } }, "/v1/dex/tokens/trending/list": { "post": { "tags": ["Token"], "summary": "Get trending tokens", "description": "Get list of trending tokens", "operationId": "getTrendingList", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Tokens_Trending_List_-_Response_Model" } } } } }, "requestBody": { "$ref": "#/components/requestBodies/DqueryMarketRequestDTO" } } }, "/v1/dex/tokens/batch-query": { "post": { "tags": ["Token"], "summary": "Batch query tokens", "description": "Query multiple tokens in one request", "operationId": "batchQueryTokens", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Tokens_Batch_Query_-_Response_Model" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DqueryBatchTokenRequestDTO" } } }, "required": true } } }, "/v1/dex/token/price/batch": { "post": { "tags": ["Token"], "summary": "Batch get token prices", "description": "Get prices for multiple tokens in one request", "operationId": "batchGetTokenPrice", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Token_Price_Batch_-_Response_Model" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DqueryBatchPriceRequestDTO" } } }, "required": true } } }, "/v1/dex/new/list": { "post": { "tags": ["Token"], "summary": "Get new tokens", "description": "Get list of newly launched tokens", "operationId": "getNewList", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_New_List_-_Response_Model" } } } } }, "requestBody": { "$ref": "#/components/requestBodies/DqueryMarketRequestDTO" } } }, "/v1/dex/meme/list": { "post": { "tags": ["Token"], "summary": "Get meme tokens", "description": "Get list of meme tokens", "operationId": "getMemeList", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Meme_List_-_Response_Model" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DqueryMemeRequestDTO" } } }, "required": true } } }, "/v1/dex/gainer-loser/list": { "post": { "tags": ["Token"], "summary": "Get top gainers and losers", "description": "Get list of top gainer and loser tokens", "operationId": "getGainerLoserList", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Gainer_Loser_List_-_Response_Model" } } } } }, "requestBody": { "$ref": "#/components/requestBodies/DqueryMarketRequestDTO" } } }, "/v2/dex/multiplier": { "get": { "tags": ["Deprecated"], "summary": "Get token multiplier", "description": "Returns a paginated list of tokens that has a ERC-8056 UI multiplier.\n\nYou may filter by `platform` or `platform_id` (if both are provided, `platform_id` takes precedence). When querying a specific token via `token_address`, you must also provide at least one of `platform` or `platform_id`.\n\nPagination is controlled by `start` (1-based index) and `limit` (default 100, max 2000).\n\n**No credit is needed when querying this endpoint.**", "operationId": "getV2DexMultiplier", "parameters": [ { "name": "platform", "in": "query", "description": "Platform name. If both `platform` and `platform_id` are provided, `platform_id` takes precedence.", "required": false, "schema": { "type": "string", "example": "bsc" } }, { "name": "platform_id", "in": "query", "description": "Platform id. If both `platform` and `platform_id` are provided, `platform_id` takes precedence.", "required": false, "schema": { "type": "integer", "minimum": 1, "example": 14 } }, { "name": "token_address", "in": "query", "description": "Token address. If provided, at least one of `platform` or `platform_id` is required.", "required": false, "schema": { "type": "string", "example": "0x1234567890abcdef1234567890abcdef12345678" } }, { "name": "start", "in": "query", "description": "Pagination start (1-based index). Default: 1.", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "example": 1 } }, { "name": "limit", "in": "query", "description": "Number of results per page. Default: 100.", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 2000, "default": 100, "example": 100 } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dex_Multiplier_-_Response_Model" }, "examples": { "success": { "summary": "Successful response", "value": { "data": { "total_size": 2, "items": [ { "platform_id": 14, "platform": "bsc", "token_address": "0x1234567890abcdef1234567890abcdef12345678", "name": "Dogecoin", "symbol": "DOGE", "multiplier": 0.01, "effective_at": "2026-05-19T10:30:00Z" }, { "platform_id": 14, "platform": "bsc", "token_address": "0x1234567890abcdef1234567890abcdef12345678", "name": "Zest Protocol", "symbol": "ZEST", "multiplier": 0.01, "effective_at": "2026-05-19T10:30:00Z" } ], "has_more": false }, "status": { "timestamp": "2026-05-19T10:59:42.581Z", "error_code": 0, "error_message": null, "elapsed": 83, "credit_count": 0, "notice": null } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dex_Multiplier_-_Validation_Error_Object" }, "examples": { "missingPlatformForAddress": { "summary": "token_address without platform/platform_id", "value": { "status": { "error_code": 4002, "category": "VALIDATION", "error_message": "Missing required parameter.", "error_detail": "At least one of platform, platform_id is required." } } }, "invalidPlatformId": { "summary": "Invalid platform_id", "value": { "status": { "error_code": 4001, "category": "VALIDATION", "error_message": "Invalid parameter.", "error_detail": "platform_id: ${value} is not valid." } } } } } } } } } }, "/v4/dex/spot-pairs/latest": { "get": { "tags": ["Token"], "summary": "Pairs Listings Latest", "description": "Returns a paginated list of all active dex spot pairs with latest market data. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v4/dex/spot-pairs/latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getSpotPairsLatest", "x-keyless": true, "parameters": [ { "name": "network_id", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency network ids.", "required": false, "example": "1,2", "schema": { "type": "string" } }, { "name": "network_slug", "in": "query", "description": "Alternatively, one or more comma-separated network names in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.", "required": false, "example": "ethereum,base", "schema": { "type": "string" } }, { "name": "dex_id", "in": "query", "description": "One or more comma-separated CoinMarketCap dex exchange ids", "required": false, "example": "1,2", "schema": { "type": "string" } }, { "name": "dex_slug", "in": "query", "description": "Alternatively, one or more comma-separated dex exchange names in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.", "required": false, "example": "uniswap,pancakeswap", "schema": { "type": "string" } }, { "name": "base_asset_id", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency ids.", "required": false, "example": "1,2", "schema": { "type": "string" } }, { "name": "base_asset_symbol", "in": "query", "description": "Alternatively, one or more comma-separated network symbol in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens).At least one id or slug is required.", "required": false, "example": "ethereum, usdt.", "schema": { "type": "string" } }, { "name": "base_asset_contract_address", "in": "query", "description": "Alternatively, one base asset contract address in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens).At least one id or slug is required.", "required": false, "example": "ethereum, usdt.", "schema": { "type": "string" } }, { "name": "base_asset_ucid", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs.", "required": false, "example": "1,1027", "schema": { "type": "string" } }, { "name": "quote_asset_id", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency ids.", "required": false, "example": "1,2", "schema": { "type": "string" } }, { "name": "quote_asset_symbol", "in": "query", "description": "Alternatively, one or more comma-separated network symbol in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.", "required": false, "example": "ethereum, usdt.", "schema": { "type": "string" } }, { "name": "quote_asset_contract_address", "in": "query", "description": "Alternatively, one quote asset contract address in URL friendly shorthand slug format (all lowercase, spaces replaced with hyphens). At least one id or slug is required.", "required": false, "example": "ethereum, usdt.", "schema": { "type": "string" } }, { "name": "quote_asset_ucid", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency IDs.", "required": false, "example": "1,1027", "schema": { "type": "string" } }, { "name": "scroll_id", "in": "query", "description": "After your initial query, the API responds with the initial set of results and a scroll_ids. To retrieve the next set of results, provide this scroll_id of the last JSON with your follow-up request. scroll_id is an alternative to traditional pagination techniques.", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Optionally specify the number of results to return. Use this parameter and the start parameter to determine your own pagination size.", "required": false, "schema": { "type": "string" } }, { "name": "liquidity_min", "in": "query", "description": "Optionally specify a threshold of minimum liquidity to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "liquidity_max", "in": "query", "description": "Optionally specify a threshold of maximum liquidity to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "volume_24h_min", "in": "query", "description": "Optionally specify a threshold of minimum 24 hour USD volume to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "volume_24h_max", "in": "query", "description": "Optionally specify a threshold of maximum 24 hour USD volume to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "no_of_transactions_24h_min", "in": "query", "description": "Optionally specify a threshold of minimum 24h no. of transactions to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "no_of_transactions_24h_max", "in": "query", "description": "Optionally specify a threshold of maximum 24h no. of transactions to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "percent_change_24h_min", "in": "query", "description": "Optionally specify a threshold of minimum 24 hour percent change to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "percent_change_24h_max", "in": "query", "description": "Optionally specify a threshold of maximum 24 hour percent change to filter results by.", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Default:`\"volume_24h\"`\nValid values: `\"volume_24h\"` `\"liquidity\"` `\"no_of_transactions_24h\"` `\"percent_change_24h\"` // todo\nSort the list of dex spot pairs by.", "required": false, "schema": { "type": "string" } }, { "name": "sort_dir", "in": "query", "description": "Default:`\"desc\"`\nValid values: `\"desc\"` `\"asc\"`\nThe direction in which to order dex spot pairs against the specified sort.", "required": false, "schema": { "type": "string" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"pool_created\"` `\"percent_pooled_base_asset\"` `\"num_transactions_24h\"` `\"pool_base_asset\"` `\"pool_quote_asset\"` `\"24h_volume_quote_asset\"` `\"total_supply_quote_asset\"` `\"total_supply_base_asset\"` `\"holders\"` `\"buy_tax\"` `\"sell_tax\"` `\"security_scan\"` `\"24h_no_of_buys\"` `\"24h_no_of_sells\"` `\"24h_buy_volume\"` `\"24h_sell_volume\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "schema": { "type": "string" } }, { "name": "reverse_order", "in": "query", "description": "Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.", "required": false, "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.", "required": false, "example": "1,2781", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Spot_Pairs_Latest_-_Response_Model" } } } } } } }, "/v4/dex/pairs/trade/latest": { "get": { "tags": ["Deprecated"], "summary": "Trades Latest", "description": "Returns up to the latest 100 trades for 1 spot pair. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.", "operationId": "getPairsLatestTrade", "parameters": [ { "name": "contract_address", "in": "query", "description": "One or more comma-separated contract addresses.", "required": false, "example": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640,0xc2e9f25be6257c210d7adf0d4cd6e3e881ba25f8", "schema": { "type": "string" } }, { "name": "network_id", "in": "query", "description": "One CoinMarketCap cryptocurrency network id.", "required": false, "example": "1", "schema": { "type": "string" } }, { "name": "network_slug", "in": "query", "description": "Alternatively, one network names in URL friendly shorthand \"slug\" \nformat (all lowercase, spaces replaced with hyphens).", "required": false, "example": "ethereum", "schema": { "type": "string" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"transaction_hash\"` `\"blockchain_explorer_link\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "example": "transaction_hash", "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes in up to 30 currencies at once by passing a comma-separated list of cryptocurrency \nor fiat currency IDs. Each additional convert option beyond the first requires an additional call credit. A list of supported fiat options can be found in our API document. Each conversion is returned in its \nown \"trade\" object.", "required": false, "example": "If you want to know the market quote is BTC, you can use convert_id=1. For USD, convert_id=2781.", "schema": { "type": "string" } }, { "name": "skip_invalid", "in": "query", "description": "Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned \nif no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid \nspot pairs to still be returned.", "required": false, "example": "true", "schema": { "type": "string", "default": "true" } }, { "name": "reverse_order", "in": "query", "description": "Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and \nis commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true \nToken B/Token A pairing as it exists in the pool.", "required": false, "example": "false", "schema": { "type": "string", "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Pairs_Trade_Latest_-_Response_Model" } } } } } } }, "/v4/dex/pairs/quotes/latest": { "get": { "tags": ["Token"], "summary": "Quotes Latest", "description": "Returns the latest market quote for 1 or more spot pairs. Use the \"convert\" option to return market values in multiple fiat and cryptocurrency conversions in the same call.\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v4/dex/pairs/quotes/latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getLatestPairsQuotes", "x-keyless": true, "parameters": [ { "name": "contract_address", "in": "query", "description": "One or more comma-separated contract addresses.", "required": false, "example": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640,0xc2e9f25be6257c210d7adf0d4cd6e3e881ba25f8", "schema": { "type": "string" } }, { "name": "network_id", "in": "query", "description": "One or more CoinMarketCap cryptocurrency network ids", "required": false, "example": "1", "schema": { "type": "string" } }, { "name": "network_slug", "in": "query", "description": "Alternatively, one network names in URL friendly shorthand \"slug\" format (all lowercase, spaces replaced with hyphens).", "required": false, "example": "ethereum", "schema": { "type": "string" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"pool_created\"` `\"percent_pooled_base_asset\"` `\"num_transactions_24h\"` `\"pool_base_asset\"` `\"pool_quote_asset\"` `\"24h_volume_quote_asset\"` `\"total_supply_quote_asset\"` `\"total_supply_base_asset\"` `\"holders\"` `\"buy_tax\"` `\"sell_tax\"` `\"security_scan\"` `\"24h_no_of_buys\"` `\"24h_no_of_sells\"` `\"24h_buy_volume\"` `\"24h_sell_volume\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.", "required": false, "example": "1,2781", "schema": { "type": "string" } }, { "name": "skip_invalid", "in": "query", "description": "Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned if no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid spot pairs to still be returned.", "required": false, "schema": { "type": "string" } }, { "name": "reverse_order", "in": "query", "description": "Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Pairs_Quotes_Latest_-_Response_Model" } } } } } } }, "/v4/dex/pairs/ohlcv/latest": { "get": { "tags": ["Deprecated"], "summary": "OHLCV Latest", "description": "Returns the latest OHLCV (Open, High, Low, Close, Volume) market values for one or more spot pairs for the current UTC day. Since the current UTC day is still active these values are updated frequently. You can find the final calculated OHLCV values for the last completed UTC day along with all historic days using /dex/pairs/ohlcv/historical.", "operationId": "getPairsLatestOHLCV", "parameters": [ { "name": "contract_address", "in": "query", "description": "One or more comma-separated contract addresses.", "required": false, "example": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640,0xc2e9f25be6257c210d7adf0d4cd6e3e881ba25f8", "schema": { "type": "string" } }, { "name": "network_id", "in": "query", "description": "One or more CoinMarketCap cryptocurrency network ids", "required": false, "example": "1", "schema": { "type": "string" } }, { "name": "network_slug", "in": "query", "description": "Alternatively, one network names in URL friendly shorthand \"slug\" format (all lowercase, spaces replaced with hyphens).", "required": false, "example": "ethereum", "schema": { "type": "string" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"pool_created\"` `\"percent_pooled_base_asset\"` `\"num_transactions_24h\"` `\"pool_base_asset\"` `\"pool_quote_asset\"` `\"24h_volume_quote_asset\"` `\"total_supply_quote_asset\"` `\"total_supply_base_asset\"` `\"holders\"` `\"buy_tax\"` `\"sell_tax\"` `\"security_scan\"` `\"24h_no_of_buys\"` `\"24h_no_of_sells\"` `\"24h_buy_volume\"` `\"24h_sell_volume\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.", "required": false, "example": "1,2781", "schema": { "type": "string" } }, { "name": "skip_invalid", "in": "query", "description": "Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned if no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid spot pairs to still be returned.", "required": false, "schema": { "type": "string" } }, { "name": "reverse_order", "in": "query", "description": "Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Pairs_Ohlcv_Latest_-_Response_Model" } } } } } } }, "/v4/dex/pairs/ohlcv/historical": { "get": { "tags": ["Deprecated"], "summary": "OHLCV Historical", "description": "Returns historical OHLCV (Open, High, Low, Close, Volume) data along with market cap for any spot pairs using time interval parameters.", "operationId": "getPairsHistoricalOHLCV", "parameters": [ { "name": "contract_address", "in": "query", "description": "One contract address. Example:\"0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640\".\nIf network/dex/base asset/quote asset information is passed, contract address cannot be passed.\nNote: contract_address is case sensitive for all non-EVM chains and not case sensitive for all EVM chains. EVM chains contract address addresses begin with 0x, and are followed by 40 alphanumeric characters(numerals and letters)", "required": false, "example": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640", "schema": { "type": "string" } }, { "name": "network_id", "in": "query", "description": "One or more CoinMarketCap cryptocurrency network ids", "required": false, "example": "1", "schema": { "type": "string" } }, { "name": "network_slug", "in": "query", "description": "Alternatively, one network names in URL friendly shorthand \"slug\" format (all lowercase, spaces replaced with hyphens).", "required": false, "example": "ethereum", "schema": { "type": "string" } }, { "name": "time_period", "in": "query", "description": "Default:`\"daily\"`\nValid values: `\"daily\"` `\"hourly\"` `\"1m\"` `\"5m\"` `\"15m\"` `\"4h\"`\nTime period to return OHLCV data for. If hourly, the open will be 01:00 and the close will be 01:59. If daily, the open will be 00:00:00 for the day and close will be 23:59:99 for the same day. See the main endpoint description for details.", "required": false, "example": "daily", "schema": { "type": "string", "default": "daily" } }, { "name": "time_start", "in": "query", "description": "Timestamp (Unix or ISO 8601) to start returning OHLCV time periods for. Only the date portion of the timestamp \nis used for daily OHLCV so it's recommended to send an ISO date format like \"2018-09-19\" without time.", "required": false, "example": "2018-09-19", "schema": { "type": "string" } }, { "name": "time_end", "in": "query", "description": "Timestamp (Unix or ISO 8601) to stop returning OHLCV time periods for (inclusive). Optional, if not passed we'll default \nto the current time. Only the date portion of the timestamp is used for daily OHLCV so it's recommended to send an \nISO date format like \"2018-09-19\" without time.", "required": false, "example": "2018-09-19", "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "Optionally limit the number of time periods to return results for. The default is 10 items. The current query \nlimit is 500 items.", "required": false, "example": "50", "schema": { "type": "string", "default": "10" } }, { "name": "interval", "in": "query", "description": "Default:`\"daily\"`\nValid values: `\"1m\"` `\"5m\"` `\"15m\"` `\"30m\"` `\"1h\"` `\"4h\"` `\"8h\"` `\"12h\"` `\"daily\"` `\"weekly\"` `\"monthly\"`\nOptionally adjust the interval that \"time_period\" is sampled. For example with interval=monthly&time_period=daily you will see a daily OHLCV record for January, February, March and so on. See main endpoint description for available options.", "required": false, "example": "daily", "schema": { "type": "string", "default": "daily" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"pool_created\"` `\"percent_pooled_base_asset\"` `\"num_transactions_24h\"` `\"pool_base_asset\"` `\"pool_quote_asset\"` `\"24h_volume_quote_asset\"` `\"total_supply_quote_asset\"` `\"total_supply_base_asset\"` `\"holders\"` `\"buy_tax\"` `\"sell_tax\"` `\"security_scan\"` `\"24h_no_of_buys\"` `\"24h_no_of_sells\"` `\"24h_buy_volume\"` `\"24h_sell_volume\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to convert outside of ID format. Ex: convert_id=1,2781 would replace convert=BTC,USD in your query. This parameter cannot be used when convert is used.", "required": false, "example": "1,2781", "schema": { "type": "string" } }, { "name": "skip_invalid", "in": "query", "description": "Pass true to relax request validation rules. When requesting records on multiple spot pairs an error is returned if no match is found for 1 or more requested spot pairs. If set to true, invalid lookups will be skipped allowing valid spot pairs to still be returned.", "required": false, "schema": { "type": "string" } }, { "name": "reverse_order", "in": "query", "description": "Pass true to invert the order of a spot pair. For example, a trading pair is set up as Token B/Token A in the contract and is commonly referred to as Token A/Token B. Using reverse_order would change the order to reflect the true Token B/Token A pairing as it exists in the pool.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Pairs_Ohlcv_Historical_-_Response_Model" } } } } } } }, "/v4/dex/networks/list": { "get": { "tags": ["Deprecated"], "summary": "CoinMarketCap ID Map", "description": "Returns a list of all networks to unique CoinMarketCap ids.Per our Best Practices we recommend utilizing CMC ID instead of network symbols to securely identify networks with our other endpoints and in your own application logic. Each network returned includes typical identifiers such as name, symbol, and token_address for flexible mapping to id.", "operationId": "getNetworks", "parameters": [ { "name": "start", "in": "query", "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "required": false, "example": "1", "schema": { "type": "string", "default": "1" } }, { "name": "limit", "in": "query", "description": "Optionally specify the number of results to return. Use this parameter and the \n\"start\" parameter to determine your own pagination size.", "required": false, "example": "50", "schema": { "type": "string", "default": "50" } }, { "name": "sort", "in": "query", "description": "Default:`\"id\"`\nValid values: `\"id\"` `\"name\"`\nWhat field to sort the list of networks by.", "required": false, "example": "id", "schema": { "type": "string", "default": "id" } }, { "name": "sort_dir", "in": "query", "description": "Default:`\"desc\"`\nValid values: `\"desc\"` `\"asc\"`\nThe direction in which to order networks against the specified sort.", "required": false, "example": "desc", "schema": { "type": "string", "default": "desc" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"alternativeName\"` `\"cryptocurrencyId\"` `\"cryptocurrenySlug\"` `\"wrappedTokenId\"` `\"wrappedTokenSlug\"` `\"tokenExplorerUrl\"` `\"poolExplorerUrl\"` `\"transactionHashUrl\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "example": "alternativeName,cryptocurrencyId", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Networks_List_-_Response_Model" } } } } } } }, "/v4/dex/listings/quotes": { "get": { "tags": ["Deprecated"], "summary": "DEX Listings Latest", "description": "Returns a paginated list of all decentralised cryptocurrency exchanges including \nthe latest aggregate market data for each exchange. Use the \"convert\" option to \nreturn market values in multiple fiat and cryptocurrency conversions in the same call.", "operationId": "getLatestListings", "parameters": [ { "name": "start", "in": "query", "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "required": false, "example": "1", "schema": { "type": "string", "default": "1" } }, { "name": "limit", "in": "query", "description": "Optionally specify the number of results to return. Use this parameter and the \n\"start\" parameter to determine your own pagination size.", "required": false, "example": "50", "schema": { "type": "string", "default": "50" } }, { "name": "sort", "in": "query", "description": "Default:`\"volume_24h\"`\nValid values: `\"name\"` `\"volume_24h\"` `\"market_share\"` `\"num_markets\"`\nWhat field to sort the list of exchanges by.", "required": false, "example": "volume_24h", "schema": { "type": "string", "default": "volume_24h" } }, { "name": "sort_dir", "in": "query", "description": "Default:`\"desc\"`\nValid values: `\"desc\"` `\"asc\"`\nThe direction in which to order exchanges against the specified sort.", "required": false, "example": "desc", "schema": { "type": "string", "default": "desc" } }, { "name": "type", "in": "query", "description": "Default:`\"all\"`\nValid values: `\"all\"` `\"orderbook\"` `\"swap\"` `\"aggregator\"`\nThe category for this exchange.", "required": false, "example": "all", "schema": { "type": "string", "default": "all" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"date_launched\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "example": "date_launched", "schema": { "type": "string" } }, { "name": "convert_id", "in": "query", "description": "Optionally calculate market quotes in up to 30 currencies at once by passing a comma-separated list of cryptocurrency \nor fiat currency IDs. Each additional convert option beyond the first requires an additional call credit. A list of \nsupported fiat options can be found in our API document. Each conversion is returned in its own \"quote\" object.", "required": false, "example": "If you want to know the market quote is BTC and USD, you can use convert_id=1,2781.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Listings_Quotes_-_Response_Model" } } } } } } }, "/v4/dex/listings/info": { "get": { "tags": ["Deprecated"], "summary": "DEX Metadata", "description": "Returns all static metadata for one or more decentralised exchanges. This information includes details like launch \ndate, logo, official website URL, social links, and market fee documentation URL.", "operationId": "getListingsInfo", "parameters": [ { "name": "id", "in": "query", "description": "One or more comma-separated CoinMarketCap cryptocurrency exchange ids.", "required": false, "example": "1,2", "schema": { "type": "string" } }, { "name": "aux", "in": "query", "description": "Default:`\"\"`\nValid values: `\"urls\"` `\"logo\"` `\"description\"` `\"date_launched\"` `\"notice\"`\nOptionally specify a comma-separated list of supplemental data fields to return.", "required": false, "example": "urls,logo,description,date_launched,notice", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V4_DEX_Listings_Info_-_Response_Model" } } } } } } }, "/v1/k-line/points": { "get": { "tags": ["OHLCV"], "summary": "Get K-line points", "description": "Get K-line price points for a token.\n\nResponse Format: Each point is an array with 3 elements:\n- **[0]** price: Token price\n- **[1]** volume: Trading volume\n- **[2]** timestamp: UNIX timestamp (seconds)\n\nExample: ``[[1.23, 50000, 1705363200], ...]``\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/k-line/points`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getKlinePoints", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Platform name or id", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token or pool address", "required": false, "schema": { "type": "string" } }, { "name": "interval", "in": "query", "description": "Kline interval: 1s/5s/30s/1min/3min/5min/15min/30min/1h/2h/4h/6h/8h/12h/1d/3d/1w/1m", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Start timestamp (UNIX epoch)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "description": "End timestamp (UNIX epoch)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "unit", "in": "query", "description": "Kline unit: usd, native, quote", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of points to load", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pm", "in": "query", "description": "Kline type: p (price), m (marketcap)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_K_Line_Points_-_Response_Model" } } } } } } }, "/v1/k-line/candles": { "get": { "tags": ["OHLCV"], "summary": "Get K-line candles", "description": "Get K-line candle (OHLCV) data for a token.\n\nResponse Format: Each candle is an array with 7 elements:\n- **[0]** open: Opening price\n- **[1]** high: Highest price\n- **[2]** low: Lowest price\n- **[3]** close: Closing price\n- **[4]** volume: Trading volume\n- **[5]** timestamp: UNIX timestamp (seconds)\n- **[6]** traders: Number of unique traders\n\nExample: ``[[1.23, 1.45, 1.20, 1.40, 50000, 1705363200, 128], ...]``\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/k-line/candles`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getKlineCandles", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Platform name or id", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token or pool address", "required": false, "schema": { "type": "string" } }, { "name": "interval", "in": "query", "description": "Kline interval: 1s/5s/30s/1min/3min/5min/15min/30min/1h/2h/4h/6h/8h/12h/1d/3d/1w/1m", "required": false, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Start timestamp (UNIX epoch)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "description": "End timestamp (UNIX epoch)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "unit", "in": "query", "description": "Kline unit: usd, native, quote", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of candles to load", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pm", "in": "query", "description": "Kline type: p (price), m (marketcap)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_K_Line_Candles_-_Response_Model" } } } } } } }, "/v1/dex/token": { "get": { "tags": ["Token"], "summary": "Get token detail", "description": "Get detailed information for a specific token\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/token`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getToken", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Platform name", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token address", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Token_-_Response_Model" } } } } } } }, "/v1/dex/token/price": { "get": { "tags": ["Token"], "summary": "Get token price", "description": "Get current price for a specific token\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/token/price`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getTokenPrice", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Platform name", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token address", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Token_Price_-_Response_Model" } } } } } } }, "/v1/dex/token/pools": { "get": { "tags": ["Token"], "summary": "Get token pools", "description": "Get all pools for a specific token\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/token/pools`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getTokenPools", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Platform name", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token address", "required": false, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Token_Pools_-_Response_Model" } } } } } } }, "/v1/dex/token-liquidity/query": { "get": { "tags": ["Token"], "summary": "Query token liquidity", "description": "Get liquidity information for a specific token\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/token-liquidity/query`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "queryTokenLiquidity", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Platform name", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token address", "required": false, "schema": { "type": "string" } }, { "name": "interval", "in": "query", "description": "Time interval", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Result limit", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "to", "in": "query", "description": "End timestamp", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "needLatest", "in": "query", "description": "Whether to include latest value", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Token_Liquidity_Query_-_Response_Model" } } } } } } }, "/v1/dex/tokens/transactions": { "get": { "tags": ["Token"], "summary": "Get swap list", "description": "Get swap/trade history for a token\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/tokens/transactions`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getSwapList", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Blockchain platform name (bsc/sol/etc)", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token contract address", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Transaction type (0 for buy, 1 for sell)", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "types", "in": "query", "description": "Transaction types filter, supports: buy, sell, open, close, add, reduce", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "maker", "in": "query", "description": "Maker address, support comma separated list", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Field to sort by (currently only supports 'time')", "required": false, "schema": { "type": "string" } }, { "name": "sortType", "in": "query", "description": "Sort direction ('asc' or 'desc', default is 'desc')", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Start timestamp (inclusive)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endTime", "in": "query", "description": "End timestamp (inclusive)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "minVolume", "in": "query", "description": "Minimum volume (inclusive)", "required": false, "schema": { "type": "number" } }, { "name": "maxVolume", "in": "query", "description": "Maximum volume (inclusive)", "required": false, "schema": { "type": "number" } }, { "name": "lastId", "in": "query", "description": "Cursor for pagination, format: ts_txHash_logId", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Result limit", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "version", "in": "query", "description": "Version", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Tokens_Transactions_-_Response_Model" } } } } } } }, "/v1/dex/security/detail": { "get": { "tags": ["Token"], "summary": "Get security detail", "description": "Get security audit information for a token\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/security/detail`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getSecurityDetail", "x-keyless": true, "parameters": [ { "name": "platformName", "in": "query", "description": "Platform name", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token address", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Security_Detail_-_Response_Model" } } } } } } }, "/v1/dex/search": { "get": { "tags": ["Token"], "summary": "Search tokens", "description": "Search for tokens by keyword\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/search`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "search", "x-keyless": true, "parameters": [ { "name": "q", "in": "query", "description": "Search keyword", "required": false, "schema": { "type": "string" } }, { "name": "platform", "in": "query", "description": "Platform filter", "required": false, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Sort field", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Result limit", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "code", "in": "query", "description": "Code filter", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Search_-_Response_Model" } } } } } } }, "/v1/dex/platform/list": { "get": { "tags": ["Platform"], "summary": "Get platform list", "description": "Get list of all supported platforms\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/platform/list`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getPlatformList", "x-keyless": true, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Platform_List_-_Response_Model" } } } } } } }, "/v1/dex/platform/detail": { "get": { "tags": ["Platform"], "summary": "Get platform detail", "description": "Get detailed information for a specific platform\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/platform/detail`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getPlatformDetail", "x-keyless": true, "parameters": [ { "name": "platformName", "in": "query", "description": "Platform name", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Platform_Detail_-_Response_Model" } } } } } } }, "/v1/dex/liquidity-change/list": { "get": { "tags": ["Token"], "summary": "Get liquidity change list", "description": "Get liquidity change history for a token\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/liquidity-change/list`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getLiquidityChangeList", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "description": "Blockchain platform name (bsc/sol/etc)", "required": false, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Token contract address", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Liquidity change type", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "maker", "in": "query", "description": "Maker address, support comma separated list", "required": false, "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "description": "Field to sort by (currently only supports 'ts')", "required": false, "schema": { "type": "string" } }, { "name": "sortType", "in": "query", "description": "Sort direction ('asc' or 'desc', default is 'desc')", "required": false, "schema": { "type": "string" } }, { "name": "startTime", "in": "query", "description": "Start timestamp (inclusive)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "endTime", "in": "query", "description": "End timestamp (inclusive)", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "minVolume", "in": "query", "description": "Minimum USD volume (inclusive)", "required": false, "schema": { "type": "number" } }, { "name": "maxVolume", "in": "query", "description": "Maximum USD volume (inclusive)", "required": false, "schema": { "type": "number" } }, { "name": "lastId", "in": "query", "description": "Cursor for pagination, format: ts_txHash_logId", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Result limit", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Liquidity_Change_List_-_Response_Model" } } } } } } }, "/v1/dex/holders/list": { "post": { "tags": ["Holder"], "summary": "Get holders list", "description": "Get detailed information for holders list\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/holders/list`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getHolders", "x-keyless": true, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DqueryHoldersRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Holders_List_-_Response_Model" } } } } } } }, "/v1/dex/holders/detail": { "post": { "tags": ["Holder"], "summary": "Get holder detail", "description": "Get detailed information for holders detail\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/holders/detail`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getHolderDetail", "x-keyless": true, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DqueryHoldersDetailRequestDTO" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Holders_Detail_-_Response_Model" } } } } } } }, "/v1/dex/holders/trend/list": { "get": { "tags": ["Holder"], "summary": "Get holder trend list", "description": "Get detailed information for holders trend list", "operationId": "getHoldTrendList", "parameters": [ { "name": "platform", "in": "query", "required": false, "description": "Platform name or id", "schema": { "type": "string" } }, { "name": "tokenAddress", "in": "query", "required": false, "description": "Token address", "schema": { "type": "string" } }, { "name": "interval", "in": "query", "required": false, "description": "Kline interval: 1d", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": false, "description": "start timestamp", "schema": { "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "required": false, "description": "End timestamp", "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "required": false, "description": "Number of to load", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Holders_Trend_List_-_Response_Model" } } } } } } }, "/v1/dex/holders/tag_count": { "get": { "tags": ["Holder"], "summary": "Get holder tag count", "description": "Get detailed information for holders tag count", "operationId": "getHolderTagCount", "parameters": [ { "name": "platform", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tokenAddress", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Holders_Tag_Count_-_Response_Model" } } } } } } }, "/v1/dex/holders/count": { "get": { "tags": ["Holder"], "summary": "Get holder count", "description": "Get detailed information for holders count\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/dex/holders/count`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.", "operationId": "getHolderCount", "x-keyless": true, "parameters": [ { "name": "platform", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tokenAddress", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1_DEX_Holders_Count_-_Response_Model" } } } } } } }, "/v1/altcoin-season-index/latest": { "get": { "summary": "Altcoin Season Index Latest", "operationId": "getV1AltcoinSeasonIndexLatest", "x-keyless": true, "description": "Returns the latest Altcoin Season Index snapshot with yearly high/low statistics. Index scale 0-100; values above 75 suggest altcoin season, below 25 suggest Bitcoin season.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/altcoin-season-index/latest`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 15 minutes.\n**Plan credit use:** 1 API call credit per request.", "tags": ["Global Metrics"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Altcoin_Season_Index_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v1/altcoin-season-index/historical": { "get": { "summary": "Altcoin Season Index Historical", "operationId": "getV1AltcoinSeasonIndexHistorical", "x-keyless": true, "description": "Returns historical Altcoin Season Index data for a specified timeframe (7d, 30d, or 90d). Data points are sorted by timestamp (oldest first).\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\nCall this endpoint keyless - no API key, no signup. Prefix the path with `/public-api`: `https://pro-api.coinmarketcap.com/public-api/v1/altcoin-season-index/historical`. See the [Keyless Public API](https://coinmarketcap.com/api/documentation/pro-api-reference/keyless-public-api) for the full list, rate limits, and examples.\n\n**Cache / Update frequency:** Every 15 minutes.\n**Plan credit use:** 1 API call credit per request.", "parameters": [ { "name": "timeframe", "in": "query", "description": "Timeframe for historical data. Valid values are 7d, 30d, and 90d. Default is 7d.", "required": false, "schema": { "type": "string", "default": "7d", "enum": ["7d", "30d", "90d"] } } ], "tags": ["Global Metrics"], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Altcoin_Season_Index_Historical_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/real-world-assets/map": { "get": { "summary": "RWA ID Map", "operationId": "getV5RealWorldAssetsMap", "description": "Returns a mapping of all Real-World Asset (RWA) assets to their unique `rwa_id`. Use this lightweight lookup to resolve the correct `rwa_id` (the stable identifier we recommend over symbols/tickers) before calling the heavier info, asset-list, market-pairs, or historical endpoints. No market data is returned here.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 30 seconds. \n**Plan credit use:** No credit is needed when querying this endpoint. ", "parameters": [ { "description": "Optionally filter by asset type. One of `stock`, `commodity`, `currency`, `government_security`, `etf`, `real_estate`.", "name": "asset_type", "in": "query", "schema": { "type": "string", "enum": [ "stock", "commodity", "currency", "government_security", "etf", "real_estate" ] } }, { "description": "Optionally pass a comma-separated list of RWA asset symbols / tickers to return IDs for. If passed, other filter options are ignored. Example: `NVDA,GOLD`.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "NVDA,GOLD" } }, { "description": "Optionally specify the field used to sort the list. Options: `rwa_id`, `rwa_rank`, `name`.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "rwa_id", "rwa_rank", "name" ], "default": "rwa_id" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } } ], "tags": [ "Real World Assets" ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RWA_ID_Map_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/real-world-assets/info": { "get": { "summary": "Metadata", "operationId": "getV5RealWorldAssetsInfo", "description": "Returns static metadata for one or more Real-World Asset (RWA) assets: nominal/company fields plus an About block (description, logo, website). Mirrors `/v2/cryptocurrency/info`. No market data is returned here — use `/v5/real-world-assets/assets/list` for tokenized quotes. At least one of `rwa_id`, `rwa_slug`, or `symbol` is required, and only one identifier type may be used per request.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 30 seconds. \n**Plan credit use:** 1 call credit per 250 RWA assets returned (rounded up). ", "parameters": [ { "description": "One or more comma-separated RWA asset IDs. Example: `1,2`. At least one of `rwa_id`, `rwa_slug`, or `symbol` is required.", "name": "rwa_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "1,2" } }, { "description": "Alternatively pass RWA asset slugs. Example: `gold,nvidia`.", "name": "rwa_slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "gold,nvidia" } }, { "description": "Alternatively pass RWA asset symbols / tickers. Example: `NVDA,GOLD`.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "NVDA,GOLD" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple RWA assets an error is returned if no match is found for one or more requested assets. If set to `true`, invalid lookups will be skipped allowing valid assets to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "string" } } ], "tags": [ "Real World Assets" ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RWA_Info_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/real-world-assets/assets/list": { "get": { "summary": "RWA List", "operationId": "getV5RealWorldAssetsAssetsList", "description": "Returns a paginated list of tracked Real-World Asset (RWA) assets with their tokenized aggregate quotes \u2014 average tokenized price, tokenized market cap, and 24h tokenized volume. Static metadata is **not** returned here \u2014 use `/v5/real-world-assets/info` for that. Mirrors the `/listings` market-data convention. Results default to `rwa_rank` ascending.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 1 minute. \n**Plan credit use:** 1 call credit per 250 RWA assets returned (rounded up), plus 1 credit per `convert`/`convert_id` beyond the first. ", "parameters": [ { "description": "One or more comma-separated RWA asset IDs. Example: `1,2`. Only one identifier type (`rwa_id`, `rwa_slug`, or `symbol`) may be used per request.", "name": "rwa_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "1,2" } }, { "description": "Alternatively pass RWA asset slugs. Example: `nvidia,gold`.", "name": "rwa_slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "nvidia,gold" } }, { "description": "Alternatively pass RWA asset symbols / tickers. Example: `NVDA,GOLD`.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "NVDA,GOLD" } }, { "description": "Optionally filter by asset type. One of `stock`, `commodity`, `currency`, `government_security`, `etf`, `real_estate`.", "name": "asset_type", "in": "query", "schema": { "type": "string", "enum": [ "stock", "commodity", "currency", "government_security", "etf", "real_estate" ] } }, { "description": "Optionally specify the field used to sort the list. Options: `rwa_rank`, `tokenized_market_cap`, `tokenized_volume_24h`, `average_tokenized_price`, `symbol`.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "rwa_rank", "tokenized_market_cap", "tokenized_volume_24h", "average_tokenized_price", "symbol" ], "default": "rwa_rank" } }, { "description": "Optionally specify the sort direction. Options: `asc`, `desc`.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. Each conversion is returned in its own \"quote\" object. This parameter cannot be used when `convert_id` is used.", "name": "convert", "in": "query", "schema": { "type": "string", "example": "USD" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=2781 would replace convert=USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "2781" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple RWA assets an error is returned if no match is found for one or more requested assets. If set to `true`, invalid lookups will be skipped allowing valid assets to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "string" } } ], "tags": [ "Real World Assets" ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RWA_Asset_List_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/real-world-assets/market-pairs/list": { "get": { "summary": "Market Pairs", "operationId": "getV5RealWorldAssetsMarketPairsList", "description": "Lists all active markets CoinMarketCap tracks for a single Real-World Asset (RWA) asset's underlying tokens. Requires exactly one of `rwa_id`, `rwa_slug`, or `symbol`. Mirrors `/v1/cryptocurrency/market-pairs/latest`.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - ~~Basic~~\n - ~~Builder~~\n - ~~Startup~~\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 1 minute. \n**Plan credit use:** 1 call credit per 250 market pairs returned (rounded up), plus 1 credit per `convert`/`convert_id` beyond the first. ", "parameters": [ { "description": "A single RWA asset by `rwa_id`. Example: `2`. Only one identifier type (`rwa_id`, `rwa_slug`, or `symbol`) may be used per request.", "name": "rwa_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+$", "example": "2" } }, { "description": "Alternatively pass the RWA asset slug. Example: `nvidia`.", "name": "rwa_slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+$", "example": "nvidia" } }, { "description": "Alternatively pass the RWA asset symbol / ticker. Example: `NVDA`.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-]+$", "example": "NVDA" } }, { "description": "Optionally specify the field used to sort the market pairs. Options: `volume_24h`, `price`.", "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "volume_24h", "price" ], "default": "volume_24h" } }, { "description": "Optionally specify the sort direction. Options: `asc`, `desc`.", "name": "sort_dir", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. Each conversion is returned in its own \"quote\" object. This parameter cannot be used when `convert_id` is used.", "name": "convert", "in": "query", "schema": { "type": "string", "example": "USD" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=2781 would replace convert=USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "2781" } } ], "tags": [ "Real World Assets" ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RWA_Market_Pairs_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/real-world-assets/quotes/latest": { "get": { "summary": "Quotes Latest", "operationId": "getV5RealWorldAssetsQuotesLatest", "description": "Returns the latest market data for one or more Real-World Asset (RWA) assets: tokenized aggregate values (average tokenized price, market cap, 24h volume), the underlying on-chain tokens with their individual prices, and the TradFi markets where the asset trades. A zoom-in on specific assets by identifier, in contrast to the paginated `/v5/real-world-assets/assets/list`. No static metadata here \u2014 use `/v5/real-world-assets/info`. At least one of `rwa_id`, `rwa_slug`, or `symbol` is required, and only one identifier type may be used per request.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 60 seconds. \n**Plan credit use:** 1 call credit per 250 RWA assets returned (rounded up), plus 1 credit per `convert`/`convert_id` beyond the first. ", "parameters": [ { "description": "One or more comma-separated RWA asset IDs. Example: `1,2`. Only one identifier type (`rwa_id`, `rwa_slug`, or `symbol`) may be used per request.", "name": "rwa_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "1,2" } }, { "description": "Alternatively pass RWA asset slugs. Example: `nvidia,gold`.", "name": "rwa_slug", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-z-]+(?:,[0-9a-z-]+)*$", "example": "nvidia,gold" } }, { "description": "Alternatively pass RWA asset symbols / tickers. Example: `NVDA,GOLD`.", "name": "symbol", "in": "query", "schema": { "type": "string", "pattern": "^[0-9A-Za-z$@\\-,]+(?:,[0-9A-Za-z$@\\-]+)*$", "example": "NVDA,GOLD" } }, { "description": "Optionally calculate market quotes in up to 120 currencies at once by passing a comma-separated list of cryptocurrency or fiat currency symbols. Each additional convert option beyond the first requires an additional call credit. Each conversion is returned in its own \"quote\" object. This parameter cannot be used when `convert_id` is used.", "name": "convert", "in": "query", "schema": { "type": "string", "example": "USD" } }, { "description": "Optionally calculate market quotes by CoinMarketCap ID instead of symbol. This option is identical to `convert` outside of ID format. Ex: convert_id=2781 would replace convert=USD in your query. This parameter cannot be used when `convert` is used.", "name": "convert_id", "in": "query", "schema": { "type": "string", "pattern": "^\\d+(?:,\\d+)*$", "example": "2781" } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple RWA assets an error is returned if no match is found for one or more requested assets. If set to `true`, invalid lookups will be skipped allowing valid assets to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "string" } } ], "tags": [ "Real World Assets" ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RWA_Quotes_Latest_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/real-world-assets/issuers/list": { "get": { "summary": "Issuers List", "operationId": "getV5RealWorldAssetsIssuersList", "description": "Returns a paginated list of all token issuers CoinMarketCap tracks for RWA assets (e.g. Backed Assets, bStocks, Backpack), each with a count of linked tokens but not the tokens themselves. To retrieve a single issuer with its linked tokens, use `/v5/real-world-assets/issuers` (Issuer). Mirrors the `/v1/cryptocurrency/categories` (list) vs `/v1/cryptocurrency/category` (single) split.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 30 seconds. \n**Plan credit use:** 1 call credit per request, no matter the query size. ", "parameters": [ { "description": "Optionally filter to one or more comma-separated issuer IDs (24-char hex). Example: `6a2d54b697c45356b1a634f4`.", "name": "issuer_id", "in": "query", "schema": { "type": "string", "pattern": "^[0-9a-f]{24}(?:,[0-9a-f]{24})*$", "example": "6a2d54b697c45356b1a634f4" } }, { "description": "Optionally filter by active status. Omit to return all issuers.", "name": "active", "in": "query", "schema": { "type": "boolean" } }, { "description": "Optionally offset the start (1-based index) of the paginated list of items to return.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the number of results to return. Use this parameter and the \"start\" parameter to determine your own pagination size.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } }, { "description": "Pass `true` to relax request validation rules. When requesting records on multiple RWA assets an error is returned if no match is found for one or more requested assets. If set to `true`, invalid lookups will be skipped allowing valid assets to still be returned.", "name": "skip_invalid", "in": "query", "schema": { "type": "string" } } ], "tags": [ "Real World Assets" ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RWA_Issuers_List_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } }, "/v5/real-world-assets/issuers": { "get": { "summary": "Issuer", "operationId": "getV5RealWorldAssetsIssuers", "description": "Returns a single issuer with its full list of linked tokens (the cryptos issued by that issuer, each tied to an RWA asset). Requires a single `issuer_id`, which you can obtain from `/v5/real-world-assets/issuers/list` (Issuers List). Mirrors `/v1/cryptocurrency/category`, which returns one category with its nested coins.\n\n **This endpoint is available on the following [API plans](https://coinmarketcap.com/api/pricing/):**\n - Basic\n - Builder\n - Startup\n - Growth\n - Professional\n - Enterprise\n\n**Cache / Update frequency:** Every 30 seconds. \n**Plan credit use:** 1 call credit per request, no matter the query size. ", "parameters": [ { "description": "A single issuer ID (24-char hex). Example: `6a2d54b697c45356b1a634f4`. Obtain it from `/v5/real-world-assets/issuers/list`.", "name": "issuer_id", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{24}$", "example": "6a2d54b697c45356b1a634f4" } }, { "description": "Optionally offset the start (1-based index) into the linked-tokens list.", "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "description": "Optionally specify the page size for the linked-tokens list. Default 100, max 250.", "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 100 } } ], "tags": [ "Real World Assets" ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RWA_Issuer_-_Response_Model" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_400_Error_Object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_401_Error_Object" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_403_Error_Object" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_429_Error_Object" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTP_Status_500_Error_Object" } } } } } } } }, "servers": [ { "url": "https://pro-api.coinmarketcap.com" } ], "components": { "requestBodies": { "DqueryMarketRequestDTO": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DqueryMarketRequestDTO" } } }, "required": true } }, "schemas": { "V1_DEX_Holders_Trend_List_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HolderTrendVO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Platform_List_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PlatformDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Security_Detail_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TokenSecurityResponseDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Token_Liquidity_Query_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TokenLiquiditySnapshotDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Token_Pools_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TokenTopPoolDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Token_Price_Batch_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TokenPriceDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Tokens_Batch_Query_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TokenDetailDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_K_Line_Candles_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "type": [ "number", "null" ] } } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_K_Line_Points_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V3_Cryptocurrency_Quotes_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CryptoQuoteV3DTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Listings_Info_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DexCommonInfoDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Listings_Quotes_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DexInfoDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Networks_List_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkInfoDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Pairs_Ohlcv_Historical_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DexPairsOhlcvHistoricalDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Pairs_Ohlcv_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DexPairsOhlcvDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Pairs_Quotes_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DexParisQuotesDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Pairs_Trade_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DexPairsTradeDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V4_DEX_Spot_Pairs_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DexSpotPairDTO" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Gainer_Loser_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GainerLeaderBoardResponseDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Holders_Count_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/HolderCountVO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Holders_Detail_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/HolderDetailVO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Holders_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/HolderDexVO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Holders_Tag_Count_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/HolderTagCountVO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Liquidity_Change_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiquidityChangeListResponseDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Meme_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MemeCoinResponseDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_New_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NewTokenLeaderBoardResponseDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Platform_Detail_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PlatformDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Search_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SearchResponseDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Token_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TokenDetailDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Token_Price_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TokenPriceDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Tokens_Transactions_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwapListResponseDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "V1_DEX_Tokens_Trending_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TrendingTokensResponseDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "CMC_AI_Source_object": { "type": "object", "description": "A canonical source URL for an insight. The only field on a source object.", "properties": { "url": { "type": "string", "description": "Canonical full source URL. Tracking params are stripped; `twitter.com` is normalised to `x.com`.", "example": "https://coinmarketcap.com/currencies/bitcoin/" } }, "required": ["url"] }, "CMC_AI_Answer_object": { "type": "object", "description": "Two-section markdown answer, split from the stored blob using the same TLDR detection as the CoinMarketCap front end. No other edits are applied.", "properties": { "tldr": { "type": "string", "description": "TLDR section as markdown, returned as the model produced it." }, "body": { "type": "string", "description": "Everything after the TLDR (Deep Dive, Conclusion) as markdown, as the model produced it." } }, "required": ["tldr", "body"] }, "CMC_AI_Insight_object": { "type": "object", "description": "A single CMC AI insight: a fixed question, a trending question, or a top-news headline, plus its generated answer and sources.", "properties": { "type": { "type": "string", "enum": ["fixed_question", "trending_question", "top_news"], "description": "Insight type. One of `fixed_question`, `trending_question`, `top_news`. Never empty.", "example": "fixed_question" }, "title": { "type": "string", "description": "Display text: the question for `fixed_question`, the headline for `trending_question` and `top_news`. Never empty.", "example": "What are the trending narratives?" }, "answer_id": { "type": "string", "description": "24-character hex id for this generated answer. Changes on regeneration, so a caller can detect content that needs re-translation. For `trending_question` and `top_news` it is also the item id. Never empty.", "example": "6a82d003e66d8e4bf5368dcf" }, "question_key": { "type": ["string", "null"], "enum": [ "price_up", "price_down", "future_price", "sentiment", "latest_news", "overview", "roadmap", "codebase", "altcoin_performance", "trending_narratives", "bullish_momentum", "upcoming_events", "market_sentiment", "kol_discussion", null ], "description": "Stable semantic key for the question template. Set for `fixed_question`, `null` for `trending_question` and `top_news`. Market-level keys (on `/v5/cmc-ai/latest`): `altcoin_performance`, `trending_narratives`, `bullish_momentum`, `upcoming_events`, `market_sentiment`, `kol_discussion`. Coin-level keys (on `/v5/cmc-ai/coins/latest`): `price_up`, `price_down`, `future_price`, `sentiment`, `latest_news`, `overview`, `roadmap`, `codebase`. `price_up` and `price_down` are mutually exclusive.", "example": "trending_narratives" }, "answer": { "$ref": "#/components/schemas/CMC_AI_Answer_object" }, "sources": { "type": "array", "description": "Source references, capped by `sources_limit`. May be empty.", "items": { "$ref": "#/components/schemas/CMC_AI_Source_object" } }, "sources_count": { "type": "integer", "description": "True total sources for this insight, before `sources_limit` is applied.", "example": 91 }, "sources_truncated": { "type": "boolean", "description": "`true` if `sources[]` has fewer entries than `sources_count`.", "example": true }, "generated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 UTC time the answer was generated. Never empty.", "example": "2026-08-17T09:11:37Z" } }, "required": [ "type", "title", "answer_id", "question_key", "answer", "sources", "sources_count", "sources_truncated", "generated_at" ] }, "CMC_AI_Coin_object": { "type": "object", "description": "One requested cryptocurrency and its current CMC AI insights.", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap cryptocurrency ID.", "example": 1 }, "name": { "type": "string", "description": "Cryptocurrency name.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "Cryptocurrency symbol.", "example": "BTC" }, "slug": { "type": "string", "description": "URL-friendly lowercase slug.", "example": "bitcoin" }, "insights": { "type": "array", "description": "Insight objects for this cryptocurrency. Empty when the coin is covered but no content has been generated yet.", "items": { "$ref": "#/components/schemas/CMC_AI_Insight_object" } } }, "required": ["crypto_id", "name", "symbol", "slug", "insights"] }, "CMC_AI_Coverage_Coin_object": { "type": "object", "description": "A cryptocurrency currently in the CMC AI coverage set, without answer bodies.", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap cryptocurrency ID. Integer, not a string.", "example": 1 }, "name": { "type": "string", "description": "Cryptocurrency name.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "Cryptocurrency symbol.", "example": "BTC" }, "slug": { "type": "string", "description": "URL-friendly lowercase slug.", "example": "bitcoin" }, "url": { "type": "string", "description": "Coin Detail Page URL.", "example": "https://coinmarketcap.com/currencies/bitcoin/" }, "available_question_keys": { "type": "array", "description": "Fixed-question keys that currently have content for this cryptocurrency. May be empty.", "items": { "type": "string", "enum": [ "price_up", "price_down", "future_price", "sentiment", "latest_news", "overview", "roadmap", "codebase" ] }, "example": ["price_up", "future_price", "overview"] }, "num_insights": { "type": "integer", "description": "Insights currently available for this cryptocurrency, across all types.", "example": 8 }, "last_generated_at": { "type": ["string", "null"], "format": "date-time", "description": "ISO 8601 UTC time of the most recent generation. `null` if nothing has been generated yet.", "example": "2026-08-17T09:14:14Z" } }, "required": [ "crypto_id", "name", "symbol", "slug", "url", "available_question_keys", "num_insights", "last_generated_at" ] }, "CMC_AI_Latest_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "insights": [ { "type": "fixed_question", "title": "What are the trending narratives?", "answer_id": "6a82d003e66d8e4bf5368dcf", "question_key": "trending_narratives", "answer": { "tldr": "## TLDR\nAI, RWA, and ETF-flow narratives are leading attention this session, while meme-coin volume has cooled.", "body": "## Deep Dive\nBitcoin dominance is steady and sector rotation is concentrated in a handful of large-cap themes.\n\n## Conclusion\nWatch BTC dominance and spot-ETF flows into the next session." }, "sources": [ { "url": "https://coinmarketcap.com/trending-cryptocurrencies/" }, { "url": "https://x.com/coinmarketcap" } ], "sources_count": 91, "sources_truncated": true, "generated_at": "2026-08-17T09:11:37Z" }, { "type": "top_news", "title": "BTC stuck near $63K as US spot ETFs see $390M outflows", "answer_id": "6a829ec8e210dd5a1b8f0570", "question_key": null, "answer": { "tldr": "## TLDR\nUS spot Bitcoin ETFs posted another session of net outflows, keeping BTC range-bound.", "body": "## Deep Dive\nSpot-ETF flow is the near-term driver. A return to net inflows would be the first sign the range is breaking.\n\n## Conclusion\nPrice is waiting on flow, not a new macro catalyst." }, "sources": [{ "url": "https://cryptopotato.com/btc-etf-outflows-august" }], "sources_count": 27, "sources_truncated": true, "generated_at": "2026-08-17T05:40:24Z" } ], "total_size": 26, "has_more": true }, "properties": { "insights": { "type": "array", "description": "Insight objects. Never a bare array at `data`.", "items": { "$ref": "#/components/schemas/CMC_AI_Insight_object" } }, "total_size": { "type": "integer", "description": "Total matching insights across all pages. Placed after the `insights[]` array.", "example": 26 }, "has_more": { "type": "boolean", "description": "`true` if more insights exist beyond this page, else `false`. Placed after the `insights[]` array.", "example": true } } }, "CMC_AI_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CMC_AI_Latest_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "CMC_AI_Coins_Latest_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "coins": [ { "crypto_id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "insights": [ { "type": "fixed_question", "title": "Why is BTC's price up today?", "answer_id": "6a82d0abe24562528cd3f6ac", "question_key": "price_up", "answer": { "tldr": "## TLDR\nBitcoin bounced as US spot-ETF outflows slowed and funding rates reset closer to neutral.", "body": "## Deep Dive\nThe move is a relief bounce inside a broader range, not a confirmed trend reversal.\n\n## Conclusion\nHold the range until ETF flows turn sustainably positive." }, "sources": [{ "url": "https://coinmarketcap.com/currencies/bitcoin/" }], "sources_count": 57, "sources_truncated": true, "generated_at": "2026-08-17T09:14:14Z" }, { "type": "fixed_question", "title": "What could affect BTC's future price?", "answer_id": "6a82d11c9c0e4a1bb7e2c401", "question_key": "future_price", "answer": { "tldr": "## TLDR\nETF flows, dollar strength, and miner distribution remain the main forward-looking drivers for Bitcoin.", "body": "## Deep Dive\nA sustained return of spot-ETF inflows would be the cleanest bullish tell. The opposite keeps BTC range-bound.\n\n## Conclusion\nPosition around flow, not a single print." }, "sources": [ { "url": "https://coinmarketcap.com/currencies/bitcoin/" }, { "url": "https://cryptopotato.com/btc-etf-outflows-august" } ], "sources_count": 34, "sources_truncated": true, "generated_at": "2026-08-17T08:02:11Z" } ] }, { "crypto_id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "insights": [ { "type": "fixed_question", "title": "Why is ETH's price down today?", "answer_id": "6a82d22f0ab14c33a91de802", "question_key": "price_down", "answer": { "tldr": "## TLDR\nEther lagged Bitcoin as ETH ETF flows stayed soft and L2 activity cooled.", "body": "## Deep Dive\nRelative weakness versus BTC is the story more than a standalone ETH shock.\n\n## Conclusion\nETH/BTC is the pair to watch until ETF flow improves." }, "sources": [{ "url": "https://coinmarketcap.com/currencies/ethereum/" }], "sources_count": 22, "sources_truncated": true, "generated_at": "2026-08-17T09:10:03Z" } ] } ], "total_size": 2, "has_more": false }, "properties": { "coins": { "type": "array", "description": "One object per requested cryptocurrency. Never a bare array at `data`.", "items": { "$ref": "#/components/schemas/CMC_AI_Coin_object" } }, "total_size": { "type": "integer", "description": "Total number of matching cryptocurrencies across all pages. Placed after the `coins[]` array.", "example": 2 }, "has_more": { "type": "boolean", "description": "`true` if more cryptocurrencies exist beyond this page, else `false`. Placed after the `coins[]` array.", "example": false } } }, "CMC_AI_Coins_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CMC_AI_Coins_Latest_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "CMC_AI_Coins_Map_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "coins": [ { "crypto_id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "url": "https://coinmarketcap.com/currencies/bitcoin/", "available_question_keys": [ "price_up", "future_price", "latest_news", "overview", "roadmap", "codebase" ], "num_insights": 8, "last_generated_at": "2026-08-17T09:14:14Z" }, { "crypto_id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "url": "https://coinmarketcap.com/currencies/ethereum/", "available_question_keys": [ "price_down", "future_price", "sentiment", "overview", "roadmap" ], "num_insights": 6, "last_generated_at": "2026-08-17T09:10:03Z" }, { "crypto_id": 825, "name": "Tether USDt", "symbol": "USDT", "slug": "tether", "url": "https://coinmarketcap.com/currencies/tether/", "available_question_keys": ["overview", "latest_news"], "num_insights": 3, "last_generated_at": "2026-08-16T21:04:00Z" } ], "total_size": 100, "has_more": true }, "properties": { "coins": { "type": "array", "description": "Supported cryptocurrencies. Never a bare array at `data`.", "items": { "$ref": "#/components/schemas/CMC_AI_Coverage_Coin_object" } }, "total_size": { "type": "integer", "description": "Total supported cryptocurrencies across all pages. Placed after the `coins[]` array.", "example": 100 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`. Placed after the `coins[]` array.", "example": true } } }, "CMC_AI_Coins_Map_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CMC_AI_Coins_Map_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "V2_Simple_Price_-_Item_Object": { "type": "object", "description": "Latest-price entry for a single cryptocurrency.", "properties": { "id": { "type": "integer", "description": "CoinMarketCap cryptocurrency ID.", "example": 1 }, "name": { "type": "string", "description": "Cryptocurrency name.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "Cryptocurrency symbol.", "example": "BTC" }, "slug": { "type": "string", "description": "Cryptocurrency slug.", "example": "bitcoin" }, "quotes": { "type": "array", "description": "One quote object per `convert` / `convert_id` currency requested.", "items": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Convert currency symbol (e.g. `USD`).", "example": "USD" }, "price": { "type": "number", "description": "Latest price in the convert currency.", "example": 63319.879266088545 }, "market_cap": { "type": "number", "description": "Market cap in the convert currency. Present only when `include_market_cap` (or `include_all`) is true." }, "volume_24h": { "type": "number", "description": "24-hour trading volume in the convert currency. Present only when `include_24h_volume` (or `include_all`) is true." }, "percent_change_24h": { "type": "number", "description": "24-hour price change percentage. Present only when `include_24h_change` (or `include_all`) is true." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the price. Present only when `include_last_updated` (or `include_all`) is true." } }, "required": ["symbol", "price"] } } }, "required": ["id", "name", "symbol", "slug", "quotes"] }, "V2_Simple_Price_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "quotes": [ { "symbol": "USD", "price": 63319.879266088545, "market_cap": 1270345579794.01152078075, "volume_24h": 23424304928.73598862, "percent_change_24h": -3.03610139, "last_updated": "2026-07-28T10:35:05.000Z" } ] }, { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "quotes": [ { "symbol": "USD", "price": 1875.3832420347037, "market_cap": 226326126225.454083360708918688, "volume_24h": 12578049044.85534477, "percent_change_24h": -4.60239011, "last_updated": "2026-07-28T10:35:05.000Z" } ] } ], "status": { "timestamp": "2026-07-28T10:38:38.654Z", "error_code": "0", "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "type": "array", "description": "Array of asset objects, one per resolved identifier. With `skip_invalid=true`, unresolved identifiers are simply absent.", "items": { "$ref": "#/components/schemas/V2_Simple_Price_-_Item_Object" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Liquidations_Total_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "quotes": [ { "symbol": "USD", "crypto_id": 2781, "total_liquidations_1h": 4615261.2522400250944661, "long_liquidations_1h": 3506917.9880817592591984, "short_liquidations_1h": 1108343.2641582658352677, "total_liquidations_4h": 12888989.407139462247403372, "long_liquidations_4h": 9462596.325027340146461462, "short_liquidations_4h": 3426393.08211212210094191, "total_liquidations_24h": 519760825.611969969550287216, "long_liquidations_24h": 451643104.899617347037904828, "short_liquidations_24h": 68117720.712352622512382388, "last_updated": "2026-07-28T10:36:00.000Z" } ] }, "properties": { "quotes": { "type": "array", "description": "One entry per requested convert currency. Never a bare array at `data`.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID of the convert currency (e.g. `2781` for USD). Always present.", "example": 2781 }, "symbol": { "type": "string", "description": "Symbol of the convert currency (e.g. `USD`). Always present.", "example": "USD" }, "total_liquidations_1h": { "type": "number", "description": "Total notional liquidated in the rolling 1h window, in the convert currency." }, "long_liquidations_1h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 1h window." }, "short_liquidations_1h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 1h window." }, "total_liquidations_4h": { "type": "number", "description": "Total notional liquidated in the rolling 4h window." }, "long_liquidations_4h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 4h window." }, "short_liquidations_4h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 4h window." }, "total_liquidations_24h": { "type": "number", "description": "Total notional liquidated in the rolling 24h window." }, "long_liquidations_24h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 24h window." }, "short_liquidations_24h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 24h window." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the last aggregation for this quote." } } } } } }, "Liquidations_Total_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Liquidations_Total_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Liquidations_By_Exchange_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "exchanges": [ { "name": "Binance", "slug": "binance", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "total_liquidations_1h": 3419396.41473615, "long_liquidations_1h": 2539954.62605147, "short_liquidations_1h": 879441.78868468, "total_liquidations_4h": 8461178.33919474, "long_liquidations_4h": 6216074.5828236, "short_liquidations_4h": 2245103.75637114, "total_liquidations_24h": 237863442.34358634, "long_liquidations_24h": 207991776.57081031, "short_liquidations_24h": 29871665.77277603, "last_updated": "2026-07-28T10:38:00.000Z" } ], "exchange_id": 270 }, { "name": "Hyperliquid", "slug": "hyperliquid", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "total_liquidations_1h": 65760.566551, "long_liquidations_1h": 65708.762741, "short_liquidations_1h": 51.80381, "total_liquidations_4h": 922900.157248, "long_liquidations_4h": 876782.844196, "short_liquidations_4h": 46117.313052, "total_liquidations_24h": 118872754.545678, "long_liquidations_24h": 113352963.292567, "short_liquidations_24h": 5519791.253111, "last_updated": "2026-07-28T10:38:00.000Z" } ], "exchange_id": 8112 }, { "name": "OKX", "slug": "okx", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "total_liquidations_1h": 348581.89193, "long_liquidations_1h": 326089.92823, "short_liquidations_1h": 22491.9637, "total_liquidations_4h": 1335101.94926, "long_liquidations_4h": 970497.7628, "short_liquidations_4h": 364604.18646, "total_liquidations_24h": 62512691.315803, "long_liquidations_24h": 50876917.340933, "short_liquidations_24h": 11635773.97487, "last_updated": "2026-07-28T10:38:00.000Z" } ], "exchange_id": 294 } ], "total_size": 11, "has_more": true }, "properties": { "exchanges": { "type": "array", "description": "One object per exchange, ordered by `sort` / `sort_dir`. Never a bare array at `data`.", "items": { "type": "object", "properties": { "exchange_id": { "type": "integer", "description": "CoinMarketCap exchange ID.", "example": 270 }, "name": { "type": "string", "description": "Exchange name.", "example": "Binance" }, "slug": { "type": "string", "description": "Exchange slug.", "example": "binance" }, "quotes": { "type": "array", "description": "One entry per requested convert currency.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID of the convert currency (e.g. `2781` for USD). Always present.", "example": 2781 }, "symbol": { "type": "string", "description": "Symbol of the convert currency (e.g. `USD`). Always present.", "example": "USD" }, "total_liquidations_1h": { "type": "number", "description": "Total notional liquidated in the rolling 1h window, in the convert currency." }, "long_liquidations_1h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 1h window." }, "short_liquidations_1h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 1h window." }, "total_liquidations_4h": { "type": "number", "description": "Total notional liquidated in the rolling 4h window." }, "long_liquidations_4h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 4h window." }, "short_liquidations_4h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 4h window." }, "total_liquidations_24h": { "type": "number", "description": "Total notional liquidated in the rolling 24h window." }, "long_liquidations_24h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 24h window." }, "short_liquidations_24h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 24h window." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the last aggregation for this quote." } } } } } } }, "total_size": { "type": "integer", "description": "Total number of matching exchanges across all pages. Placed after the `exchanges[]` array.", "example": 11 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`. Placed after the `exchanges[]` array.", "example": true } } }, "Liquidations_By_Exchange_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Liquidations_By_Exchange_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Liquidations_By_Cryptocurrency_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "cryptocurrencies": [ { "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "total_liquidations_1h": 409828.32216, "long_liquidations_1h": 315044.32766, "short_liquidations_1h": 94783.9945, "total_liquidations_4h": 582070.15453, "long_liquidations_4h": 406032.34715, "short_liquidations_4h": 176037.80738, "total_liquidations_24h": 136257955.965934519989936059, "long_liquidations_24h": 121265024.559539519990935935, "short_liquidations_24h": 14992931.406394999999000124, "last_updated": "2026-07-28T10:38:00.000Z" } ], "crypto_id": 1, "cmc_rank": 1 }, { "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "total_liquidations_1h": 1024702.245710000008, "long_liquidations_1h": 885316.525600000008, "short_liquidations_1h": 139385.72011, "total_liquidations_4h": 1195480.6141800000079999, "long_liquidations_4h": 970511.8973900000079999, "short_liquidations_4h": 224968.71679, "total_liquidations_24h": 85919188.884457811890433347, "long_liquidations_24h": 65191933.694747812033511053, "short_liquidations_24h": 20727255.189709999856922294, "last_updated": "2026-07-28T10:38:00.000Z" } ], "crypto_id": 1027, "cmc_rank": 2 } ], "total_size": 805, "has_more": true }, "properties": { "cryptocurrencies": { "type": "array", "description": "One object per cryptocurrency, ordered by `sort` / `sort_dir`. Never a bare array at `data`.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap cryptocurrency ID.", "example": 1 }, "name": { "type": "string", "description": "Cryptocurrency name.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "Cryptocurrency symbol.", "example": "BTC" }, "slug": { "type": "string", "description": "Cryptocurrency slug.", "example": "bitcoin" }, "cmc_rank": { "type": "integer", "description": "The coin's CoinMarketCap market-cap rank.", "example": 1 }, "quotes": { "type": "array", "description": "One entry per requested convert currency.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID of the convert currency (e.g. `2781` for USD). Always present.", "example": 2781 }, "symbol": { "type": "string", "description": "Symbol of the convert currency (e.g. `USD`). Always present.", "example": "USD" }, "total_liquidations_1h": { "type": "number", "description": "Total notional liquidated in the rolling 1h window, in the convert currency." }, "long_liquidations_1h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 1h window." }, "short_liquidations_1h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 1h window." }, "total_liquidations_4h": { "type": "number", "description": "Total notional liquidated in the rolling 4h window." }, "long_liquidations_4h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 4h window." }, "short_liquidations_4h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 4h window." }, "total_liquidations_24h": { "type": "number", "description": "Total notional liquidated in the rolling 24h window." }, "long_liquidations_24h": { "type": "number", "description": "Longs liquidated (forced sells) in the rolling 24h window." }, "short_liquidations_24h": { "type": "number", "description": "Shorts liquidated (forced buys) in the rolling 24h window." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the last aggregation for this quote." } } } } } } }, "total_size": { "type": "integer", "description": "Total number of matching cryptocurrencies across all pages. Placed after the `cryptocurrencies[]` array.", "example": 805 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`. Placed after the `cryptocurrencies[]` array.", "example": true } } }, "Liquidations_By_Cryptocurrency_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Liquidations_By_Cryptocurrency_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "RWA_ID_Map_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "rwa_assets": [ { "name": "Gold", "symbol": "GOLD", "slug": "gold", "rwa_id": 1, "asset_type": "commodity", "rwa_rank": 1, "has_tokens": true, "first_historical_data": "2009-09-27T00:00:00.000Z", "last_historical_data": "2026-07-08T10:29:00.000Z" }, { "name": "Nvidia Corp", "symbol": "NVDA", "slug": "nvidia", "rwa_id": 2, "asset_type": "stock", "rwa_rank": 2, "has_tokens": true, "first_historical_data": "2003-09-07T04:00:00.000Z", "last_historical_data": "2026-07-08T10:29:00.000Z" } ], "total_size": 7805, "has_more": true }, "properties": { "rwa_assets": { "type": "array", "description": "Array of RWA asset map objects, sorted per the `sort` parameter.", "items": { "type": "object", "properties": { "rwa_id": { "type": "integer", "description": "RWA asset ID; the stable identifier to use across the RWA family.", "example": 2 }, "name": { "type": "string", "description": "Asset display name.", "example": "Nvidia Corp" }, "symbol": { "type": "string", "description": "Asset symbol / ticker.", "example": "NVDA" }, "slug": { "type": "string", "description": "URL-friendly lowercase slug.", "example": "nvidia" }, "asset_type": { "type": "string", "enum": [ "stock", "commodity", "currency", "government_security", "etf", "real_estate" ], "description": "Asset type. One of `stock`, `commodity`, `currency`, `government_security`, `etf`, `real_estate`.", "example": "stock" }, "rwa_rank": { "type": "integer", "description": "RWA market-cap rank (1 = highest). RWA-specific ranking, distinct from `cmc_rank`.", "example": 2 }, "has_tokens": { "type": "boolean", "description": "`true` if at least one token exists for this asset; `false` if there are no tokenized assets.", "example": true }, "first_historical_data": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO 8601 timestamp of the earliest historical data point available; `null` if none.", "example": "2003-09-07T04:00:00.000Z" }, "last_historical_data": { "type": [ "string", "null" ], "format": "date-time", "description": "ISO 8601 timestamp of the most recent historical data point available; `null` if none.", "example": "2026-07-08T10:29:00.000Z" } } } }, "total_size": { "type": "integer", "description": "Total number of matching records across all pages.", "example": 7805 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`.", "example": true } } }, "RWA_ID_Map_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RWA_ID_Map_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "RWA_Info_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "rwa_assets": [ { "name": "Gold", "symbol": "GOLD", "slug": "gold", "website": null, "employees": null, "founded": null, "industry": null, "cik": null, "about": { "description": "Gold is a physical commodity and monetary metal that has served as a store of value for thousands of years, widely regarded as a safe-haven asset that retains purchasing power during inflation and financial instability.", "logo": null, "website": null, "date_added": "2025-07-17T06:57:15.000Z" }, "rwa_id": 1, "asset_type": "commodity", "rwa_rank": 1, "has_tokens": true, "primary_exchange": null }, { "name": "Nvidia Corp", "symbol": "NVDA", "slug": "nvidia", "website": "https://www.nvidia.com", "employees": 36000, "founded": "1993-04-04", "industry": "Semiconductors & Related Devices", "cik": "0001045810", "about": { "description": "NVIDIA is a U.S.-based semiconductor and computing company specializing in GPUs, AI hardware, and high-performance computing.", "logo": null, "website": "https://www.nvidia.com", "date_added": "2025-07-17T06:35:44.000Z" }, "rwa_id": 2, "asset_type": "stock", "rwa_rank": 2, "has_tokens": true, "primary_exchange": "Nasdaq" } ] }, "properties": { "rwa_assets": { "type": "array", "description": "Array of static-metadata objects, one per requested RWA asset.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Asset display name.", "example": "Nvidia Corp" }, "symbol": { "type": "string", "description": "Asset symbol / ticker.", "example": "NVDA" }, "slug": { "type": "string", "description": "URL-friendly lowercase slug.", "example": "nvidia" }, "website": { "type": [ "string", "null" ], "description": "Company website. `null` for non-equity types (`commodity` / `currency` / `government_security` / `real_estate`).", "example": "https://www.nvidia.com" }, "employees": { "type": [ "integer", "null" ], "description": "Employee count. `null` for non-equity types (unknown is `null`, not `0`).", "example": 36000 }, "founded": { "type": [ "string", "null" ], "description": "Founding date (ISO 8601 date). `null` for non-equity types.", "example": "1993-04-04" }, "industry": { "type": [ "string", "null" ], "description": "Industry classification. `null` for non-equity types.", "example": "Semiconductors & Related Devices" }, "cik": { "type": [ "string", "null" ], "description": "SEC CIK number. `null` for non-equity / non-US assets.", "example": "0001045810" }, "about": { "type": "object", "description": "About block (descriptive static metadata).", "properties": { "description": { "type": [ "string", "null" ], "description": "Asset description (may contain Markdown).", "example": "NVIDIA is a U.S.-based semiconductor and computing company specializing in GPUs, AI hardware, and high-performance computing." }, "logo": { "type": [ "string", "null" ], "description": "Single small-size logo URL; `null` when absent." }, "website": { "type": [ "string", "null" ], "description": "Official asset/company website URL. `null` when absent.", "example": "https://www.nvidia.com" }, "date_added": { "type": "string", "format": "date-time", "description": "ISO 8601 date the asset was added to CoinMarketCap.", "example": "2025-07-17T06:35:44.000Z" } } }, "rwa_id": { "type": "integer", "description": "RWA asset ID; distinct namespace from `crypto_id`.", "example": 2 }, "asset_type": { "type": "string", "enum": [ "stock", "commodity", "currency", "government_security", "etf", "real_estate" ], "description": "Asset type. One of `stock`, `commodity`, `currency`, `government_security`, `etf`, `real_estate`. Drives nominal-field nullability above.", "example": "stock" }, "rwa_rank": { "type": "integer", "description": "RWA market-cap rank (1 = highest). RWA-specific ranking, distinct from `cmc_rank`.", "example": 2 }, "has_tokens": { "type": "boolean", "description": "`true` if at least one token exists for this asset; `false` if there are no tokenized assets.", "example": true }, "primary_exchange": { "type": [ "string", "null" ], "description": "Primary listing exchange (e.g. `Nasdaq`). `null` for non-equity types.", "example": "Nasdaq" } } } } } }, "RWA_Info_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RWA_Info_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "RWA_Issuers_List_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "issuers": [ { "name": "Backed Assets", "website": "https://assets.backed.fi/", "logo": null, "issuer_id": "6878977dcbbf471de3366e85", "num_tokens": 147 }, { "name": "Backpack", "website": "https://backpack.exchange", "logo": "https://s2.coinmarketcap.com/static/img/issuer/M7sS2GzR_400x400.png", "issuer_id": "6a2d54b697c45356b1a634f4", "num_tokens": 1 }, { "name": "Bitget Assets", "website": "https://www.bitget.com/", "logo": null, "issuer_id": "68a80be20135f56ec3188cdc", "num_tokens": 0 } ], "total_size": 24, "has_more": true }, "properties": { "issuers": { "type": "array", "description": "Array of issuer objects.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Issuer display name (e.g. `Backpack`).", "example": "Backpack" }, "website": { "type": [ "string", "null" ], "description": "Issuer website; `null` when absent.", "example": "https://backpack.exchange" }, "logo": { "type": [ "string", "null" ], "description": "Single small-size logo URL; `null` when the issuer has no logo.", "example": "https://s2.coinmarketcap.com/static/img/issuer/M7sS2GzR_400x400.png" }, "issuer_id": { "type": "string", "description": "Issuer ID (24-char hex), the stable identifier for issuer lookups.", "example": "6a2d54b697c45356b1a634f4" }, "num_tokens": { "type": "integer", "description": "Number of linked tokens (cryptos) for this issuer; may be `0`.", "example": 1 } } } }, "total_size": { "type": "integer", "description": "Total number of matching records across all pages.", "example": 24 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`.", "example": true } } }, "RWA_Issuers_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RWA_Issuers_List_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "RWA_Issuer_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "name": "Backpack", "website": "https://backpack.exchange", "logo": "https://s2.coinmarketcap.com/static/img/issuer/M7sS2GzR_400x400.png", "tokens": [ { "name": "SpaceX tokenized stock (Backpack)", "symbol": "SPCX", "crypto_id": 40238, "rwa_id": 9 } ], "issuer_id": "6a2d54b697c45356b1a634f4", "num_tokens": 1, "total_size": 1, "has_more": false }, "properties": { "name": { "type": "string", "description": "Issuer display name.", "example": "Backpack" }, "website": { "type": [ "string", "null" ], "description": "Issuer website; `null` when absent.", "example": "https://backpack.exchange" }, "logo": { "type": [ "string", "null" ], "description": "Single small-size logo URL; `null` when the issuer has no logo.", "example": "https://s2.coinmarketcap.com/static/img/issuer/M7sS2GzR_400x400.png" }, "tokens": { "type": "array", "description": "Tokens issued by this issuer.", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Token name (e.g. `SpaceX tokenized stock (Backpack)`).", "example": "SpaceX tokenized stock (Backpack)" }, "symbol": { "type": "string", "description": "Token symbol (e.g. `SPCX`).", "example": "SPCX" }, "crypto_id": { "type": "integer", "description": "CoinMarketCap cryptocurrency ID of the token.", "example": 40238 }, "rwa_id": { "type": [ "integer", "null" ], "description": "The RWA asset this token represents; `null` if not yet mapped to an RWA asset.", "example": 9 } } } }, "issuer_id": { "type": "string", "description": "Issuer ID (24-char hex).", "example": "6a2d54b697c45356b1a634f4" }, "num_tokens": { "type": "integer", "description": "Total linked tokens for this issuer.", "example": 1 }, "total_size": { "type": "integer", "description": "Total number of matching records across all pages.", "example": 1 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`.", "example": false } } }, "RWA_Issuer_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RWA_Issuer_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "RWA_Asset_List_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "total_size": 2, "has_more": false, "rwa_assets": [ { "name": "GOLD", "symbol": "GOLD", "slug": "gold", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "average_tokenized_price": 4018.181479970762, "tokenized_market_cap": 1884879975.1722481, "tokenized_volume_24h": 139285845.12748477, "last_updated": "2026-07-15T10:45:05.000Z" } ], "rwa_id": 1, "asset_type": "commodity", "rwa_rank": 1, "has_tokens": true, "average_tokenized_price": 4018.181479970762, "tokenized_market_cap": 1884879975.1722481, "tokenized_volume_24h": 139285845.12748477, "last_updated": "2026-07-15T10:13:26.000Z" }, { "name": "NVIDIA", "symbol": "NVDA", "slug": "nvidia", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "average_tokenized_price": 211.04769840665475, "tokenized_market_cap": 3726091.2870977107, "tokenized_volume_24h": 7654132.31153204, "last_updated": "2026-07-15T10:45:05.000Z" } ], "rwa_id": 2, "asset_type": "stock", "rwa_rank": 2, "has_tokens": true, "average_tokenized_price": 211.04769840665475, "tokenized_market_cap": 3726091.2870977107, "tokenized_volume_24h": 7654132.31153204, "last_updated": "2026-07-15T10:13:26.000Z" } ] }, "properties": { "rwa_assets": { "type": "array", "description": "Array of RWA asset objects (market data), sorted per the `sort` parameter.", "items": { "type": "object", "properties": { "rwa_id": { "type": [ "integer", "null" ], "description": "RWA asset ID; the stable identifier to use across the RWA family.", "example": 2 }, "name": { "type": "string", "description": "Asset display name.", "example": "NVIDIA" }, "symbol": { "type": "string", "description": "Asset symbol / ticker.", "example": "NVDA" }, "slug": { "type": "string", "description": "URL-friendly lowercase slug.", "example": "nvidia" }, "asset_type": { "type": "string", "enum": [ "stock", "commodity", "currency", "government_security", "etf", "real_estate" ], "description": "Asset type. One of `stock`, `commodity`, `currency`, `government_security`, `etf`, `real_estate`.", "example": "stock" }, "rwa_rank": { "type": "integer", "description": "RWA market-cap rank (1 = highest). RWA-specific ranking, distinct from `cmc_rank`.", "example": 2 }, "has_tokens": { "type": [ "boolean", "null" ], "description": "`true` if at least one token exists for this asset; `false` if there are no tokenized assets.", "example": true }, "average_tokenized_price": { "type": [ "number", "null" ], "description": "Aggregate price across the underlying tokens." }, "tokenized_market_cap": { "type": [ "number", "null" ], "description": "Aggregate tokenized market cap." }, "tokenized_volume_24h": { "type": [ "number", "null" ], "description": "Aggregate 24h tokenized volume." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the market data." }, "quotes": { "type": "array", "description": "Convertible tokenized values; one object per `convert`/`convert_id` currency.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID of the quote currency.", "example": 2781 }, "symbol": { "type": "string", "description": "Symbol of the quote currency.", "example": "USD" }, "average_tokenized_price": { "type": [ "number", "null" ], "description": "Aggregate tokenized price in the converted currency." }, "tokenized_market_cap": { "type": [ "number", "null" ], "description": "Aggregate tokenized market cap in the converted currency." }, "tokenized_volume_24h": { "type": [ "number", "null" ], "description": "Aggregate 24h tokenized volume in the converted currency." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the quote." } } } } } } }, "total_size": { "type": "integer", "description": "Total number of matching records across all pages.", "example": 2 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`.", "example": false } } }, "RWA_Asset_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RWA_Asset_List_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "RWA_Market_Pairs_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "rwa_id": 2, "name": "NVIDIA", "symbol": "NVDA", "num_market_pairs": 1, "market_pairs": [ { "exchange": { "exchange_id": 270, "name": "Binance", "slug": "binance" }, "market_id": 99001, "market_pair": "NVDAX/USDT", "category": "spot", "fee_type": "percentage", "market_pair_base": { "crypto_id": 36992, "symbol": "NVDAX", "exchange_symbol": "NVDAX", "currency_type": "cryptocurrency" }, "market_pair_quotes": { "crypto_id": 825, "symbol": "USDT", "exchange_symbol": "USDT", "currency_type": "cryptocurrency" }, "exchange_reported_quotes": { "price": 211.33, "volume_24h_base": 39290.12, "volume_24h_quote": 8302814.85, "last_updated": "2026-07-15T10:45:05.000Z" }, "quotes": [ { "crypto_id": 2781, "symbol": "USD", "price": 211.33, "volume_24h": 8302814.85, "last_updated": "2026-07-15T10:45:05.000Z" } ] } ], "total_size": 1, "has_more": false }, "properties": { "rwa_id": { "type": "integer", "description": "The RWA asset the market pairs belong to.", "example": 2 }, "name": { "type": "string", "description": "Asset display name.", "example": "NVIDIA" }, "symbol": { "type": "string", "description": "Asset symbol / ticker.", "example": "NVDA" }, "num_market_pairs": { "type": "integer", "description": "Total number of active market pairs for the asset.", "example": 1 }, "market_pairs": { "type": "array", "description": "Array of market pair objects.", "items": { "type": "object", "properties": { "exchange": { "type": "object", "description": "Exchange listing the pair.", "properties": { "exchange_id": { "type": "integer", "description": "CoinMarketCap exchange ID.", "example": 270 }, "name": { "type": "string", "description": "Exchange name.", "example": "Binance" }, "slug": { "type": "string", "description": "Exchange slug.", "example": "binance" } } }, "market_id": { "type": "integer", "description": "CoinMarketCap market (pair) ID.", "example": 99001 }, "market_pair": { "type": "string", "description": "Pair label, e.g. `NVDAX/USDT`.", "example": "NVDAX/USDT" }, "category": { "type": "string", "enum": [ "spot", "derivatives", "otc", "perpetual" ], "description": "Market category. One of `spot`, `derivatives`, `otc`, `perpetual`.", "example": "spot" }, "fee_type": { "type": "string", "enum": [ "percentage", "no-fees", "transactional-mining", "unknown" ], "description": "Fee type. One of `percentage`, `no-fees`, `transactional-mining`, `unknown`.", "example": "percentage" }, "market_pair_base": { "type": "object", "description": "Base side of the pair (the RWA token).", "properties": { "crypto_id": { "type": "integer", "description": "Underlying token's CoinMarketCap cryptocurrency ID.", "example": 36992 }, "symbol": { "type": "string", "description": "Symbol.", "example": "NVDAX" }, "exchange_symbol": { "type": "string", "description": "Symbol as the exchange labels it.", "example": "NVDAX" }, "currency_type": { "type": "string", "enum": [ "cryptocurrency", "fiat" ], "description": "Currency type. One of `cryptocurrency`, `fiat`.", "example": "cryptocurrency" } } }, "market_pair_quotes": { "type": "object", "description": "Quote side of the pair.", "properties": { "crypto_id": { "type": "integer", "description": "Underlying token's CoinMarketCap cryptocurrency ID.", "example": 825 }, "symbol": { "type": "string", "description": "Symbol.", "example": "USDT" }, "exchange_symbol": { "type": "string", "description": "Symbol as the exchange labels it.", "example": "USDT" }, "currency_type": { "type": "string", "enum": [ "cryptocurrency", "fiat" ], "description": "Currency type. One of `cryptocurrency`, `fiat`.", "example": "cryptocurrency" } } }, "exchange_reported_quotes": { "type": "object", "description": "Price and volume as reported directly by the exchange, in the pair's quote currency.", "properties": { "price": { "type": "number", "description": "Reported price.", "example": 211.33 }, "volume_24h_base": { "type": "number", "description": "24h volume in base units." }, "volume_24h_quote": { "type": "number", "description": "24h volume in quote units." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp." } } }, "quotes": { "type": "array", "description": "Converted price/volume; one object per `convert`/`convert_id` currency.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID of the quote currency.", "example": 2781 }, "symbol": { "type": "string", "description": "Symbol of the quote currency.", "example": "USD" }, "price": { "type": "number", "description": "Converted price." }, "volume_24h": { "type": "number", "description": "Converted 24h volume." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp." } } } } } } }, "total_size": { "type": "integer", "description": "Total number of matching records across all pages.", "example": 1 }, "has_more": { "type": "boolean", "description": "`true` if more records exist beyond this page, else `false`.", "example": false } } }, "RWA_Market_Pairs_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RWA_Market_Pairs_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "RWA_Quotes_Latest_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "rwa_assets": [ { "name": "Nvidia Corp", "symbol": "NVDA", "slug": "nvidia", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "average_tokenized_price": 226.459999255491204191, "tokenized_market_cap": 117414402.193941973375520016, "tokenized_volume_24h": 79320399.19936948, "last_updated": "2026-09-09T06:49:59.000Z" } ], "rwa_id": 2, "asset_type": "stock", "rwa_rank": 2, "has_tokens": true, "average_tokenized_price": 226.459999255491204191, "tokenized_market_cap": 117414402.193941973375520016, "tokenized_volume_24h": 79320399.19936948, "last_updated": "2026-09-09T06:50:33.594Z", "tokens": [ { "symbol": "NVDAX", "name": "NVIDIA tokenized stock (xStock)", "price": 226.33422377299925, "crypto_id": 36992, "issuer_id": "6878977dcbbf471de3366e85", "issuer_name": "Backed Assets", "market_cap": 39526066.25, "volume_24h": 12187859.2729597 }, { "symbol": "NVDAon", "name": "NVIDIA Tokenized Stock (Ondo)", "price": 226.5005458510576, "crypto_id": 38093, "issuer_id": "688ca4ccabae9b5b9fb3167a", "issuer_name": "Ondo Assets", "market_cap": 38222994.66, "volume_24h": 2634471.69806766 } ], "tradfi_markets": [ { "exchange": { "slug": "binance", "name": "Binance", "exchange_id": 270 }, "ticker": "NVDA", "market_url": "https://www.binance.com/en/stocks/EQ_NVDA" } ] }, { "name": "Gold", "symbol": "GOLD", "slug": "gold", "quotes": [ { "symbol": "USD", "crypto_id": 2781, "average_tokenized_price": 4399.672364252195913131, "tokenized_market_cap": 4691165858.450071484044012662, "tokenized_volume_24h": 386677568.73581181, "last_updated": "2026-09-09T06:49:59.000Z" } ], "rwa_id": 1, "asset_type": "commodity", "rwa_rank": 1, "has_tokens": true, "average_tokenized_price": 4399.672364252195913131, "tokenized_market_cap": 4691165858.450071484044012662, "tokenized_volume_24h": 386677568.73581181, "last_updated": "2026-09-09T06:50:32.066Z", "tokens": [ { "symbol": "PAXG", "name": "PAX Gold", "price": 4404.158250158926, "crypto_id": 4705, "issuer_id": "68904c24abae9b5b9fb35815", "issuer_name": "Paxos", "market_cap": 1904813029.99, "volume_24h": 183784699.06453583 }, { "symbol": "XAUt", "name": "Tether Gold", "price": 4399.163220342952, "crypto_id": 5176, "issuer_id": "68904e9cabae9b5b9fb358ac", "issuer_name": "Tether Holdings", "market_cap": 2695911303.57, "volume_24h": 201510910.10671782 } ], "tradfi_markets": [] } ] }, "properties": { "rwa_assets": { "type": "array", "description": "Array of RWA asset objects (latest market data), one per requested asset.", "items": { "type": "object", "properties": { "rwa_id": { "type": "integer", "description": "RWA asset ID; the stable identifier to use across the RWA family.", "example": 2 }, "name": { "type": "string", "description": "Asset display name.", "example": "NVIDIA" }, "symbol": { "type": "string", "description": "Asset symbol / ticker.", "example": "NVDA" }, "slug": { "type": "string", "description": "URL-friendly lowercase slug.", "example": "nvidia" }, "asset_type": { "type": "string", "enum": [ "stock", "commodity", "currency", "government_security", "etf", "real_estate" ], "description": "Asset type. One of `stock`, `commodity`, `currency`, `government_security`, `etf`, `real_estate`.", "example": "stock" }, "rwa_rank": { "type": "integer", "description": "RWA market-cap rank (1 = highest). RWA-specific ranking, distinct from `cmc_rank`.", "example": 2 }, "has_tokens": { "type": "boolean", "description": "`true` if at least one token exists for this asset; `false` if there are no tokenized assets.", "example": true }, "average_tokenized_price": { "type": [ "number", "null" ], "description": "Aggregate price across the underlying tokens." }, "tokenized_market_cap": { "type": [ "number", "null" ], "description": "Aggregate tokenized market cap." }, "tokenized_volume_24h": { "type": [ "number", "null" ], "description": "Aggregate 24h tokenized volume." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the market data." }, "tokens": { "type": "array", "description": "Underlying on-chain tokens representing this asset. May be empty when the asset has no tokenized representation.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap cryptocurrency ID of the token.", "example": 36992 }, "symbol": { "type": [ "string", "null" ], "description": "Token symbol.", "example": "NVDAX" }, "name": { "type": [ "string", "null" ], "description": "Token name.", "example": "NVIDIA tokenized stock (xStock)" }, "issuer_id": { "type": [ "string", "null" ], "description": "Issuer ID (24-char hex); `null` when the token is not linked to a tracked issuer." }, "issuer_name": { "type": [ "string", "null" ], "description": "Token issuer name (e.g. Backed Finance, Paxos); `null` when unknown." }, "price": { "type": [ "number", "null" ], "description": "Token price in USD; `null` when unavailable." }, "market_cap": { "type": [ "number", "null" ], "description": "Token market cap; `null` when unavailable." }, "volume_24h": { "type": [ "number", "null" ], "description": "Token 24h volume; `null` when unavailable." } } } }, "tradfi_markets": { "type": "array", "description": "Crypto exchanges where the tokenized asset trades. May be empty if no tracked market exists for this asset.", "items": { "type": "object", "properties": { "exchange": { "type": "object", "description": "Exchange listing the market.", "properties": { "exchange_id": { "type": "integer", "description": "CoinMarketCap exchange ID.", "example": 270 }, "name": { "type": "string", "description": "Exchange name.", "example": "Binance" }, "slug": { "type": "string", "description": "Exchange slug.", "example": "binance" } } }, "ticker": { "type": "string", "description": "The ticker as listed on that exchange.", "example": "NVDA" }, "market_url": { "type": "string", "description": "Direct link to the market/trading page on the exchange.", "example": "https://www.binance.com/en/stocks/EQ_NVDA" } } } }, "quotes": { "type": "array", "description": "Convertible tokenized values; one object per `convert`/`convert_id` currency.", "items": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID of the quote currency.", "example": 2781 }, "symbol": { "type": "string", "description": "Symbol of the quote currency.", "example": "USD" }, "average_tokenized_price": { "type": "number", "description": "Aggregate tokenized price in the converted currency." }, "tokenized_market_cap": { "type": "number", "description": "Aggregate tokenized market cap in the converted currency." }, "tokenized_volume_24h": { "type": "number", "description": "Aggregate 24h tokenized volume in the converted currency." }, "last_updated": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp of the quote." } } } } } } } } }, "RWA_Quotes_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RWA_Quotes_Latest_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": [ "data" ] }, "assets_array": { "type": "array", "items": { "$ref": "#/components/schemas/assets" } }, "assets": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" } }, "required": ["id", "name", "symbol", "slug"] }, "status": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Current ISO 8601 timestamp on the server.", "example": "2018-06-02T22:51:28.209Z" }, "error_code": { "type": "integer", "description": "An internal error code for the current error. If a unique platform error code is not available the HTTP status code is returned.", "example": 400, "default": 400 }, "error_message": { "type": "string", "description": "An error message to go along with the error code.", "example": "Invalid value for \\\"id\\\"" }, "elapsed": { "type": "integer", "description": "Number of milliseconds taken to generate this response", "example": 10 }, "credit_count": { "type": "integer", "description": "Number of API call credits required for this call. Always 0 for errors.", "example": 0 } }, "required": ["timestamp", "error_code", "error_message", "elapsed", "credit_count"] }, "coin": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this asset.", "example": 2781 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" } }, "required": ["id", "name", "symbol", "slug"] }, "tags": { "type": "array", "description": "Array of tags associated with this cryptocurrency. Currently only a mineable tag will be returned if the cryptocurrency is mineable. Additional tags will be returned in the future.", "example": ["mineable"], "items": { "type": "string" } }, "platform": { "type": ["object", "null"], "description": "Metadata about the parent cryptocurrency platform this cryptocurrency belongs to if it is a token, otherwise null.", "properties": { "id": { "type": [ "integer", "string" ], "description": "The unique CoinMarketCap ID for the parent platform cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of the parent platform cryptocurrency.", "example": "Ethereum" }, "symbol": { "type": "string", "description": "The ticker symbol for the parent platform cryptocurrency.", "example": "ETH" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of the parent platform cryptocurrency name.", "example": "ethereum" }, "token_address": { "type": "string", "description": "The token address on the parent platform cryptocurrency.", "example": "0xe41d2489571d322189246dafa5ebde1f4699f498" } }, "required": ["id", "name", "symbol", "slug", "token_address"] }, "self_reported_tags": { "type": "array", "description": "Array of self reported tags associated with this cryptocurrency.", "example": ["Store Of Value", "Play To Earn"], "items": { "type": "string" } }, "website": { "type": "array", "description": "Array of website URLs.", "example": ["https://bitcoin.org/"], "items": { "type": "string", "x-format": { "uri": true } } }, "technical_doc": { "type": "array", "description": "Array of white paper or technical documentation URLs.", "example": ["https://bitcoin.org/bitcoin.pdf"], "items": { "type": "string", "x-format": { "uri": true } } }, "explorer": { "type": "array", "description": "Array of block explorer URLs.", "example": [ "https://blockchain.coinmarketcap.com/chain/bitcoin", "https://blockchain.info/", "https://live.blockcypher.com/btc/" ], "items": { "type": "string", "x-format": { "uri": true } } }, "source_code": { "type": "array", "description": "Array of source code URLs.", "example": ["https://github.com/bitcoin/"], "items": { "type": "string", "x-format": { "uri": true } } }, "message_board": { "type": "array", "description": "Array of message board URLs.", "example": ["https://bitcointalk.org"], "items": { "type": "string", "x-format": { "uri": true } } }, "chat": { "type": "array", "description": "Array of chat service URLs.", "example": [], "items": { "type": "string", "x-format": { "uri": true } } }, "announcement": { "type": "array", "description": "Array of announcement URLs.", "example": [], "items": { "type": "string", "x-format": { "uri": true } } }, "reddit": { "type": "array", "description": "Array of Reddit community page URLs.", "example": ["https://reddit.com/r/bitcoin"], "items": { "type": "string", "x-format": { "uri": true } } }, "twitter": { "type": "array", "description": "Array of official twitter profile URLs.", "example": ["https://twitter.com/Bitcoin"], "items": { "type": "string", "x-format": { "uri": true } } }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Exchange_Assets_Wallets_-_Response_Model" }, "required": ["Exchange Assets Wallets - Response Model"] }, "blog": { "type": "array", "description": "Official blog URLs.", "example": ["https://blog.kraken.com/"], "items": { "type": "string", "x-format": { "uri": true } } }, "fee": { "type": "array", "description": "Official web URLs covering exchange fees.", "example": ["https://www.gdax.com/fees"], "items": { "type": "string", "x-format": { "uri": true } } }, "plan": { "type": "object", "description": "Object containing rate limit and daily/monthly credit limit details for your API Key.", "properties": { "credit_limit_monthly": { "type": "number", "description": "The number of API credits that can be used each monthly period before receiving a HTTP 429 rate limit error. This limit is based on the API plan tier.", "example": 120000 }, "credit_limit_monthly_reset": { "type": "string", "description": "A human readable countdown of when the API key monthly credit limit will reset back to 0.", "example": "In 3 days, 19 hours, 56 minutes" }, "credit_limit_monthly_reset_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the monthly credit limit will reset. This is based on your billing plan activation date for premium subscription based keys or calendar month UTC midnight for free Basic plan keys.", "example": "2019-09-01T00:00:00.000Z" }, "rate_limit_minute": { "type": "number", "description": "The number of API calls that can be made within the same UTC minute before receiving a HTTP 429 rate limit error. This limit is based on the API plan tier.", "example": 60 } }, "required": [ "credit_limit_monthly", "credit_limit_monthly_reset", "credit_limit_monthly_reset_timestamp", "rate_limit_minute" ] }, "current_minute": { "type": "object", "description": "Usage stats around the minute based rate limit.", "properties": { "requests_made": { "type": "number", "description": "The number of API calls that have been made in the current UTC minute.", "example": 1 }, "requests_left": { "type": "number", "description": "The number of remaining API calls that can be made in the current UTC minute before receiving a HTTP 429 rate limit error. This limit resets each UTC minute.", "example": 59 } }, "required": ["requests_made", "requests_left"] }, "current_day": { "type": "object", "description": "Usage stats around the daily API credit limit.", "properties": { "credits_used": { "type": "number", "description": "The number of API credits used during the current daily period.", "example": 1 }, "credits_left": { "type": "number", "description": "The number of remaining API credits that can be used during the current daily period before receiving a HTTP 429 rate limit error. This limit resets at the end of each daily period.", "example": 3999 } }, "required": [ "credits_used" ] }, "current_month": { "type": "object", "description": "Usage stats around the monthly API credit limit.", "properties": { "credits_used": { "type": "number", "description": "The number of API credits used during the current monthly period.", "example": 1 }, "credits_left": { "type": "number", "description": "The number of remaining API credits that can be used during the current monthly period before receiving a HTTP 429 rate limit error. This limit resets at the end of each monthly period.", "example": 119999 } }, "required": [ "credits_used" ] }, "usage": { "type": "object", "description": "Object containing live usage details about your API Key.", "properties": { "current_minute": { "$ref": "#/components/schemas/current_minute" }, "current_day": { "$ref": "#/components/schemas/current_day" }, "current_month": { "$ref": "#/components/schemas/current_month" } }, "required": ["current_minute", "current_day", "current_month"] }, "owner": { "type": "object", "properties": { "nickname": { "type": "string" }, "avatar_url": { "type": "string" } } }, "photos": { "type": "array", "items": { "type": "string" } }, "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/Model_3" } }, "list": { "type": "array", "items": { "$ref": "#/components/schemas/Model_4" } }, "DqueryMarketRequestDTO": { "type": "object", "properties": { "platformIds": { "type": "string", "description": "Platform IDs, comma separated" }, "interval": { "type": "string", "description": "Time interval" }, "nextPageIndex": { "type": "string", "description": "Next page cursor" }, "pageSize": { "type": "integer", "description": "Page size", "format": "int32" }, "filter": { "$ref": "#/components/schemas/LeaderboardFilterDTO" }, "sortBy": { "type": "string", "description": "Sort field" }, "sortType": { "type": "string", "description": "Sort type: asc or desc" } }, "description": "Market list request" }, "LeaderboardFilterDTO": { "type": "object", "properties": { "hideFourMeme": { "type": "boolean", "description": "Whether to hide four.meme tokens" }, "hidePumpFun": { "type": "boolean", "description": "Whether to hide PumpFun tokens" }, "hideMoonshot": { "type": "boolean", "description": "Whether to hide Moonshot tokens" }, "auditPassed": { "type": "boolean", "description": "Only include tokens that passed audit" }, "social": { "type": "boolean", "description": "Only include tokens with social media presence" }, "minAge": { "type": "integer", "description": "Minimum token age in minutes", "format": "int32" }, "maxAge": { "type": "integer", "description": "Maximum token age in minutes", "format": "int32" }, "minMarketCap": { "type": "number", "description": "Minimum market cap (USD)" }, "maxMarketCap": { "type": "number", "description": "Maximum market cap (USD)" }, "minLiquidity": { "type": "number", "description": "Minimum liquidity (USD)" }, "maxLiquidity": { "type": "number", "description": "Maximum liquidity (USD)" }, "volume": { "type": "array", "description": "Volume filter ranges (e.g. 1000~5000)", "items": { "$ref": "#/components/schemas/RangeFilterDto" } }, "txns": { "type": "array", "description": "Transaction count filter ranges", "items": { "$ref": "#/components/schemas/RangeFilterDto" } }, "buys": { "type": "array", "description": "Buy count filter ranges", "items": { "$ref": "#/components/schemas/RangeFilterDto" } }, "sells": { "type": "array", "description": "Sell count filter ranges", "items": { "$ref": "#/components/schemas/RangeFilterDto" } }, "priceChange": { "type": "array", "description": "Price range filter ranges", "items": { "$ref": "#/components/schemas/RangeFilterDto" } }, "boostType": { "type": "string", "description": "Boost filter type", "enum": ["all, onlyBoost, hideBoost"] }, "allFieldsEmpty": { "type": "boolean" } }, "description": "The request parameters for querying the token leaderboard" }, "RangeFilterDto": { "type": "object", "properties": { "min": { "type": "string", "description": "Minimum value as string, e.g., 1000" }, "max": { "type": "string", "description": "Maximum value as string, e.g., 5000" }, "type": { "type": "string", "description": "Metric type, e.g. Refer to RangeFilterStatType for valid values. 5m, 1h, 4h, 24h" } }, "description": "Generic range filter structure" }, "DexTokenSignalDTO": { "type": "object", "properties": { "mtp": { "type": "number", "description": "highestPrice / firstSignalPrice" }, "psc": { "type": "integer", "description": "push count", "format": "int64" } }, "description": "Token signal" }, "TokenLeaderboardDTO": { "type": "object", "properties": { "n": { "type": "string", "description": "Token name (n)" }, "sym": { "type": "string", "description": "Token symbol (sym)" }, "addr": { "type": "string", "description": "Token address (addr)" }, "plt": { "type": "string", "description": "Token platform name (plt)" }, "pid": { "type": "integer", "description": "Token platform ID (pid)", "format": "int32" }, "pdex": { "type": "string", "description": "Token platform dexer name (pdex)" }, "pcid": { "type": "integer", "description": "Token platform crypto ID (pcid)", "format": "int32" }, "web": { "type": "string", "description": "Token website (web)" }, "tw": { "type": "string", "description": "Twitter (tw)" }, "tg": { "type": "string", "description": "Telegram (tg)" }, "lg": { "type": "string", "description": "Logo URL (lg)" }, "pubAt": { "type": "string", "description": "Publish timestamp in ms (pubAt)" }, "lchAt": { "type": "string", "description": "Launch timestamp in ms (lchAt)" }, "fdv": { "type": "string", "description": "Fully Diluted Valuation (fdv)" }, "mcap": { "type": "string", "description": "Market Cap (mcap)" }, "liqUsd": { "type": "string", "description": "Liquidity USD (liqUsd)" }, "liq": { "type": "string", "description": "Liquidity (liq)" }, "hld": { "type": "integer", "description": "Holder count (hld)", "format": "int32" }, "p": { "type": "string", "description": "Price USD (p)" }, "np": { "type": "string", "description": "native Price (np)" }, "pt": { "type": "string", "description": "Price timestamp (pt)" }, "v24h": { "type": "string", "description": "24h Volume USD (v24h)" }, "t24h": { "type": "string", "description": "24h Transactions (t24h)" }, "ch24h": { "type": "string", "description": "24h Price Change (ch24h)" }, "thr": { "type": "string", "description": "Top Holder Rate (thr)" }, "dhr": { "type": "string", "description": "Developer Holder Rate (dhr)" }, "bcr": { "type": "string", "description": "Bonding Curve Ratio (bcr)" }, "hcnt": { "type": "integer", "description": "Holder Count (hcnt)", "format": "int32" }, "tsrc": { "type": "string", "description": "token Source (src) — e.g. four.meme, pump.fun, moonshot" }, "sts": { "type": "array", "description": "Token statistics (sts)", "items": { "$ref": "#/components/schemas/TokenStatsDTO" } }, "rl": { "type": "string", "description": "Token security status" }, "ts": { "type": "string", "description": "total supply (ts)" }, "bs": { "type": "string", "description": "burn supply (bs)" }, "dec": { "type": "integer", "description": "decimals", "format": "int32" }, "sig": { "$ref": "#/components/schemas/DexTokenSignalDTO" }, "beScore": { "type": "number", "description": "Meme binance exclusive Score", "format": "double" }, "beRank": { "type": "integer", "description": "Meme binance exclusive rank", "format": "int32" }, "pltA": { "type": "string", "description": "Token platform acronym name" }, "ecs": { "type": "integer", "description": "Binance exclusive code, 1 - exclusive", "format": "int32" }, "tags": { "type": "array", "description": "Token tags", "items": { "type": "string", "description": "Token tags" } } }, "description": "Token leaderboard response DTO" }, "TokenStatsDTO": { "type": "object", "properties": { "tp": { "type": "string", "description": "Stat type, e.g., '1h', '24h', '7d'", "example": "24h" }, "vu": { "type": "string", "description": "Total volume (string formatted)", "example": "123456.789" }, "txs": { "type": "string", "description": "Total number of transactions", "example": "1024" }, "nb": { "type": "string", "description": "Number of buy transactions", "example": "678" }, "ns": { "type": "string", "description": "Number of sell transactions", "example": "346" }, "bvu": { "type": "string", "description": "Buy volume", "example": "65432.12" }, "svu": { "type": "string", "description": "Sell volume", "example": "58024.67" }, "but": { "type": "string", "description": "Number of unique buyers", "example": "431" }, "sut": { "type": "string", "description": "Number of unique sellers", "example": "398" }, "pc": { "type": "number", "description": "Price change rate (e.g. 5.23 means +5.23%)", "format": "float", "example": 3.51 }, "ut": { "type": "string", "description": "Number of unique traders", "example": "789" } }, "description": "Statistics data for token in specific interval" }, "TrendingTokensResponseDTO": { "type": "object", "properties": { "total": { "type": "integer", "description": "Total number of tokens", "format": "int32" }, "currentPage": { "type": "integer", "description": "Current page index", "format": "int32" }, "pageSize": { "type": "integer", "description": "Number of tokens per page", "format": "int32" }, "nextPageIndex": { "type": "string", "description": "Next page index" }, "version": { "type": "string", "description": "Version" }, "leaderboardList": { "type": "array", "description": "Token Leaderboard List", "items": { "$ref": "#/components/schemas/TokenLeaderboardDTO" } } } }, "DqueryBatchTokenRequestDTO": { "type": "object", "properties": { "platform": { "type": "string", "description": "Platform name" }, "addresses": { "type": "array", "description": "List of token addresses", "items": { "type": "string", "description": "List of token addresses" } } }, "description": "Batch token query request" }, "CryptoCurrencyExchangeDTO": { "type": "object", "properties": { "id": { "type": "integer", "description": "Exchange ID, e.g. 270", "format": "int32" }, "slug": { "type": "string", "description": "Exchange slug, e.g. binance" }, "n": { "type": "string", "description": "Full exchange name, e.g. Binance" }, "lg": { "type": "string", "description": "Logo URL, e.g. https://s2.coinmarketcap.com/static/img/exchanges/64x64/270.png" }, "wst": { "type": "string", "description": "Exchange website URL" }, "cat": { "type": "array", "description": "Exchange categories, e.g. SPOT, DERIVATIVES", "items": { "type": "string", "description": "Exchange categories, e.g. SPOT, DERIVATIVES" } } }, "description": "Centralized exchange information" }, "Token": { "type": "object", "properties": { "addr": { "type": "string", "description": "Token address" }, "lg": { "type": "string", "description": "Token logo URL" }, "n": { "type": "string", "description": "Token name" }, "sym": { "type": "string", "description": "Token symbol" }, "liq": { "type": "string", "description": "Liquidity in native unit" }, "liqUsd": { "type": "string", "description": "Liquidity in USD" } }, "description": "Basic token info in the pool" }, "TokenDetailDTO": { "type": "object", "properties": { "n": { "type": "string", "description": "Token name" }, "sym": { "type": "string", "description": "Token symbol" }, "addr": { "type": "string", "description": "Token address" }, "plt": { "type": "string", "description": "Platform name" }, "pdex": { "type": "string", "description": "Token platform dexer name (pdex)" }, "pcid": { "type": "integer", "description": "Token platform crypto ID (pcid)", "format": "int32" }, "pid": { "type": "integer", "description": "Platform ID", "format": "int32" }, "dec": { "type": "integer", "description": "Token decimals", "format": "int32" }, "crt": { "type": "string", "description": "Token creator address" }, "own": { "type": "string", "description": "Token owner address" }, "rnc": { "type": "string", "description": "Renounced address" }, "web": { "type": "string", "description": "Project website" }, "tw": { "type": "string", "description": "Twitter URL" }, "tg": { "type": "string", "description": "Telegram URL" }, "lg": { "type": "string", "description": "Logo URL" }, "pubAt": { "type": "string", "description": "Token publish timestamp" }, "lchAt": { "type": "string", "description": "Token launched timestamp" }, "fdv": { "type": "string", "description": "Fully Diluted Valuation" }, "mcap": { "type": "string", "description": "Market capitalization" }, "ts": { "type": "string", "description": "Total token supply" }, "bs": { "type": "string", "description": "Burned supply" }, "cs": { "type": "string", "description": "Circulating supply" }, "liqUsd": { "type": "string", "description": "Liquidity (USD)" }, "liq": { "type": "string", "description": "Liquidity (native)" }, "hld": { "type": "string", "description": "Holder count" }, "p": { "type": "string", "description": "Token price in USD" }, "ph24h": { "type": "string", "description": "24h price high" }, "pl24h": { "type": "string", "description": "24h price low" }, "pt": { "type": "string", "description": "Price last updated timestamp" }, "fpt": { "type": "string", "description": "Timestamp of the first time this token had a price" }, "fpct": { "type": "string", "description": "Timestamp when the first pool for this token was created" }, "bcr": { "type": "number", "description": "Bonding curve ratio", "format": "double" }, "sts": { "type": "array", "description": "Token statistics", "items": { "$ref": "#/components/schemas/TokenStatsDTO" } }, "pls": { "type": "array", "description": "Top liquidity pools", "items": { "$ref": "#/components/schemas/TokenTopPoolDTO" } }, "turl": { "type": "string", "description": "DEX trading URL" }, "nps": { "type": "string", "description": "Number of top pools" }, "tsrc": { "type": "string", "description": "Pool source" }, "rl": { "type": "string", "description": "Token risk level" }, "lf": { "type": "integer", "description": "Listed flag (1 = listed, 0 = unlisted)", "format": "int32" }, "cid": { "type": "integer", "description": "Crypto currency ID", "format": "int32" }, "lmc": { "type": "string", "description": "Listing market capitalization" }, "lsmc": { "type": "string", "description": "Listing self-reported market capitalization" }, "lsrcs": { "type": "string", "description": "Listing self-reported circulating supply" }, "ltcs": { "type": "string", "description": "Listing circulating supply" }, "ltda": { "type": "string", "description": "Listing token date added" }, "cexs": { "type": "array", "description": "Centralized exchange listings", "items": { "$ref": "#/components/schemas/CryptoCurrencyExchangeDTO" } }, "sig": { "$ref": "#/components/schemas/DexTokenSignalDTO" }, "ecs": { "type": "integer", "description": "Binance exclusive code, 1 - exclusive", "format": "int32" }, "la": { "type": "integer", "description": "show listed alert, 1-show,0-hide", "format": "int32" } }, "description": "Detailed token information" }, "TokenTopPoolDTO": { "type": "object", "properties": { "addr": { "type": "string", "description": "Pool address" }, "v24": { "type": "string", "description": "24-hour trading volume" }, "pubAt": { "type": "string", "description": "Publish timestamp" }, "t0": { "$ref": "#/components/schemas/Token" }, "t1": { "$ref": "#/components/schemas/Token" }, "bidx": { "type": "integer", "description": "Index of the base token in the pool (0 or 1)", "format": "int32" }, "exid": { "type": "integer", "description": "Exchange ID", "format": "int32" }, "exn": { "type": "string", "description": "Exchange name" }, "liqUsd": { "type": "string", "description": "Liquidity in USD" }, "fa": { "type": "string", "description": "Factory address" }, "lr": { "type": "string", "description": "Locked rate" }, "br": { "type": "string", "description": "Burned rate" }, "top": { "type": "boolean", "description": "Is top pool" }, "mi": { "type": "boolean", "description": "Is meme inner pool" } }, "description": "Token's top pool information" }, "DqueryBatchPriceRequestDTO": { "type": "object", "properties": { "tokens": { "type": "array", "description": "List of platform-address pairs", "items": { "$ref": "#/components/schemas/PlatformAddress" } } }, "description": "Batch price query request" }, "PlatformAddress": { "type": "object", "properties": { "platform": { "type": "string" }, "address": { "type": "string" } }, "description": "List of platform-address pairs" }, "TokenPriceDTO": { "type": "object", "properties": { "pid": { "type": "integer", "description": "Platform ID", "format": "int32" }, "pdex": { "type": "string", "description": "Platform dexer name" }, "pcid": { "type": "integer", "description": "Platform crypto ID", "format": "int32" }, "a": { "type": "string", "description": "Token address" }, "n": { "type": "string", "description": "Token name" }, "sym": { "type": "string", "description": "Token symbol" }, "lg": { "type": "string", "description": "Logo URL" }, "p": { "type": "number", "description": "Current price (USD)" }, "pc1h": { "type": "number", "description": "Price change in last 1 hour (percentage)" }, "pc24h": { "type": "number", "description": "Price change in last 24 hours (percentage)" }, "pc7d": { "type": "number", "description": "Price change in last 7 days (percentage)" }, "v24h": { "type": "number", "description": "24-hour trading volume (USD)" }, "l": { "type": "number", "description": "Liquidity (USD)" }, "ts": { "type": "string", "description": "Timestamp of price data" }, "mc": { "type": "number", "description": "Market cap" }, "fpt": { "type": "string", "description": "Timestamp (Unix milliseconds) of the first time this token had a price." }, "fpct": { "type": "string", "description": "Timestamp (Unix milliseconds) when the first pool for this token was created." } }, "description": "Token price information" }, "NewTokenLeaderBoardResponseDTO": { "type": "object", "properties": { "leaderboardList": { "type": "array", "description": "List of token leaderboard entries", "items": { "$ref": "#/components/schemas/TokenLeaderboardDTO" } }, "total": { "type": "string", "description": "Total number of entries matching the filter" }, "hasNextPage": { "type": "boolean", "description": "Whether there is another page after this one" }, "lastUpdateTime": { "type": "string", "description": "Timestamp (in milliseconds) of the last update" }, "nextPageIndex": { "type": "string", "description": "Index to be used for the next page request, if hasNextPage is true" } }, "description": "NewTokenLeaderboard response object" }, "DqueryMemeRequestDTO": { "type": "object", "properties": { "protocol": { "type": "integer", "description": "Protocol code", "format": "int32" }, "exclusive": { "type": "integer", "description": "Binance exclusive flag", "format": "int32" }, "limit": { "type": "integer", "description": "Result limit", "format": "int32" }, "newCreationFilter": { "$ref": "#/components/schemas/MemeCoinFilterDTO" }, "aboutGraduateFilter": { "$ref": "#/components/schemas/MemeCoinFilterDTO" }, "graduateFilter": { "$ref": "#/components/schemas/MemeCoinFilterDTO" } }, "description": "Meme coin request" }, "MemeCoinFilterDTO": { "type": "object", "properties": { "topHoldersLessThan": { "type": "boolean", "description": "Whether top holders collectively hold less than a certain threshold" }, "devSoldAll": { "type": "boolean", "description": "Whether the developer has sold all of their tokens" }, "devStillHolding": { "type": "boolean", "description": "dev still holding" }, "social": { "type": "boolean", "description": "Whether the token has social media presence" }, "minAge": { "type": "integer", "description": "Minimum token age in minutes (≥0)", "format": "int32" }, "maxAge": { "type": "integer", "description": "Maximum token age in minutes (≥0)", "format": "int32" }, "minMarketCap": { "type": "number", "description": "Minimum market cap in USD (≥0)" }, "maxMarketCap": { "type": "number", "description": "Maximum market cap in USD (≥0)" }, "minLiquidity": { "type": "number", "description": "Minimum liquidity value in USD (≥0)" }, "maxLiquidity": { "type": "number", "description": "Maximum liquidity value in USD (≥0)" }, "minBondingCurve": { "type": "number", "description": "Minimum bonding curve value (≥0)" }, "maxBondingCurve": { "type": "number", "description": "Maximum bonding curve value (≥0)" }, "minDevHolding": { "type": "number", "description": "Minimum DEX holding amount (≥0)" }, "maxDevHolding": { "type": "number", "description": "Maximum DEX holding amount (≥0)" }, "minHolders": { "type": "integer", "description": "Minimum number of token holders (≥0)", "format": "int32" }, "maxHolders": { "type": "integer", "description": "Maximum number of token holders (≥0)", "format": "int32" }, "minVolume": { "type": "number", "description": "Minimum trading volume (≥0)" }, "maxVolume": { "type": "number", "description": "Maximum trading volume (≥0)" }, "minTxns": { "type": "integer", "description": "Minimum 24h transaction count (≥0)", "format": "int64" }, "maxTxns": { "type": "integer", "description": "Maximum 24h transaction count (≥0)", "format": "int64" }, "minBuys": { "type": "integer", "description": "Minimum 24h buy transaction count (≥0)", "format": "int64" }, "maxBuys": { "type": "integer", "description": "Maximum 24h buy transaction count (≥0)", "format": "int64" }, "minSells": { "type": "integer", "description": "Minimum 24h sell transaction count (≥0)", "format": "int64" }, "maxSells": { "type": "integer", "description": "Maximum 24h sell transaction count (≥0)", "format": "int64" }, "minTop10Holding": { "type": "number", "description": "Minimum Top10Holding (≥0)", "format": "double" }, "maxTop10Holding": { "type": "number", "description": "Maximum Top10Holding (≥0)", "format": "double" }, "minSnipers": { "type": "number", "description": "Minimum Snipers (≥0)", "format": "double" }, "maxSnipers": { "type": "number", "description": "Maximum Snipers (≥0)", "format": "double" }, "minInsiders": { "type": "number", "description": "Minimum Insiders (≥0)", "format": "double" }, "maxInsiders": { "type": "number", "description": "Maximum Insiders (≥0)", "format": "double" } }, "description": "Filter criteria for meme coins" }, "MemeCoinResponseDTO": { "type": "object", "properties": { "newCreations": { "type": "array", "items": { "$ref": "#/components/schemas/MemeCoinResultDTO" } }, "aboutGraduates": { "type": "array", "items": { "$ref": "#/components/schemas/MemeCoinResultDTO" } }, "graduates": { "type": "array", "items": { "$ref": "#/components/schemas/MemeCoinResultDTO" } } }, "description": "Response object containing categorized meme coin results" }, "MemeCoinResultDTO": { "type": "object", "properties": { "plt": { "type": "integer", "description": "Token platform ID", "format": "int32" }, "cid": { "type": "string", "description": "chain platform id" }, "pr": { "type": "integer", "description": "Platform crypto id", "format": "int32" }, "pn": { "type": "string", "description": "Platform name" }, "it": { "type": "string", "description": "Item link" }, "addr": { "type": "string", "description": "Token address" }, "n": { "type": "string", "description": "Name of the token" }, "sym": { "type": "string", "description": "Symbol of the token" }, "lg": { "type": "string", "description": "URL to the token's logo image" }, "tw": { "type": "string", "description": "Twitter URL" }, "web": { "type": "string", "description": "Official website URL" }, "tg": { "type": "string", "description": "Telegram URL" }, "pt": { "type": "integer", "description": "Token protocol type: 1001=Pump.fun, 1002=Moonshot, 2001=Four.meme", "format": "int64" }, "pubAt": { "type": "integer", "description": "Timestamp when the token was published, in milliseconds since epoch", "format": "int64" }, "dec": { "type": "integer", "description": "Number of decimals", "format": "int32" }, "tp": { "type": "string", "description": "Total supply of the token" }, "bc": { "type": "number", "description": "Bonding curve progress percentage (0~1)" }, "mcap": { "type": "number", "description": "Market capitalization in USD" }, "liq": { "type": "number", "description": "Liquidity value in USD" }, "vu": { "type": "number", "description": "Trading volume in USD over the last 24 hours" }, "np": { "type": "number", "description": "Native price of the token (in native currency, e.g., SOL)" }, "p": { "type": "number", "description": "Price of the token in USD" }, "txs": { "type": "integer", "description": "Total number of transactions associated with this token", "format": "int64" }, "nb": { "type": "integer", "description": "Number of buy transactions in the last 24 hours", "format": "int64" }, "ns": { "type": "integer", "description": "Number of sell transactions in the last 24 hours", "format": "int64" }, "htp": { "type": "number", "description": "Percentage of tokens held by top 10 wallets", "format": "double" }, "hdp": { "type": "number", "description": "Percentage of tokens held by developer wallets", "format": "double" }, "hsp": { "type": "number", "description": "Percentage of tokens held by sniper wallets", "format": "double" }, "hip": { "type": "number", "description": "Percentage of tokens held by insider wallets", "format": "double" }, "dsp": { "type": "number", "description": "Percentage of tokens sold by DEX developers", "format": "double" }, "dmc": { "type": "integer", "description": "Number of times the token has migrated from a DEX", "format": "int32" }, "ms": { "type": "integer", "description": "Migration status", "format": "int32" }, "mt": { "type": "integer", "description": "Timestamp when the token was migrated, in milliseconds since epoch", "format": "int64" }, "md": { "type": "string", "description": "Name of the DEX where the token was migrated to" }, "h": { "type": "integer", "description": "Total number of unique token holders", "format": "int64" }, "ecs": { "type": "integer", "description": "Binance exclusive code, 1 - exclusive", "format": "int32" } }, "description": "List of meme coins that have graduated" }, "GainerLeaderBoardResponseDTO": { "type": "object", "properties": { "leaderboardList": { "type": "array", "description": "List of token leaderboard entries", "items": { "$ref": "#/components/schemas/TokenLeaderboardDTO" } }, "pageNum": { "type": "integer", "description": "Current page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "Number of entries per page", "format": "int32" }, "total": { "type": "string", "description": "Total number of matching entries" }, "hasNextPage": { "type": "boolean", "description": "Whether there is another page after the current one" }, "lastUpdateTime": { "type": "integer", "description": "Timestamp (in milliseconds) when the data was last updated", "format": "int64" }, "nextPageIndex": { "type": "string", "description": "Cursor to be used for fetching the next page" } }, "description": "Response object for the Gainer Leaderboard API" }, "GlobalMetricsBatchRequestDTO": { "type": "object", "properties": { "scores": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "GlobalMetricsQuoteDTO": { "type": "object", "properties": { "score": { "type": "integer", "description": "Score value for sorting or ranking", "format": "int64" }, "id": { "type": "integer", "description": "Unique identifier", "format": "int64" }, "marketCapByAvailableSupplyUsd": { "type": "number", "description": "Total market capitalization by available supply in USD", "format": "bigdecimal" }, "marketCapByTotalSupplyUsd": { "type": "number", "description": "Total market capitalization by total supply in USD", "format": "bigdecimal" }, "volumeUsd": { "type": "number", "description": "24-hour trading volume in USD", "format": "bigdecimal" }, "volumeUsdReported": { "type": "number", "description": "Reported 24-hour trading volume in USD", "format": "bigdecimal" }, "altCoinMarketCapByAvailableSupplyUsd": { "type": "number", "description": "Altcoin market capitalization by available supply in USD", "format": "bigdecimal" }, "altCoinVolumeUsd": { "type": "number", "description": "Altcoin 24-hour trading volume in USD", "format": "bigdecimal" }, "altCoinVolumeUsdReported": { "type": "number", "description": "Reported altcoin 24-hour trading volume in USD", "format": "bigdecimal" }, "bitcoinPercentageOfMarketCap": { "type": "number", "description": "Bitcoin percentage of total market cap", "format": "bigdecimal" }, "ethPercentageOfMarketCap": { "type": "number", "description": "Ethereum percentage of total market cap", "format": "bigdecimal" }, "activeCryptocurrencies": { "type": "integer", "description": "Number of active cryptocurrencies", "format": "int32" }, "activeExchanges": { "type": "integer", "description": "Number of active exchanges", "format": "int32" }, "activeMarketPairs": { "type": "integer", "description": "Number of active market pairs", "format": "int32" }, "defiVolume24h": { "type": "number", "description": "DeFi 24-hour trading volume", "format": "bigdecimal" }, "defiVolume24hReported": { "type": "number", "description": "Reported DeFi 24-hour trading volume", "format": "bigdecimal" }, "defiMarketCap": { "type": "number", "description": "DeFi market capitalization", "format": "bigdecimal" }, "stableCoinVolume24h": { "type": "number", "description": "Stablecoin 24-hour trading volume", "format": "bigdecimal" }, "stableCoinVolume24hReported": { "type": "number", "description": "Reported stablecoin 24-hour trading volume", "format": "bigdecimal" }, "stableCoinMarketCap": { "type": "number", "description": "Stablecoin market capitalization", "format": "bigdecimal" }, "derivativesVolume24h": { "type": "number", "description": "Derivatives 24-hour trading volume", "format": "bigdecimal" }, "derivativesVolume24hReported": { "type": "number", "description": "Reported derivatives 24-hour trading volume", "format": "bigdecimal" }, "totalCryptocurrencies": { "type": "integer", "description": "Total number of cryptocurrencies", "format": "int32" }, "totalExchanges": { "type": "integer", "description": "Total number of exchanges", "format": "int32" } } }, "ExchangeBatchRequestDTO": { "type": "object", "properties": { "exchangeId": { "type": "integer", "format": "int32" }, "scores": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "ExchangeQuoteDTO": { "type": "object", "properties": { "exchangeId": { "type": "integer", "description": "Exchange ID", "format": "int32" }, "numTradePairs": { "type": "integer", "description": "Number of trade pairs", "format": "int32" }, "volumeUsd": { "type": "number", "description": "Volume in USD", "format": "bigdecimal" }, "originalScore": { "type": "integer", "description": "Original score", "format": "int64" }, "score": { "type": "integer", "description": "Score", "format": "int64" }, "time_utc": { "type": "string", "description": "Time in UTC" } } }, "SnapshotBatchQueryRequestDTO": { "type": "object", "properties": { "targetDate": { "type": "string", "description": "The date of the snapshot data was created (2022-04-29 as an example). required." }, "cryptoIds": { "type": "array", "description": "The crypto ids of the snapshot data will be retrieved.", "items": { "type": "integer", "description": "The crypto ids of the snapshot data will be retrieved.", "format": "int32" } } }, "description": "fetch batch snapshot data points request body" }, "CryptoSnapshotDTO": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Cryptocurrency symbol" }, "name": { "type": "string", "description": "Cryptocurrency name" }, "slug": { "type": "string", "description": "Cryptocurrency slug" }, "rank": { "type": "integer", "description": "Cryptocurrency rank", "format": "int32" }, "id": { "type": "integer", "description": "Cryptocurrency ID", "format": "int32" }, "tag_names": { "type": "string", "description": "Tag names" }, "tag_groups": { "type": "string", "description": "Tag groups" }, "num_market_pairs": { "type": "integer", "description": "Number of market pairs", "format": "int32" }, "target_date": { "type": "string", "description": "Target date" }, "last_update": { "type": "string", "description": "Last update time" }, "price_usd": { "type": "number", "description": "Price in USD", "format": "bigdecimal" }, "max_supply": { "type": "number", "description": "Max supply", "format": "bigdecimal" }, "volume_usd": { "type": "number", "description": "Volume in USD", "format": "bigdecimal" }, "available_supply": { "type": "number", "description": "Available supply", "format": "bigdecimal" }, "total_supply": { "type": "number", "description": "Total supply", "format": "bigdecimal" }, "market_cap": { "type": "number", "description": "Market capitalization", "format": "bigdecimal" }, "percentage_change_price_usd_1h": { "type": "number", "description": "Percentage change in price USD in 1 hour", "format": "bigdecimal" }, "percentage_change_price_usd_24h": { "type": "number", "description": "Percentage change in price USD in 24 hours", "format": "bigdecimal" }, "percentage_change_price_usd_7d": { "type": "number", "description": "Percentage change in price USD in 7 days", "format": "bigdecimal" } } }, "CommonBatchRequestDTO": { "type": "object", "properties": { "cryptoId": { "type": "integer", "format": "int32" }, "scores": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "CryptoQuoteDTO": { "type": "object", "properties": { "score": { "type": "integer", "description": "Score value for sorting or ranking", "format": "int64" }, "price": { "type": "number", "description": "Current price in USD", "format": "bigdecimal" }, "volume": { "type": "number", "description": "24-hour trading volume in USD", "format": "bigdecimal" }, "marketCap": { "type": "number", "description": "Market capitalization in USD", "format": "bigdecimal" }, "totalSupply": { "type": "number", "description": "Total supply of the cryptocurrency", "format": "bigdecimal" }, "circulatingSupply": { "type": "number", "description": "Circulating supply of the cryptocurrency", "format": "bigdecimal" }, "percentageChangePriceUsd1h": { "type": "number", "description": "1-hour percentage change in USD price", "format": "bigdecimal" }, "percentageChangePriceUsd24h": { "type": "number", "description": "24-hour percentage change in USD price", "format": "bigdecimal" }, "percentageChangePriceUsd7d": { "type": "number", "description": "7-day percentage change in USD price", "format": "bigdecimal" }, "percentageChangePriceUsd30d": { "type": "number", "description": "30-day percentage change in USD price", "format": "bigdecimal" } } }, "OhlcvBatchRequestDTO": { "type": "object", "properties": { "interval": { "type": "string", "description": "valid paratmers: 1d/1h, 1d for daily ohlcv data and 1h for houly data." }, "cryptoId": { "type": "integer", "description": "crypto id, required.", "format": "int32" }, "scores": { "type": "array", "description": "scores of the batch, required.", "items": { "type": "integer", "description": "scores of the batch, required.", "format": "int64" } } } }, "CryptoOhlcvQuoteDTO": { "type": "object", "properties": { "open": { "type": "number", "description": "Open price", "format": "bigdecimal" }, "high": { "type": "number", "description": "High price", "format": "bigdecimal" }, "low": { "type": "number", "description": "Low price", "format": "bigdecimal" }, "close": { "type": "number", "description": "Close price", "format": "bigdecimal" }, "volume": { "type": "number", "description": "Volume", "format": "bigdecimal" }, "score": { "type": "integer", "description": "Score", "format": "int64" }, "market_cap": { "type": "number", "description": "Market capitalization", "format": "bigdecimal" }, "time_high": { "type": "string", "description": "Time of high price" }, "time_low": { "type": "string", "description": "Time of low price" }, "time_open": { "type": "string", "description": "Time of open price" }, "time_close": { "type": "string", "description": "Time of close price" } } }, "DexQuoteDTO": { "type": "object", "properties": { "price": { "type": "number", "description": "Price in the specified currency for this spot pair.", "format": "bigdecimal" }, "liquidity": { "type": "number", "description": "Total liquidity available currently in the specified currency. This field will return null if not available.", "format": "bigdecimal" }, "convert_id": { "type": "string", "description": "id of specified currency." }, "price_by_quote_asset": { "type": "number", "description": "Price of the base asset in quote asset for this spot pair.", "format": "bigdecimal" }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "format": "date-time" }, "volume_24h": { "type": "number", "description": "Reported 24 hour volume in the specified spot pair in the specified currency.", "format": "bigdecimal" }, "percent_change_price_1h": { "type": "number", "description": "1 hour price change percentage in the specified spot pair in the specified currency.", "format": "bigdecimal" }, "percent_change_price_24h": { "type": "number", "description": "24 hour price change percentage in the specified spot pair in the specified currency.", "format": "bigdecimal" }, "fully_diluted_value": { "type": "number", "description": "Fully Diluted Value = (Total Supply - Burned Supply) * Price. Returned in the specified currency.", "format": "bigdecimal" }, "24h_buy_volume": { "type": "number", "description": "24 hours buy volume of the asset", "format": "bigdecimal" }, "24h_sell_volume": { "type": "number", "description": "24 hours sell volume of the asset", "format": "bigdecimal" } }, "description": "A map of market quotes in different currency conversions. The default map included is USD." }, "DexSpotPairDTO": { "type": "object", "properties": { "quote": { "type": "array", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "items": { "$ref": "#/components/schemas/DexQuoteDTO" } }, "contract_address": { "type": "string", "description": "The unique contract address for this spot pair." }, "name": { "type": "string", "description": "The name of this spot pair." }, "base_asset_id": { "type": [ "string", "null" ], "description": "The id of this base asset in the spot pair." }, "base_asset_ucid": { "type": [ "string", "null" ], "description": "The ucid of this base asset in the spot pair." }, "base_asset_name": { "type": "string", "description": "The name of this base asset in the spot pair." }, "base_asset_symbol": { "type": "string", "description": "The symbol of this base asset in the spot pair." }, "base_asset_contract_address": { "type": "string", "description": "The contract addres of this base asset in the spot pair." }, "quote_asset_id": { "type": [ "string", "null" ], "description": "The id of this quote asset in the spot pair." }, "quote_asset_ucid": { "type": [ "string", "null" ], "description": "The ucid of this quote asset in the spot pair." }, "quote_asset_name": { "type": "string", "description": "The name of this quote asset in the spot pair." }, "quote_asset_symbol": { "type": "string", "description": "The symbol of this quote asset in the spot pair." }, "quote_asset_contract_address": { "type": "string", "description": "The contract addresss of this quote asset in the spot pair." }, "dex_id": { "type": "string", "description": "The id of this dex the spot pair is on." }, "dex_slug": { "type": "string", "description": "The name of this dex the spot pair is on." }, "network_id": { "type": "string", "description": "The id of the network the spot pair is on." }, "network_slug": { "type": "string", "description": "The slug of the network the spot pair is on." }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of the last time this record was updated.", "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "description": "Timestamp (ISO 8601) when we started tracking this asset.", "format": "date-time" }, "num_transactions_24h": { "type": "integer", "description": "Number of transactions in past 24 hours", "format": "int64" }, "holders": { "type": "integer", "description": "Number of holders of the asset", "format": "int64" }, "24h_no_of_buys": { "type": "integer", "description": "Number of asset buys in the past 24 hours", "format": "int64" }, "24h_no_of_sells": { "type": "integer", "description": "Number of asset sells in the past 24 hours", "format": "int64" }, "pool_created": { "type": "string", "description": "When the pool of the asset was created", "format": "date-time" }, "buy_tax": { "type": "number", "description": "Buy tax on the asset", "format": "bigdecimal" }, "sell_tax": { "type": "number", "description": "Sell tax on the asset", "format": "bigdecimal" }, "security_scan": { "type": "array", "description": "Security scan by Go+.\n\n\nAll infomation and data relating to contract detection are based on public third party information. CoinMarketCap does not confirm or verify the accuracy or timeliness of such information and data.\n\nCoinMarketCap shall have no responsibility or liability for the accuracy of data, nor have the duty to review, confirm, verify or otherwise perform any inquiry or investigation as to the completeness, accuracy, sufficiency, integrity, reliability or timeliness of any such information or data provided.\n\nOnly returned if passed in aux.", "items": { "$ref": "#/components/schemas/SecurityScanResult" } }, "pool_base_asset": { "type": "number", "description": "Base asset in the pool", "format": "bigdecimal" }, "pool_quote_asset": { "type": "number", "description": "Quote asset in the pool", "format": "bigdecimal" }, "percent_pooled_base_asset": { "type": "number", "description": "Percentage of the base asset in the pool", "format": "bigdecimal" }, "24h_volume_quote_asset": { "type": "number", "description": "24 hours volume of the quote asset", "format": "bigdecimal" }, "total_supply_quote_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "total_supply_base_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "date_launched": { "type": "string", "description": "Timestamp (ISO 8601) of the launch date for this exchange.", "format": "date-time" }, "scroll_id": { "type": "string", "description": "A unique identifier used to fetch the next batch of results from the next API related API call, if applicable. scroll_id is an alternative to traditional pagingation techniques." } } }, "SecurityScan3rdResult": { "type": "object", "properties": { "open_source": { "type": "boolean" }, "proxy": { "type": "boolean" }, "mintable": { "type": "boolean" }, "can_take_back_ownership": { "type": "boolean" }, "owner_change_balance": { "type": "boolean" }, "hidden_owner": { "type": "boolean" }, "self_destruct": { "type": "boolean" }, "external_call": { "type": "boolean" }, "cannot_buy": { "type": "boolean" }, "cannot_sell_all": { "type": "boolean" }, "slippage_modifiable": { "type": "boolean" }, "honeypot": { "type": "boolean" }, "transfer_pausable": { "type": "boolean" }, "blacklisted": { "type": "boolean" }, "whitelisted": { "type": "boolean" }, "in_dex": { "type": "boolean" }, "anti_whale": { "type": "boolean" }, "anti_whale_modifiable": { "type": "boolean" }, "trading_cool_down": { "type": "boolean" }, "personal_slippage_modifiable": { "type": "boolean" }, "trust_list": { "type": "boolean" }, "true_token": { "type": "boolean" }, "airdrop_scam": { "type": "boolean" } } }, "SecurityScanAggregatedResult": { "type": "object", "properties": { "contract_verified": { "type": "boolean" }, "honeypot": { "type": "boolean" } } }, "SecurityScanResult": { "type": "object", "properties": { "third_party": { "$ref": "#/components/schemas/SecurityScan3rdResult" }, "aggregated": { "$ref": "#/components/schemas/SecurityScanAggregatedResult" } }, "description": "Security scan by Go+.\n\n\nAll infomation and data relating to contract detection are based on public third party information. CoinMarketCap does not confirm or verify the accuracy or timeliness of such information and data.\n\nCoinMarketCap shall have no responsibility or liability for the accuracy of data, nor have the duty to review, confirm, verify or otherwise perform any inquiry or investigation as to the completeness, accuracy, sufficiency, integrity, reliability or timeliness of any such information or data provided.\n\nOnly returned if passed in aux." }, "DexPairsTradeDTO": { "type": "object", "properties": { "trades": { "type": "array", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "items": { "$ref": "#/components/schemas/DexTransactionDTO" } }, "contract_address": { "type": "string", "description": "The unique contract address for this spot pair." }, "name": { "type": "string", "description": "The name of this spot pair." }, "base_asset_id": { "type": "string", "description": "The id of this base asset in the spot pair." }, "base_asset_ucid": { "type": "string", "description": "The ucid of this base asset in the spot pair." }, "base_asset_name": { "type": "string", "description": "The name of this base asset in the spot pair." }, "base_asset_symbol": { "type": "string", "description": "The symbol of this base asset in the spot pair." }, "base_asset_contract_address": { "type": "string", "description": "The contract addres of this base asset in the spot pair." }, "quote_asset_id": { "type": "string", "description": "The id of this quote asset in the spot pair." }, "quote_asset_ucid": { "type": "string", "description": "The ucid of this quote asset in the spot pair." }, "quote_asset_name": { "type": "string", "description": "The name of this quote asset in the spot pair." }, "quote_asset_symbol": { "type": "string", "description": "The symbol of this quote asset in the spot pair." }, "quote_asset_contract_address": { "type": "string", "description": "The contract addresss of this quote asset in the spot pair." }, "dex_id": { "type": "string", "description": "The id of this dex the spot pair is on." }, "dex_slug": { "type": "string", "description": "The name of this dex the spot pair is on." }, "network_id": { "type": "string", "description": "The id of the network the spot pair is on." }, "network_slug": { "type": "string", "description": "The slug of the network the spot pair is on." }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of the last time this record was updated.", "format": "date-time" }, "created_at": { "type": "string", "description": "Timestamp (ISO 8601) when we started tracking this asset.", "format": "date-time" }, "num_transactions_24h": { "type": "integer", "description": "Number of transactions in past 24 hours", "format": "int64" }, "holders": { "type": "integer", "description": "Number of holders of the asset", "format": "int64" }, "24h_no_of_buys": { "type": "integer", "description": "Number of asset buys in the past 24 hours", "format": "int64" }, "24h_no_of_sells": { "type": "integer", "description": "Number of asset sells in the past 24 hours", "format": "int64" }, "pool_created": { "type": "string", "description": "When the pool of the asset was created", "format": "date-time" }, "buy_tax": { "type": "number", "description": "Buy tax on the asset", "format": "bigdecimal" }, "sell_tax": { "type": "number", "description": "Sell tax on the asset", "format": "bigdecimal" }, "security_scan": { "type": "array", "description": "Security scan by Go+.\n\n\nAll infomation and data relating to contract detection are based on public third party information. CoinMarketCap does not confirm or verify the accuracy or timeliness of such information and data.\n\nCoinMarketCap shall have no responsibility or liability for the accuracy of data, nor have the duty to review, confirm, verify or otherwise perform any inquiry or investigation as to the completeness, accuracy, sufficiency, integrity, reliability or timeliness of any such information or data provided.\n\nOnly returned if passed in aux.", "items": { "$ref": "#/components/schemas/SecurityScanResult" } }, "pool_base_asset": { "type": "number", "description": "Base asset in the pool", "format": "bigdecimal" }, "pool_quote_asset": { "type": "number", "description": "Quote asset in the pool", "format": "bigdecimal" }, "percent_pooled_base_asset": { "type": "number", "description": "Percentage of the base asset in the pool", "format": "bigdecimal" }, "24h_volume_quote_asset": { "type": "number", "description": "24 hours volume of the quote asset", "format": "bigdecimal" }, "total_supply_quote_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "total_supply_base_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "date_launched": { "type": "string", "description": "Timestamp (ISO 8601) of the launch date for this exchange.", "format": "date-time" } } }, "DexTransactionDTO": { "type": "object", "properties": { "date": { "type": "string", "description": "Timestamp (ISO 8601) of specified transaction.", "format": "date-time" }, "type": { "type": "string", "description": "Buy or sell trade." }, "quote": { "type": "array", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "items": { "$ref": "#/components/schemas/DexTransactionQuoteDTO" } }, "transaction_hash": { "type": "string", "description": "Transaction hash of the trade. Only returned if passed in aux." }, "blockchain_explorer_link": { "type": "string", "description": "Link to the transaction on a blockchain explorer if available. Only returned if passed in aux." } }, "description": "DEX transaction data" }, "DexTransactionQuoteDTO": { "type": "object", "properties": { "price": { "type": "number", "description": "Price of the base asset in the specified currency.", "format": "bigdecimal" }, "total": { "type": "number", "description": "Total value of trade in the specified currency.", "format": "bigdecimal" }, "convert_id": { "type": "string", "description": "id of specified currency." }, "price_by_quote_asset": { "type": "number", "description": "Price of the base asset in quote asset.", "format": "bigdecimal" }, "amount_base_asset": { "type": "number", "description": "Amount of base asset traded.", "format": "bigdecimal" }, "amount_quote_asset": { "type": "number", "description": "Amount of quote asset traded.", "format": "bigdecimal" } }, "description": "DEX transaction quote data" }, "DexParisQuotesDTO": { "type": "object", "properties": { "quote": { "type": "array", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "items": { "$ref": "#/components/schemas/DexQuoteDTO" } }, "contract_address": { "type": "string", "description": "The unique contract address for this spot pair." }, "name": { "type": "string", "description": "The name of this spot pair." }, "base_asset_id": { "type": [ "string", "null" ], "description": "The id of this base asset in the spot pair." }, "base_asset_ucid": { "type": "string", "description": "The ucid of this base asset in the spot pair." }, "base_asset_name": { "type": "string", "description": "The name of this base asset in the spot pair." }, "base_asset_symbol": { "type": "string", "description": "The symbol of this base asset in the spot pair." }, "base_asset_contract_address": { "type": "string", "description": "The contract addres of this base asset in the spot pair." }, "quote_asset_id": { "type": [ "string", "null" ], "description": "The id of this quote asset in the spot pair." }, "quote_asset_ucid": { "type": "string", "description": "The ucid of this quote asset in the spot pair." }, "quote_asset_name": { "type": "string", "description": "The name of this quote asset in the spot pair." }, "quote_asset_symbol": { "type": "string", "description": "The symbol of this quote asset in the spot pair." }, "quote_asset_contract_address": { "type": "string", "description": "The contract addresss of this quote asset in the spot pair." }, "dex_id": { "type": "string", "description": "The id of this dex the spot pair is on." }, "dex_slug": { "type": "string", "description": "The name of this dex the spot pair is on." }, "network_id": { "type": "string", "description": "The id of the network the spot pair is on." }, "network_slug": { "type": "string", "description": "The slug of the network the spot pair is on." }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of the last time this record was updated.", "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "description": "Timestamp (ISO 8601) when we started tracking this asset.", "format": "date-time" }, "num_transactions_24h": { "type": "integer", "description": "Number of transactions in past 24 hours", "format": "int64" }, "holders": { "type": [ "integer", "null" ], "description": "Number of holders of the asset", "format": "int64" }, "24h_no_of_buys": { "type": "integer", "description": "Number of asset buys in the past 24 hours", "format": "int64" }, "24h_no_of_sells": { "type": "integer", "description": "Number of asset sells in the past 24 hours", "format": "int64" }, "pool_created": { "type": [ "string", "null" ], "description": "When the pool of the asset was created", "format": "date-time" }, "buy_tax": { "type": [ "number", "null" ], "description": "Buy tax on the asset", "format": "bigdecimal" }, "sell_tax": { "type": [ "number", "null" ], "description": "Sell tax on the asset", "format": "bigdecimal" }, "security_scan": { "type": [ "array", "null" ], "description": "Security scan by Go+.\n\n\nAll infomation and data relating to contract detection are based on public third party information. CoinMarketCap does not confirm or verify the accuracy or timeliness of such information and data.\n\nCoinMarketCap shall have no responsibility or liability for the accuracy of data, nor have the duty to review, confirm, verify or otherwise perform any inquiry or investigation as to the completeness, accuracy, sufficiency, integrity, reliability or timeliness of any such information or data provided.\n\nOnly returned if passed in aux.", "items": { "$ref": "#/components/schemas/SecurityScanResult" } }, "pool_base_asset": { "type": "number", "description": "Base asset in the pool", "format": "bigdecimal" }, "pool_quote_asset": { "type": "number", "description": "Quote asset in the pool", "format": "bigdecimal" }, "percent_pooled_base_asset": { "type": [ "number", "null" ], "description": "Percentage of the base asset in the pool", "format": "bigdecimal" }, "24h_volume_quote_asset": { "type": "number", "description": "24 hours volume of the quote asset", "format": "bigdecimal" }, "total_supply_quote_asset": { "type": [ "number", "null" ], "description": "Total supply of the quote asset", "format": "bigdecimal" }, "total_supply_base_asset": { "type": [ "number", "null" ], "description": "Total supply of the quote asset", "format": "bigdecimal" }, "date_launched": { "type": "string", "description": "Timestamp (ISO 8601) of the launch date for this exchange.", "format": "date-time" } }, "description": "DEX pairs quotes data" }, "DexOhlcvQuote": { "type": "object", "properties": { "open": { "type": "number", "description": "Price from first datapoint of today in UTC time for the convert option requested.", "format": "bigdecimal" }, "high": { "type": "number", "description": "Highest price so far today in UTC time for the convert option requested.", "format": "bigdecimal" }, "low": { "type": "number", "description": "Lowest price today in UTC time for the convert option requested.", "format": "bigdecimal" }, "close": { "type": "number", "description": "Latest price today in UTC time for the convert option requested. This is not the final price during close as the current day period is not over.", "format": "bigdecimal" }, "volume": { "type": "number", "description": "Adjusted volume for this time series interval.", "format": "bigdecimal" }, "convert_id": { "type": "string", "description": "id of specified currency." }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion." }, "24h_buy_volume": { "type": "number", "description": "24 hours buy volume of the asset", "format": "bigdecimal" }, "24h_sell_volume": { "type": "number", "description": "24 hours sell volume of the asset", "format": "bigdecimal" } }, "description": "DEX OHLCV (Open, High, Low, Close, Volume) quote data" }, "DexPairsOhlcvDTO": { "type": "object", "properties": { "quote": { "type": "array", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "items": { "$ref": "#/components/schemas/DexOhlcvQuote" } }, "contract_address": { "type": "string", "description": "The unique contract address for this spot pair." }, "name": { "type": "string", "description": "The name of this spot pair." }, "base_asset_id": { "type": "string", "description": "The id of this base asset in the spot pair." }, "base_asset_ucid": { "type": "string", "description": "The ucid of this base asset in the spot pair." }, "base_asset_name": { "type": "string", "description": "The name of this base asset in the spot pair." }, "base_asset_symbol": { "type": "string", "description": "The symbol of this base asset in the spot pair." }, "base_asset_contract_address": { "type": "string", "description": "The contract addres of this base asset in the spot pair." }, "quote_asset_id": { "type": "string", "description": "The id of this quote asset in the spot pair." }, "quote_asset_ucid": { "type": "string", "description": "The ucid of this quote asset in the spot pair." }, "quote_asset_name": { "type": "string", "description": "The name of this quote asset in the spot pair." }, "quote_asset_symbol": { "type": "string", "description": "The symbol of this quote asset in the spot pair." }, "quote_asset_contract_address": { "type": "string", "description": "The contract addresss of this quote asset in the spot pair." }, "dex_id": { "type": "string", "description": "The id of this dex the spot pair is on." }, "dex_slug": { "type": "string", "description": "The name of this dex the spot pair is on." }, "network_id": { "type": "string", "description": "The id of the network the spot pair is on." }, "network_slug": { "type": "string", "description": "The slug of the network the spot pair is on." }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of the last time this record was updated.", "format": "date-time" }, "created_at": { "type": "string", "description": "Timestamp (ISO 8601) when we started tracking this asset.", "format": "date-time" }, "num_transactions_24h": { "type": "integer", "description": "Number of transactions in past 24 hours", "format": "int64" }, "holders": { "type": "integer", "description": "Number of holders of the asset", "format": "int64" }, "24h_no_of_buys": { "type": "integer", "description": "Number of asset buys in the past 24 hours", "format": "int64" }, "24h_no_of_sells": { "type": "integer", "description": "Number of asset sells in the past 24 hours", "format": "int64" }, "pool_created": { "type": "string", "description": "When the pool of the asset was created", "format": "date-time" }, "buy_tax": { "type": "number", "description": "Buy tax on the asset", "format": "bigdecimal" }, "sell_tax": { "type": "number", "description": "Sell tax on the asset", "format": "bigdecimal" }, "security_scan": { "type": "array", "description": "Security scan by Go+.\n\n\nAll infomation and data relating to contract detection are based on public third party information. CoinMarketCap does not confirm or verify the accuracy or timeliness of such information and data.\n\nCoinMarketCap shall have no responsibility or liability for the accuracy of data, nor have the duty to review, confirm, verify or otherwise perform any inquiry or investigation as to the completeness, accuracy, sufficiency, integrity, reliability or timeliness of any such information or data provided.\n\nOnly returned if passed in aux.", "items": { "$ref": "#/components/schemas/SecurityScanResult" } }, "pool_base_asset": { "type": "number", "description": "Base asset in the pool", "format": "bigdecimal" }, "pool_quote_asset": { "type": "number", "description": "Quote asset in the pool", "format": "bigdecimal" }, "percent_pooled_base_asset": { "type": "number", "description": "Percentage of the base asset in the pool", "format": "bigdecimal" }, "24h_volume_quote_asset": { "type": "number", "description": "24 hours volume of the quote asset", "format": "bigdecimal" }, "total_supply_quote_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "total_supply_base_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "date_launched": { "type": "string", "description": "Timestamp (ISO 8601) of the launch date for this exchange.", "format": "date-time" }, "time_open": { "type": "string", "description": "Timestamp (ISO 8601) of the start of this OHLCV period." }, "time_close": { "type": "string", "description": "Timestamp (ISO 8601) of the end of this OHLCV period. Always null as the current day is incomplete. See last_updated for the last UTC time included in the current OHLCV calculation." } } }, "DexPairsOhlcvHistoricalDTO": { "type": "object", "properties": { "quotes": { "type": "array", "description": "Collection of historical OHLCV quotes for the DEX pair", "items": { "$ref": "#/components/schemas/DexPairsOhlcvHistoricalQuotes" } }, "contract_address": { "type": "string", "description": "The unique contract address for this spot pair." }, "name": { "type": "string", "description": "The name of this spot pair." }, "base_asset_id": { "type": "string", "description": "The id of this base asset in the spot pair." }, "base_asset_ucid": { "type": "string", "description": "The ucid of this base asset in the spot pair." }, "base_asset_name": { "type": "string", "description": "The name of this base asset in the spot pair." }, "base_asset_symbol": { "type": "string", "description": "The symbol of this base asset in the spot pair." }, "base_asset_contract_address": { "type": "string", "description": "The contract addres of this base asset in the spot pair." }, "quote_asset_id": { "type": "string", "description": "The id of this quote asset in the spot pair." }, "quote_asset_ucid": { "type": "string", "description": "The ucid of this quote asset in the spot pair." }, "quote_asset_name": { "type": "string", "description": "The name of this quote asset in the spot pair." }, "quote_asset_symbol": { "type": "string", "description": "The symbol of this quote asset in the spot pair." }, "quote_asset_contract_address": { "type": "string", "description": "The contract addresss of this quote asset in the spot pair." }, "dex_id": { "type": "string", "description": "The id of this dex the spot pair is on." }, "dex_slug": { "type": "string", "description": "The name of this dex the spot pair is on." }, "network_id": { "type": "string", "description": "The id of the network the spot pair is on." }, "network_slug": { "type": "string", "description": "The slug of the network the spot pair is on." }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of the last time this record was updated.", "format": "date-time" }, "created_at": { "type": "string", "description": "Timestamp (ISO 8601) when we started tracking this asset.", "format": "date-time" }, "num_transactions_24h": { "type": "integer", "description": "Number of transactions in past 24 hours", "format": "int64" }, "holders": { "type": "integer", "description": "Number of holders of the asset", "format": "int64" }, "24h_no_of_buys": { "type": "integer", "description": "Number of asset buys in the past 24 hours", "format": "int64" }, "24h_no_of_sells": { "type": "integer", "description": "Number of asset sells in the past 24 hours", "format": "int64" }, "pool_created": { "type": "string", "description": "When the pool of the asset was created", "format": "date-time" }, "buy_tax": { "type": "number", "description": "Buy tax on the asset", "format": "bigdecimal" }, "sell_tax": { "type": "number", "description": "Sell tax on the asset", "format": "bigdecimal" }, "security_scan": { "type": "array", "description": "Security scan by Go+.\n\n\nAll infomation and data relating to contract detection are based on public third party information. CoinMarketCap does not confirm or verify the accuracy or timeliness of such information and data.\n\nCoinMarketCap shall have no responsibility or liability for the accuracy of data, nor have the duty to review, confirm, verify or otherwise perform any inquiry or investigation as to the completeness, accuracy, sufficiency, integrity, reliability or timeliness of any such information or data provided.\n\nOnly returned if passed in aux.", "items": { "$ref": "#/components/schemas/SecurityScanResult" } }, "pool_base_asset": { "type": "number", "description": "Base asset in the pool", "format": "bigdecimal" }, "pool_quote_asset": { "type": "number", "description": "Quote asset in the pool", "format": "bigdecimal" }, "percent_pooled_base_asset": { "type": "number", "description": "Percentage of the base asset in the pool", "format": "bigdecimal" }, "24h_volume_quote_asset": { "type": "number", "description": "24 hours volume of the quote asset", "format": "bigdecimal" }, "total_supply_quote_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "total_supply_base_asset": { "type": "number", "description": "Total supply of the quote asset", "format": "bigdecimal" }, "date_launched": { "type": "string", "description": "Timestamp (ISO 8601) of the launch date for this exchange.", "format": "date-time" } }, "description": "DEX pairs OHLCV historical data" }, "DexPairsOhlcvHistoricalQuotes": { "type": "object", "properties": { "quote": { "type": "array", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "items": { "$ref": "#/components/schemas/DexOhlcvQuote" } }, "time_open": { "type": "string", "description": "Timestamp (ISO 8601) of the start of this OHLCV period.", "format": "date-time" }, "time_close": { "type": "string", "description": "Timestamp (ISO 8601) of the end of this OHLCV period. Always null as the current day is incomplete. See last_updated for the last UTC time included in the current OHLCV calculation.", "format": "date-time" } }, "description": "Historical OHLCV quotes data" }, "NetworkInfoDTO": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this network.", "format": "int32" }, "name": { "type": "string", "description": "The name of this network." }, "alternativeName": { "type": "string", "description": "The alternate name for this network." }, "cryptocurrencyId": { "type": "string", "description": "The unique CoinMarketCap identifier for the cryptocurrency associated with this network." }, "cryptocurrencySlug": { "type": "string", "description": "The slug(URL-friendly name) for the associated cryptocurrency" }, "wrappedTokenId": { "type": "string", "description": "The unique identifier for the wrapped token on this network." }, "wrappedTokenSlug": { "type": "string", "description": "The slug(URL-friendly name) for the wrapped token on this network." }, "tokenExplorerUrl": { "type": "string", "description": "The URL for exploring tokens on this network." }, "poolExplorerUrl": { "type": "string", "description": "The URL for exploring liquidity pools on this network." }, "transactionHashUrl": { "type": "string", "description": "The URL for exploring transaction hashes on this network." }, "network_slug": { "type": "string", "description": "The slug of the network the spot pair is on." } } }, "DexInfoDTO": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this exchange.", "format": "int32" }, "name": { "type": "string", "description": "The name of this exchange." }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this exchange name." }, "logo": { "type": "string", "description": "Link to a CoinMarketCap hosted logo png for this exchange. 64px is default size returned. Replace \"64x64\" in the image path with these alternative sizes: 16, 32, 64, 128, 200" }, "status": { "type": "string", "description": "Current status of the DEX. Can be \"active\" or \"inactive\". " }, "description": { "type": "string", "description": "A CoinMarketCap supplied brief description of this DEX pair. This field will return null if a description is not available." }, "notice": { "type": "string", "description": "A Markdown formatted message outlining a condition that is impacting the availability of the exchange's market data or the secure use of the exchange, otherwise null. This may include a maintenance event on the exchange's end or CoinMarketCap's end, an alert about reported issues with withdrawls from this exchange, or another condition that may be impacting the exchange and it's markets. If present, this notice is also displayed in an alert banner at the top of the exchange's page on coinmarketcap.com." }, "urls": { "$ref": "#/components/schemas/DexUrls" }, "type": { "type": "string", "description": "The type of DEX this exchange is, such as, Orderbook, Swap, and Aggregator." }, "quote": { "type": "array", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "items": { "$ref": "#/components/schemas/DexInfoQuote" } }, "date_launched": { "type": "string", "description": "Timestamp (ISO 8601) of the date this exchange launched. This field is only returned if requested through the aux request parameter.", "format": "date-time" }, "num_market_pairs": { "type": "string", "description": "The number of trading pairs actively tracked on this exchange." }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of the last time this record was updated." }, "market_share": { "type": "number", "description": "Percentage of DEX market share based on volume.", "format": "bigdecimal" } } }, "DexInfoQuote": { "type": "object", "properties": { "convert_id": { "type": "string", "description": "id of specified currency." }, "market_type": { "type": "string", "description": "Type of market data being returned, such as Spot, Perpetual, and Futures. " }, "last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "format": "date-time" }, "volume_24h": { "type": "number", "description": "Reported 24 hour volume in the specified currency." }, "percent_change_volume_24h": { "type": "number", "description": "24 hour volume change percentage in the specified currency. Only applicable for fiat conversions." }, "num_transactions_24h": { "type": "number", "description": "Total number of transactions in the past 24 hours. This field will return null if not available." } }, "description": "DEX exchange quote information" }, "DexUrls": { "type": "object", "properties": { "website": { "type": "array", "description": "Official website URLs.", "items": { "type": "string", "description": "Official website URLs." } }, "blog": { "type": "array", "description": "Official blog URLs.", "items": { "type": "string", "description": "Official blog URLs." } }, "chat": { "type": "array", "description": "Official chat URLs.", "items": { "type": "string", "description": "Official chat URLs." } }, "fee": { "type": "array", "description": "Official web URLs covering exchange fees.", "items": { "type": "string", "description": "Official web URLs covering exchange fees." } }, "twitter": { "type": "array", "description": "Official twitter profile URLs.", "items": { "type": "string", "description": "Official twitter profile URLs." } } }, "description": "An object containing various resource URLs for this exchange." }, "DexCommonInfoDTO": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this exchange.", "format": "int32" }, "name": { "type": "string", "description": "The name of this exchange." }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this exchange name." }, "logo": { "type": "string", "description": "Link to a CoinMarketCap hosted logo png for this exchange. 64px is default size returned. Replace \"64x64\" in the image path with these alternative sizes: 16, 32, 64, 128, 200" }, "status": { "type": "string", "description": "Current status of the DEX. Can be \"active\" or \"inactive\". " }, "description": { "type": "string", "description": "A CoinMarketCap supplied brief description of this DEX pair. This field will return null if a description is not available." }, "notice": { "type": "string", "description": "A Markdown formatted message outlining a condition that is impacting the availability of the exchange's market data or the secure use of the exchange, otherwise null. This may include a maintenance event on the exchange's end or CoinMarketCap's end, an alert about reported issues with withdrawls from this exchange, or another condition that may be impacting the exchange and it's markets. If present, this notice is also displayed in an alert banner at the top of the exchange's page on coinmarketcap.com." }, "urls": { "$ref": "#/components/schemas/DexUrls" }, "date_launched": { "type": "string", "description": "Timestamp (ISO 8601) of the date this exchange launched. This field is only returned if requested through the aux request parameter.", "format": "date-time" } } }, "NextUnlockedDTO": { "type": "object", "properties": { "date": { "type": "string", "description": "Timestamp (ISO 8601) of when the next token unlock is." }, "token_amount": { "type": "number", "description": "The amount of token that will be unlocked in terms of your specified currency. Only USD is supported at the moment.", "format": "bigdecimal" }, "token_amount_by_base_asset": { "type": "number", "description": "The amount of tokens that will be unlocked.", "format": "bigdecimal" }, "token_amount_percentage": { "type": "number", "description": "The percentage of the tokens that will be unlocked.", "format": "bigdecimal" } }, "description": "The breakdown of the next token unlock. " }, "NextUnlockedDetailDTO": { "type": "object", "properties": { "allocation_name": { "type": "string", "description": "The name of the allocation. " }, "vesting_type": { "type": "string", "description": "The type of vesting schedule. One of these 4:\n\nCliff = single event where some tokens are released.\nLinear = when the same amount of tokens is released with a certain frequency until a certain date. \nInflationary = when an increasing amount of tokens is released with a certain rate and frequency until a certain date.\nDeflationary = when a decreasing amount of tokens is released with a certain rate and frequency until a certain date." }, "token_amount": { "type": "number", "description": "The amount of token that will be unlocked in terms of your specified currency. Only USD is supported at the moment. ", "format": "bigdecimal" }, "token_amount_by_base_asset": { "type": "number", "description": "The amount of token that will be unlocked.", "format": "bigdecimal" } }, "description": "Timestamp (ISO 8601) of when this was last updated. " }, "TokenUnlockInfoDTO": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency. ", "format": "int32" }, "name": { "type": "string", "description": "The name of this cryptocurrency. " }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency." }, "slug": { "type": "string", "description": " The web URL friendly shorthand version of this cryptocurrency name." }, "status": { "type": "string", "description": "Current status of the cryptocurrency. Can be \"active\" or \"inactive\". " }, "lastUpdated": { "type": "string", "description": "Timestamp (ISO 8601) of when the next token unlock is." }, "approveTime": { "type": "string", "description": "Timestamp (ISO 8601) of when the token unlock data is reviewed and approved." }, "cmc_rank": { "type": "integer", "description": "CoinMarketCap's market cap rank as outlined in our methodology (https://coinmarketcap.com/methodology/). ", "format": "int32" }, "circulating_supply": { "type": "number", "description": "The approximate number of coins circulating for this cryptocurrency at the end of the requested UTC day. ", "format": "bigdecimal" }, "max_supply": { "type": "number", "description": "The expected maximum limit of coins ever to be available for this cryptocurrency. ", "format": "bigdecimal" }, "total_supply": { "type": "number", "description": "The approximate total amount of coins in existence right now (minus any coins that have been verifiably burned). ", "format": "bigdecimal" }, "infinite_supply": { "type": "boolean", "description": "The cryptocurrency is known to have an infinite supply." }, "self_reported_circulating_supply": { "type": "number", "description": "The self reported number of coins circulating for this cryptocurrency.", "format": "bigdecimal" }, "token_locked_amount": { "type": "number", "description": "The total amount of tokens of this cryptocurrency is locked at the moment. ", "format": "bigdecimal" }, "token_unlocked_amount": { "type": "number", "description": "The total amount of tokens of this cryptocurrency that has been unlocked at the moment. ", "format": "bigdecimal" }, "next_unlock": { "$ref": "#/components/schemas/NextUnlockedDTO" }, "next_unlock_detail": { "type": "array", "description": "Timestamp (ISO 8601) of when this was last updated. ", "items": { "$ref": "#/components/schemas/NextUnlockedDetailDTO" } } } }, "TokenEventDTO": { "type": "object", "properties": { "time": { "type": "string", "description": "Timestamp (ISO 8601) of when the next token unlock is.", "format": "date-time" }, "allocations": { "type": "array", "description": "The details of the allocations. ", "items": { "$ref": "#/components/schemas/NextUnlockedDetailDTO" } }, "total_token_amount": { "type": "number", "description": "The amount of token that will be unlocked in terms of your specified currency. Only USD is supported at the moment." }, "total_token_amount_by_base_asset": { "type": "number", "description": "The amount of tokens that will be unlocked." } }, "description": "The breakdown of the next token unlock. " }, "TokenUnlockEventDTO": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency. ", "format": "int32" }, "token_event": { "type": "array", "description": "The breakdown of the next token unlock. ", "items": { "$ref": "#/components/schemas/TokenEventDTO" } } } }, "IndexDetailDTO": { "properties": { "id": { "description": "The unique CoinMarketCap ID for this cryptocurrency.", "format": "int32", "type": "integer" }, "name": { "description": "The name of this cryptocurrency.", "type": "string" }, "symbol": { "description": "The ticker symbol for this cryptocurrency.", "type": "string" }, "url": { "description": "The URL of the detail page on CoinMarketCap for this cryptocurrency.", "type": "string" }, "weight": { "description": "The relative proportion of this constituent within the index expressed as a percentage.", "format": "bigdecimal", "type": "number" } }, "type": "object" }, "IndexLatestDTO": { "description": "The latest CoinMarketCap 100 Index value is returned in this object.", "properties": { "constituents": { "description": "Array detailing the list of constituents and their weightage.", "items": { "$ref": "#/components/schemas/IndexDetailDTO" }, "type": "array" }, "last_update": { "description": "Timestamp (ISO 8601) of the last time this record was updated.", "type": "string", "format": "date" }, "next_update": { "description": "Timestamp (ISO 8601) of the next time this record will be updated.", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "type": "string" }, "value": { "description": "Current value of CoinMarketCap 100 Index.", "format": "bigdecimal", "type": "number" }, "value_24h_percentage_change": { "description": "Percentage change of the CoinMarketCap 100 Index over the past 24h. ", "format": "bigdecimal", "type": "number" } }, "type": "object" }, "IndexHistoricalDTO": { "properties": { "constituents": { "description": "Array detailing the list of constituents and their weightage.", "items": { "$ref": "#/components/schemas/IndexDetailDTO" }, "type": "array" }, "update_time": { "description": "Timestamp (ISO 8601) of the time this record was updated.", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "type": "string" }, "value": { "description": "Value of CoinMarketCap 100 Index.", "format": "bigdecimal", "type": "number" } }, "type": "object" }, "FearGreedLatestDTO": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "update_time": { "type": "string" }, "value_classification": { "type": "string" } } }, "FearGreedHistoricalDTO": { "type": "object", "properties": { "timestamp": { "type": "string" }, "value": { "type": "integer", "format": "int32" }, "value_classification": { "type": "string" } } }, "CryptoQuoteV3DTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "slug": { "type": "string" }, "platform": { "anyOf": [ { "$ref": "#/components/schemas/Platform" }, { "type": "null" } ] }, "quote": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/CryptoTag" } }, "is_active": { "type": "integer", "format": "int32" }, "infinite_supply": { "type": "boolean" }, "is_market_cap_included_in_calc": { "type": "integer", "format": "int32" }, "is_fiat": { "type": "integer", "format": "int32" }, "circulating_supply": { "type": "number", "description": "Circulating supply of the cryptocurrency", "format": "bigdecimal" }, "total_supply": { "type": "number", "description": "Total supply of the cryptocurrency", "format": "bigdecimal" }, "max_supply": { "type": [ "number", "null" ], "description": "Maximum supply of the cryptocurrency", "format": "bigdecimal" }, "date_added": { "type": "string" }, "num_market_pairs": { "type": "integer", "format": "int32" }, "cmc_rank": { "type": "integer", "format": "int32" }, "last_updated": { "type": "string" }, "tvl_ratio": { "type": [ "number", "null" ], "description": "TVL to market cap ratio", "format": "bigdecimal" }, "self_reported_circulating_supply": { "type": [ "number", "null" ], "description": "Self-reported circulating supply", "format": "bigdecimal" }, "self_reported_market_cap": { "type": [ "number", "null" ], "description": "Self-reported market capitalization", "format": "bigdecimal" }, "unlocked_circulating_supply": { "type": "number", "description": "Unlocked circulating supply", "format": "bigdecimal" }, "unlocked_market_cap": { "type": "number", "description": "Unlocked market capitalization", "format": "bigdecimal" }, "minted_market_cap": { "type": "number", "description": "Market cap calculated from the minted supply, in the requested currency." } } }, "CryptoTag": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" } } }, "Platform": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "slug": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "token_address": { "type": "string" } } }, "Quote": { "type": "object", "properties": { "id": { "type": "integer", "description": "Currency ID", "format": "int32" }, "symbol": { "type": "string", "description": "Currency symbol" }, "price": { "type": "number", "description": "Current price in the specified currency", "format": "bigdecimal" }, "volume_24h": { "type": "number", "description": "24-hour trading volume", "format": "bigdecimal" }, "cex_volume_24h": { "type": "number", "description": "24-hour trading volume from centralized exchanges", "format": "bigdecimal" }, "dex_volume_24h": { "type": "number", "description": "24-hour trading volume from decentralized exchanges", "format": "bigdecimal" }, "volume_24h_reported": { "type": "number", "description": "Reported 24-hour trading volume", "format": "bigdecimal" }, "volume_7d": { "type": "number", "description": "7-day trading volume", "format": "bigdecimal" }, "volume_7d_reported": { "type": "number", "description": "Reported 7-day trading volume", "format": "bigdecimal" }, "volume_30d": { "type": "number", "description": "30-day trading volume", "format": "bigdecimal" }, "volume_30d_reported": { "type": "number", "description": "Reported 30-day trading volume", "format": "bigdecimal" }, "volume_change_24h": { "type": "number", "description": "24-hour volume change percentage", "format": "bigdecimal" }, "percent_change_1h": { "type": "number", "description": "1-hour percentage change", "format": "bigdecimal" }, "percent_change_24h": { "type": "number", "description": "24-hour percentage change", "format": "bigdecimal" }, "percent_change_7d": { "type": "number", "description": "7-day percentage change", "format": "bigdecimal" }, "percent_change_30d": { "type": "number", "description": "30-day percentage change", "format": "bigdecimal" }, "percent_change_60d": { "type": "number", "description": "60-day percentage change", "format": "bigdecimal" }, "percent_change_90d": { "type": "number", "description": "90-day percentage change", "format": "bigdecimal" }, "market_cap": { "type": "number", "description": "Current market capitalization", "format": "bigdecimal" }, "market_cap_dominance": { "type": "number", "description": "Market cap dominance percentage", "format": "bigdecimal" }, "fully_diluted_market_cap": { "type": "number", "description": "Fully diluted market capitalization", "format": "bigdecimal" }, "minted_market_cap": { "type": "number", "description": "Minted market capitalization", "format": "bigdecimal" }, "tvl": { "type": [ "number", "null" ], "description": "Total Value Locked", "format": "bigdecimal" }, "market_cap_by_total_supply": { "type": "number", "description": "Market cap calculated by total supply", "format": "bigdecimal" }, "last_updated": { "type": "string", "description": "Last updated timestamp" } } }, "CryptoListingDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "slug": { "type": "string" }, "platform": { "anyOf": [ { "$ref": "#/components/schemas/Platform" }, { "type": "null" } ] }, "quote": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "tags": { "type": "array", "items": { "type": "string" } }, "is_active": { "type": "integer", "format": "int32" }, "infinite_supply": { "type": "boolean" }, "is_market_cap_included_in_calc": { "type": "integer", "format": "int32" }, "is_fiat": { "type": "integer", "format": "int32" }, "circulating_supply": { "type": "number", "description": "Circulating supply of the cryptocurrency", "format": "bigdecimal" }, "total_supply": { "type": "number", "description": "Total supply of the cryptocurrency", "format": "bigdecimal" }, "max_supply": { "type": [ "number", "null" ], "description": "Maximum supply of the cryptocurrency", "format": "bigdecimal" }, "date_added": { "type": "string" }, "num_market_pairs": { "type": "integer", "format": "int32" }, "cmc_rank": { "type": "integer", "format": "int32" }, "last_updated": { "type": "string" }, "tvl_ratio": { "type": [ "number", "null" ], "description": "TVL to market cap ratio", "format": "bigdecimal" }, "self_reported_circulating_supply": { "type": ["number", "null"], "description": "Self-reported circulating supply", "format": "bigdecimal" }, "self_reported_market_cap": { "type": ["number", "null"], "description": "Self-reported market capitalization", "format": "bigdecimal" }, "minted_market_cap": { "type": "number", "description": "Minted market capitalization", "format": "bigdecimal" }, "unlocked_circulating_supply": { "type": "number", "description": "Unlocked circulating supply", "format": "bigdecimal" }, "unlocked_market_cap": { "type": "number", "description": "Unlocked market capitalization", "format": "bigdecimal" } } }, "TokenLiquiditySnapshotDTO": { "type": "object", "properties": { "snapshotTime": { "type": "integer", "format": "int64" }, "liquidityUsd": { "type": "number" }, "liquidity": { "type": "number" } } }, "SwapListResponseDTO": { "type": "object", "properties": { "swaps": { "type": "array", "description": "List of swap transactions", "items": { "$ref": "#/components/schemas/TradeHistoryDTO" } }, "lastId": { "type": "string", "description": "Last ID for pagination" } }, "description": "Swap list response data" }, "TagDTO": { "type": "object", "properties": { "name": { "type": "string", "description": "Tag type" }, "value": { "type": "integer", "description": "Tag value", "format": "int32" } }, "description": "Tag of swap tx" }, "TradeHistoryDTO": { "type": "object", "properties": { "ts": { "type": "string", "description": "Transaction time (timestamp)" }, "tp": { "type": "string", "description": "Transaction type (buy/sell)" }, "t0a": { "type": "string", "description": "Base token address" }, "t1a": { "type": "string", "description": "Quote token address" }, "t0s": { "type": "string", "description": "Base token symbol" }, "t1s": { "type": "string", "description": "Quote token symbol" }, "eid": { "type": "integer", "description": "exchange id", "format": "int32" }, "en": { "type": "string", "description": "exchange name" }, "f": { "type": "string", "description": "factory address" }, "a0": { "type": "number", "description": "Base token amount" }, "a1": { "type": "number", "description": "Quote token amount" }, "t0pu": { "type": "number", "description": "Price in USD" }, "t1pu": { "type": "number", "description": "Price in USD" }, "q": { "type": "number", "description": "Price in quote" }, "v": { "type": "number", "description": "Total transaction value in USD" }, "qi": { "type": "integer", "description": "quoteIndex", "format": "int32" }, "ma": { "type": "string", "description": "Maker address" }, "ex": { "type": "boolean", "description": "exclude" }, "txtp": { "type": "integer", "description": "exclude", "format": "int32" }, "tx": { "type": "string", "description": "Transaction hash" }, "h": { "type": "string", "description": "height" }, "txId": { "type": "string", "description": "txId" }, "lgid": { "type": "string", "description": "Log ID" }, "t0t": { "type": "boolean", "description": "t0top" }, "t1t": { "type": "boolean", "description": "t1top" }, "tags": { "type": "array", "description": "holder tags", "items": { "$ref": "#/components/schemas/TagDTO" } }, "tc": { "type": "string", "description": "transaction count" }, "kn": { "type": "string", "description": "kol name" }, "kpn": { "type": "string", "description": "kol public name" }, "klu": { "type": "string", "description": "kol logo url" }, "t0pt": { "type": "string", "description": "Token0 position type (open/close/add/reduce)" }, "t1pt": { "type": "string", "description": "Token1 position type (open/close/add/reduce)" } }, "description": "Swap transaction data" }, "BnSecurityExtraInfoDTO": { "type": "object", "properties": { "buyTax": { "type": "string", "description": "Buy tax" }, "sellTax": { "type": "string", "description": "Sell tax" }, "isFlaggedByVendor": { "type": "boolean", "description": "Whether the token is flagged by third-party security vendors", "example": false }, "isVerified": { "type": "boolean", "description": "Whether the token contract is verified", "example": true }, "isReported": { "type": "boolean", "description": "Whether the token has been reported by users or security platforms", "example": false }, "source": { "type": "string", "description": "Data source of the security information", "example": "GoPlus" } }, "description": "Extra security metadata provided by external vendors or on-chain analysis" }, "DisplayItem": { "type": "object", "properties": { "honeypotStatus": { "type": "string", "description": "EVM - Honeypot status", "example": "Safe" }, "unverifiedContractStatus": { "type": "string", "description": "EVM - Unverified contract status", "example": "Verified" }, "mintableStatus": { "type": "string", "description": "Solana - Mintable token status", "example": "Non-mintable" }, "freezableStatus": { "type": "string", "description": "Solana - Freezable status", "example": "Non-freezable" }, "rugPullStatus": { "type": "string", "description": "Solana - Rug pull detection", "example": "No risk" }, "fakeTokenStatus": { "type": "string", "description": "Solana - Fake token detection", "example": "Genuine" } }, "description": "Security item display flags for EVM or Solana" }, "SecurityItem": { "type": "object", "properties": { "code": { "type": "string", "description": "Rule code" }, "riskCode": { "type": "string", "description": "Risk classification code" }, "riskyLevel": { "type": "string", "description": "Risk level" }, "isHit": { "type": "boolean", "description": "Whether the risk was hit", "example": true }, "order": { "type": "integer", "description": "Display order", "format": "int32" }, "des": { "type": "string", "description": "Risk description" }, "groupId": { "type": "string", "description": "Group ID for categorization" } }, "description": "Detailed security item" }, "TokenSecurityResponseDTO": { "type": "object", "properties": { "platformName": { "type": "string", "description": "Platform name", "example": "ethereum" }, "platformId": { "type": "integer", "description": "Platform ID", "format": "int32", "example": 1 }, "tokenContractAddress": { "type": "string", "description": "Token contract address", "example": "0xabc123..." }, "securityLevel": { "type": "string", "description": "Overall security level" }, "categoryLevel": { "type": "string", "description": "Overall category level" }, "securityBatchLevel": { "type": "integer", "description": "Overall security batch level", "format": "int32" }, "extra": { "$ref": "#/components/schemas/BnSecurityExtraInfoDTO" }, "securityItems": { "type": "array", "description": "Detailed security items", "items": { "$ref": "#/components/schemas/SecurityItem" } }, "evmDisplay": { "$ref": "#/components/schemas/DisplayItem" }, "solanaDisplay": { "$ref": "#/components/schemas/DisplayItem" }, "exist": { "type": "boolean", "description": "token security exist" }, "tags": { "type": "array", "description": "token security exist", "items": { "type": "string", "description": "token security exist" } } }, "description": "Token security response" }, "SearchResponseDTO": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "tks": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResultDTO" } } } }, "SearchResultDTO": { "type": "object", "properties": { "pltId": { "type": "integer", "format": "int32" }, "plt": { "type": "string" }, "plti": { "type": "integer", "format": "int32" }, "n": { "type": "string" }, "s": { "type": "string" }, "addr": { "type": "string" }, "pt": { "type": "string" }, "lt": { "type": "string" }, "w": { "type": "string" }, "x": { "type": "string" }, "l": { "type": "string" }, "pu": { "type": "string" }, "pc24h": { "type": "number", "format": "float" }, "dec": { "type": "integer", "format": "int32" }, "tsup": { "type": "string" }, "fpt": { "type": "string" }, "fpct": { "type": "string" }, "v24h": { "type": "number" }, "fdv": { "type": "number" }, "mc": { "type": "number" }, "liq": { "type": "number" }, "ts": { "type": "string" }, "lf": { "type": "integer", "format": "int32" }, "cid": { "type": "integer", "format": "int32" }, "bnCid": { "type": "string" }, "ut24h": { "type": "string" }, "ecs": { "type": "integer", "description": "Binance exclusive code, 1 - exclusive", "format": "int32" }, "ssc": { "type": "number", "description": "Search relevance score", "format": "float" }, "pin": { "type": "string", "description": "Comma-separated pinned types based on sort fields: ido,alpha,trending or null" } } }, "PlatformDTO": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique platform ID", "format": "int32", "example": 14 }, "n": { "type": "string", "description": "Platform name", "example": "Ethereum" }, "i": { "type": "string", "description": "Icon URL for the platform", "example": "https://cdn.example.com/icons/eth.png" }, "uf": { "type": "string", "description": "URL format for block explorer (contract/token)", "example": "https://etherscan.io/token/{tokenAddress}" }, "dn": { "type": "string", "description": "Number of supported DEXs on this platform", "example": "12" }, "txuf": { "type": "string", "description": "URL format for viewing transactions", "example": "https://etherscan.io/tx/{txHash}" }, "v": { "type": "boolean", "description": "Whether the platform is visible in the UI", "example": true }, "p": { "type": "boolean", "description": "Whether the platform is pinned (e.g., prioritized display)", "example": false }, "addrUrl": { "type": "string", "description": "URL format for address explorer", "example": "https://etherscan.io/address/{address}" }, "chId": { "type": "integer", "description": "Internal chain ID", "format": "int32", "example": 1 }, "puf": { "type": "string", "description": "URL format for pool explorer", "example": "https://dexscan.io/pool/{poolAddress}" }, "wcId": { "type": "integer", "description": "Wrapped native token ID (e.g., WETH)", "format": "int32", "example": 2001 }, "hl": { "type": "integer", "description": "Whether the platform is highlighted", "format": "int32", "example": 1 }, "ho": { "type": "integer", "description": "Display order for highlighted platforms", "format": "int32", "example": 3 }, "pltA": { "type": "string", "description": "platform acronym", "example": "ETH" }, "cid": { "type": "integer", "format": "int32" }, "na": { "type": "string", "description": "Address used for this platform's native coin, for example `0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee` on EVM chains." } }, "description": "Data Transfer Object representing a supported blockchain platform" }, "LiquidityChangeDTO": { "type": "object", "properties": { "ts": { "type": "string" }, "tp": { "type": "string" }, "eid": { "type": "integer", "description": "exchange id", "format": "int32" }, "en": { "type": "string", "description": "exchange name" }, "f": { "type": "string", "description": "factory address" }, "t0a": { "type": "string", "description": "Base token address" }, "t1a": { "type": "string", "description": "Quote token address" }, "t0s": { "type": "string" }, "t1s": { "type": "string" }, "a0": { "type": "number" }, "a1": { "type": "number" }, "tu": { "type": "number" }, "m": { "type": "string" }, "txn": { "type": "string" }, "h": { "type": "string" }, "txId": { "type": "string" }, "lgid": { "type": "string" } }, "description": "List of liquidity change transactions" }, "LiquidityChangeListResponseDTO": { "type": "object", "properties": { "lastId": { "type": "string", "description": "Last ID for pagination" }, "lcs": { "type": "array", "description": "List of liquidity change transactions", "items": { "$ref": "#/components/schemas/LiquidityChangeDTO" } }, "tlu": { "type": "number", "description": "total liquidity usd value" }, "lpc": { "type": "string", "description": "liquidity pool count" } }, "description": "Swap list response data" }, "DqueryHoldersDetailRequestDTO": { "type": "object", "properties": { "tokenAddress": { "type": "string", "description": "Token contract address", "example": "0x1234567890abcdef1234567890abcdef12345678" }, "walletAddress": { "type": "string", "description": "Wallet address", "example": "0xabcdef1234567890abcdef1234567890abcdef12" }, "platform": { "type": "string", "description": "Blockchain platform", "example": "ethereum" }, "tag": { "type": "string", "description": "tag enum [tag_all, tag_kol, tag_smart_money, tag_whale, tag_bot, tag_sniper, tag_dev]", "example": "tag_all" } }, "description": "holders detail request" }, "DqueryHoldersRequestDTO": { "type": "object", "properties": { "tokenAddress": { "type": "string", "description": "Token contract address", "example": "0x1234567890abcdef1234567890abcdef12345678" }, "platform": { "type": "string", "description": "Blockchain platform", "example": "ethereum" }, "tag": { "type": "string", "description": "tag enum [tag_all, tag_kol, tag_smart_money, tag_whale, tag_bot, tag_sniper, tag_dev]", "example": "tag_all" } }, "description": "holders request" }, "HolderCountVO": { "type": "object", "properties": { "platformId": { "type": "integer", "format": "int32" }, "count": { "type": "string" }, "tokenAddress": { "type": "string" } } }, "HolderDetailVO": { "type": "object", "properties": { "blockHeight": { "type": "string" }, "firstActiveTime": { "type": "string" }, "netBuyAmount": { "type": "string" }, "realizedPnlPercent": { "type": "string" }, "spotPosition": { "type": "string" }, "buyVolume": { "type": "string" }, "sellVolume": { "type": "string" }, "buyUsd": { "type": "string" }, "sellUsd": { "type": "string" }, "buyCount": { "type": "string" }, "sellCount": { "type": "string" }, "avgBuyPriceUsd": { "type": "string" }, "avgSellPriceUsd": { "type": "string" }, "realizedPnl": { "type": "string" }, "actualBalance": { "type": "string" }, "price": { "type": "string" }, "walletAddress": { "type": "string" }, "tokenAddress": { "type": "string" }, "platformId": { "type": "integer", "format": "int32" }, "percent": { "type": "string" }, "balance": { "type": "string" }, "totalSupply": { "type": "string" }, "tokenAccount": { "type": "string" }, "logoUrl": { "type": "string" }, "name": { "type": "string" }, "publicName": { "type": "string" }, "tags": { "type": "string" }, "addressExplorerUrl": { "type": "string" }, "symbol": { "type": "string" }, "nativeBalance": { "type": "string" }, "fundingSource": { "type": "string" }, "fundingTime": { "type": "string" }, "lastActiveTime": { "type": "string" }, "walletCreateTime": { "type": "integer", "format": "int64" }, "spotOpenTs": { "type": "string" }, "spotClearanceTs": { "type": "string" }, "tokenLogo": { "type": "string" }, "tokenSymbol": { "type": "string" }, "platformCryptoId": { "type": "integer", "format": "int32" }, "dexerPlatformName": { "type": "string" }, "lowLiquidityFlag": { "type": "integer", "format": "int32" }, "memePumpInnerFlag": { "type": "integer", "format": "int32" }, "blackListFlag": { "type": "integer", "format": "int32" }, "stableCoinFlag": { "type": "integer", "format": "int32" }, "riskLevelFlag": { "type": "integer", "format": "int32" } } }, "HolderDexVO": { "type": "object", "properties": { "holders": { "type": "array", "items": { "$ref": "#/components/schemas/HolderDetailVO" } } } }, "HolderTagCountVO": { "type": "object", "properties": { "holders": { "type": "array", "items": { "$ref": "#/components/schemas/HolderTagItem" } }, "platformId": { "type": "integer", "format": "int32" }, "tokenAddress": { "type": "string" } } }, "HolderTagItem": { "type": "object", "properties": { "tag": { "type": "string" }, "hc": { "type": "string" }, "tb": { "type": "string" }, "hr": { "type": "string" } } }, "HolderTrendVO": { "type": "object", "properties": { "ts": { "type": "string" }, "endTs": { "type": "string" }, "platform": { "type": "integer", "format": "int32" }, "tokenAddress": { "type": "string" }, "holders": { "type": "string" }, "holdingRatioOfTop100": { "type": "string" }, "holdingRatioOfTop50": { "type": "string" }, "holdingRatioOfTop10": { "type": "string" }, "totalBalanceOfTop100": { "type": "string" }, "totalBalanceOfTop50": { "type": "string" }, "totalBalanceOfTop10": { "type": "string" }, "biggerThan10DHolders": { "type": "string" }, "avgBalanceAllHolders": { "type": "string" }, "avgBalanceOfTop100": { "type": "string" }, "avgPositionCostOfTop100": { "type": "string" }, "avgSellPriceOfTop100": { "type": "string" }, "tagHolder": { "type": "string" }, "avgBalanceUSDAllHolders": { "type": "string" }, "avgBalanceUSDOfTop100": { "type": "string" }, "tagHolderTTHM": { "type": "string" }, "price": { "type": "string" } } }, "ApiResponseOfIndexHistoricalResponseDTO": { "properties": { "data": { "$ref": "#/components/schemas/IndexHistoricalDpsDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "type": "object" }, "ApiResponseOfIndexLatestResponseDTO": { "properties": { "data": { "$ref": "#/components/schemas/IndexLatestDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"], "type": "object" }, "IndexHistoricalDpsDTO": { "items": { "$ref": "#/components/schemas/IndexHistoricalDTO" }, "type": "array" }, "ApiResponseOfCMC20IndexHistoricalResponseDTO": { "properties": { "data": { "$ref": "#/components/schemas/CMC20IndexHistoricalDpsDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "type": "object" }, "ApiResponseOfCMC20IndexLatestResponseDTO": { "properties": { "data": { "$ref": "#/components/schemas/CMC20IndexLatestDTO" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"], "type": "object" }, "CMC20IndexDetailDTO": { "properties": { "id": { "description": "The unique CoinMarketCap ID for this cryptocurrency.", "format": "int32", "type": "integer" }, "name": { "description": "The name of this cryptocurrency.", "type": "string" }, "symbol": { "description": "The ticker symbol for this cryptocurrency.", "type": "string" }, "url": { "description": "The URL of the detail page on CoinMarketCap for this cryptocurrency.", "type": "string" }, "weight": { "description": "The relative proportion of this constituent within the index expressed as a percentage.", "format": "bigdecimal", "type": "number" }, "priceUsd": { "description": "The price of this cryptocurrency in USD.", "format": "bigdecimal", "type": "number" }, "units": { "description": "The units of this cryptocurrency.", "format": "bigdecimal", "type": "number" } }, "type": "object" }, "CMC20IndexHistoricalDTO": { "properties": { "constituents": { "description": "Array detailing the list of constituents and their weightage.", "items": { "$ref": "#/components/schemas/CMC20IndexDetailDTO" }, "type": "array" }, "update_time": { "description": "Timestamp (ISO 8601) of the time this record was updated.", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "type": "string" }, "value": { "description": "Value of CoinMarketCap 20 Index.", "format": "bigdecimal", "type": "number" } }, "type": "object" }, "CMC20IndexHistoricalDpsDTO": { "items": { "$ref": "#/components/schemas/CMC20IndexHistoricalDTO" }, "type": "array" }, "CMC20IndexLatestDTO": { "description": "The latest CoinMarketCap 20 Index value is returned in this object.", "properties": { "constituents": { "description": "Array detailing the list of constituents and their weightage.", "items": { "$ref": "#/components/schemas/CMC20IndexDetailDTO" }, "type": "array" }, "last_update": { "description": "Timestamp (ISO 8601) of the last time this record was updated.", "type": "string", "format": "date" }, "next_update": { "description": "Timestamp (ISO 8601) of the next time this record will be updated.", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "type": "string" }, "value": { "description": "Current value of CoinMarketCap 20 Index.", "format": "bigdecimal", "type": "number" }, "value_24h_percentage_change": { "description": "Percentage change of the CoinMarketCap 20 Index over the past 24h. ", "format": "bigdecimal", "type": "number" } }, "type": "object" }, "Model_1": { "type": "object", "properties": { "cover": { "type": "string" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "source_name": { "type": "string" }, "source_url": { "type": "string" }, "type": { "type": "string" }, "assets": { "$ref": "#/components/schemas/assets_array" }, "created_at": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the time this was created.", "example": "2018-06-02T23:59:59.999Z" }, "released_at": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the time this was released.", "example": "2018-06-02T23:59:59.999Z" }, "language": { "type": "string", "description": "Language code of this content item, for example `en`." }, "news_type": { "type": "string", "description": "Type of this content item, for example `news`. Matches the `news_type` filter." } } }, "Content_Latest_-_Results_array": { "type": "array", "description": "Array of content objects.", "items": { "$ref": "#/components/schemas/Model_1" } }, "API_Status_Object": { "type": "object", "description": "Standardized status object for API calls.", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Current timestamp (ISO 8601) on the server.", "example": "2026-03-05T22:43:48.471Z" }, "error_code": { "type": [ "integer", "string" ], "description": "An internal error code for the current error. If a unique platform error code is not available the HTTP status code is returned. `0` is returned if there is no error. Some endpoints return this code as a string, for example `\"0\"`." }, "error_message": { "type": ["string", "null"], "description": "An error message to go along with the error code.", "example": "" }, "elapsed": { "type": "integer", "description": "Number of milliseconds taken to generate this response.", "example": 10 }, "credit_count": { "type": "integer", "description": "Number of API call credits that were used for this call.", "example": 1 }, "notice": { "type": ["string", "null"], "description": "Optional notice about API key information.", "example": "" }, "total_count": { "type": "integer", "description": "Total number of results available for this request. Only returned by some list endpoints.", "example": 8128 } }, "required": ["timestamp", "error_code", "error_message", "elapsed", "credit_count"] }, "Content_Latest_-_Response_Model": { "type": "object", "example": { "data": [ { "cover": "https://academy-public.coinmarketcap.com/optimized-uploads/0aec0502868046419ceace229f92601f.gif", "assets": [ { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum" } ], "created_at": "2021-05-05T00:00:00Z", "released_at": "2021-05-05T00:00:00Z", "title": "Article Title", "subtitle": "Article Subtitle", "type": "alexandria", "source_name": "Connor Sephton", "source_url": "https://coinmarketcap.com/alexandria/article/coinmarketcap-news-august-9-u-s-comes-for-tornado-cash" } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Content_Latest_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data", "status"] }, "HTTP_Status_400_Error_Object": { "type": "object", "description": "Bad Request", "properties": { "status": { "$ref": "#/components/schemas/status" } } }, "status_1": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Current ISO 8601 timestamp on the server.", "example": "2018-06-02T22:51:28.209Z" }, "error_code": { "type": "integer", "description": "An internal error code for the current error. If a unique platform error code is not available the HTTP status code is returned.", "example": 1002, "default": 401 }, "error_message": { "type": "string", "description": "An error message to go along with the error code.", "example": "API key missing." }, "elapsed": { "type": "integer", "description": "Number of milliseconds taken to generate this response", "example": 10 }, "credit_count": { "type": "integer", "description": "Number of API call credits required for this call. Always 0 for errors.", "example": 0 } }, "required": ["timestamp", "error_code", "error_message", "elapsed", "credit_count"] }, "HTTP_Status_401_Error_Object": { "type": "object", "description": "Unauthorized", "properties": { "status": { "$ref": "#/components/schemas/status_1" } } }, "status_2": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Current ISO 8601 timestamp on the server.", "example": "2018-06-02T22:51:28.209Z" }, "error_code": { "type": "integer", "description": "An internal error code for the current error. If a unique platform error code is not available the HTTP status code is returned.", "example": 1006, "default": 403 }, "error_message": { "type": "string", "description": "An error message to go along with the error code.", "example": "Your API Key subscription plan doesn't support this endpoint." }, "elapsed": { "type": "integer", "description": "Number of milliseconds taken to generate this response", "example": 10 }, "credit_count": { "type": "integer", "description": "Number of API call credits required for this call. Always 0 for errors.", "example": 0 } }, "required": ["timestamp", "error_code", "error_message", "elapsed", "credit_count"] }, "HTTP_Status_403_Error_Object": { "type": "object", "description": "Forbidden", "properties": { "status": { "$ref": "#/components/schemas/status_2" } } }, "status_3": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Current ISO 8601 timestamp on the server.", "example": "2018-06-02T22:51:28.209Z" }, "error_code": { "type": "integer", "description": "An internal error code string for the current error. If a unique platform error code is not available the HTTP status code is returned.", "example": 1008, "default": 429 }, "error_message": { "type": "string", "description": "An error message to go along with the error code.", "example": "You've exceeded your API Key's HTTP request rate limit. Rate limits reset every minute." }, "elapsed": { "type": "integer", "description": "Number of milliseconds taken to generate this response", "example": 10 }, "credit_count": { "type": "integer", "description": "Number of API call credits required for this call. Always 0 for errors.", "example": 0 } }, "required": ["timestamp", "error_code", "error_message", "elapsed", "credit_count"] }, "HTTP_Status_429_Error_Object": { "type": "object", "description": "Too Many Requests", "properties": { "status": { "$ref": "#/components/schemas/status_3" } } }, "status_4": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Current ISO 8601 timestamp on the server.", "example": "2018-06-02T22:51:28.209Z" }, "error_code": { "type": "integer", "description": "An internal error code string for the current error. If a unique platform error code is not available the HTTP status code is returned.", "default": 500, "enum": [500] }, "error_message": { "type": "string", "description": "An error message to go along with the error code.", "example": "An internal server error occurred" }, "elapsed": { "type": "integer", "description": "Number of milliseconds taken to generate this response", "example": 10 }, "credit_count": { "type": "integer", "description": "Number of API call credits required for this call. Always 0 for errors.", "example": 0 } }, "required": ["timestamp", "error_code", "error_message", "elapsed", "credit_count"] }, "HTTP_Status_500_Error_Object": { "type": "object", "description": "Internal Server Error", "properties": { "status": { "$ref": "#/components/schemas/status_4" } } }, "Airdrop_-_Airdrop_object": { "type": "object", "description": "A results object for the airdrop requested.", "properties": { "id": { "type": "string", "description": "The unique ID of the airdrop", "example": "60e59b99c8ca1d58514a2322" }, "project_name": { "type": "string", "description": "The project name", "example": "DeRace Airdrop" }, "description": { "type": "string", "description": "The description of the airdrop.", "example": "For 7 days starting from August 15, 2021, CoinMarketCap will host an Airdrop event..." }, "status": { "type": "string", "description": "The current status of the airdrop.", "example": "UPCOMING" }, "coin": { "$ref": "#/components/schemas/coin" }, "start_date": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "end_date": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "total_prize": { "type": "string", "example": "10000" }, "winner_count": { "type": "integer", "example": 55 }, "link": { "type": "string", "description": "A link to the airdrop information.", "example": "https://coinmarketcap.com/currencies/derace/airdrop" } }, "required": ["id", "start_date", "end_date"] }, "Airdrop_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Airdrop_-_Airdrop_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Airdrops_-_Airdrop_Object": { "type": "object", "description": "Airdrop object for each result", "properties": { "id": { "type": "string", "description": "The unique ID of the airdrop", "example": "60e59b99c8ca1d58514a2322" }, "project_name": { "type": "string", "description": "The project name", "example": "DeRace Airdrop" }, "description": { "type": "string", "description": "The description of the airdrop.", "example": "For 7 days starting from August 15, 2021, CoinMarketCap will host an Airdrop event..." }, "status": { "type": "string", "description": "The current status of the airdrop.", "example": "UPCOMING" }, "coin": { "$ref": "#/components/schemas/coin" }, "start_date": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "end_date": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "total_prize": { "type": "string", "example": "10000" }, "winner_count": { "type": "integer", "example": 55 }, "link": { "type": "string", "description": "A link to the airdrop information.", "example": "https://coinmarketcap.com/currencies/derace/airdrop" } }, "required": ["id", "start_date", "end_date"] }, "Airdrops_-_Airdrop_Array": { "type": "array", "description": "Array of airdrop object results.", "items": { "$ref": "#/components/schemas/Airdrops_-_Airdrop_Object" } }, "Airdrops_-_Response_Model": { "type": "object", "example": { "data": [ { "id": "60e59b99c8ca1d58514a2322", "project_name": "DeRace Airdrop", "description": "For 7 days starting from August 15, 2021, CoinMarketCap will host an Airdrop event...", "status": "UPCOMING", "coin": { "id": 10744, "name": "DeRace", "slug": "derace", "symbol": "DERC" }, "start_date": "2021-06-01T22:11:00.000Z", "end_date": "2021-07-01T22:11:00.000Z", "total_prize": "20000000000", "winner_count": 1000, "link": "https://coinmarketcap.com/currencies/derace/airdrop/" } ], "status": { "timestamp": "2021-08-01T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 3, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Airdrops_-_Airdrop_Array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Categories_-_Category_object": { "type": "object", "description": "A results object for each category requested. The map key being the id used in the request.", "properties": { "id": { "type": "string", "description": "The unique ID of the category", "example": "fj3893983c1b42617d6dc0" }, "name": { "type": "string", "description": "The name of the category", "example": "A16Z Portfolio" }, "title": { "type": "string", "description": "The title of the category", "example": "A16Z Portfolio" }, "description": { "type": "string", "description": "The description of the category", "example": "A16Z Portfolio" }, "num_tokens": { "type": "integer", "example": 12 }, "avg_price_change": { "type": "number", "description": "Average price change of coins within this categry", "example": 0.03 }, "market_cap": { "type": "number", "description": "Market cap of coins within this categry", "example": 121020662982 }, "market_cap_change": { "type": "number", "description": "Market cap change of coins within this categry", "example": 0.03 }, "volume": { "type": "number", "description": "Volume of coins within this categry", "example": 121020662982 }, "volume_change": { "type": "number", "description": "Volume change of coins within this categry", "example": 0.03 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this was last updated.", "example": "2013-04-28T00:00:00.000Z" } }, "required": [ "id", "avg_price_change", "market_cap", "market_cap_change", "volume", "volume_change", "last_updated" ] }, "Categories_-_Results_map": { "type": "array", "description": "Results of your query returned as an object map.", "items": { "$ref": "#/components/schemas/Categories_-_Category_object" } }, "Categories_-_Response_Model": { "type": "object", "example": { "data": [ { "id": "605e2ce9d41eae1066535f7c", "name": "A16Z Portfolio", "title": "A16Z Portfolio", "description": "A16Z Portfolio", "num_tokens": 12, "avg_price_change": 0.61305157, "market_cap": 29429241867.031097, "market_cap_change": 3.049044106496, "volume": 4103706600.0391645, "volume_change": -10.538325849854, "last_updated": "2021-11-10T10:35:12.354Z" } ], "status": { "timestamp": "2021-08-01T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 3, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Categories_-_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_-_Quote_object": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "price": { "type": [ "number", "null" ], "description": "Price in the specified currency for this historical.", "example": 7139.82 }, "volume_24h": { "type": [ "number", "null" ], "description": "Rolling 24 hour adjusted volume in the specified currency.", "example": 4885880000 }, "volume_24h_reported": { "type": "number", "description": "Rolling 24 hour reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d": { "type": "number", "description": "Rolling 7 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d_reported": { "type": "number", "description": "Rolling 7 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d": { "type": "number", "description": "Rolling 30 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d_reported": { "type": "number", "description": "Rolling 30 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "market_cap": { "type": [ "number", "null" ], "description": "Market cap in the specified currency.", "example": 121020662982 }, "percent_change_1h": { "type": [ "number", "null" ], "description": "1 hour change in the specified currency.", "example": 0.03 }, "percent_change_24h": { "type": [ "number", "null" ], "description": "24 hour change in the specified currency.", "example": 5.75 }, "percent_change_7d": { "type": [ "number", "null" ], "description": "7 day change in the specified currency.", "example": -19.64 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced.", "example": "2018-06-02T23:59:59.999Z" }, "cex_volume_24h": { "type": "number", "description": "24 hour trading volume from centralized exchanges in the requested currency." }, "dex_volume_24h": { "type": "number", "description": "24 hour trading volume from decentralized exchanges in the requested currency." }, "volume_change_24h": { "type": [ "number", "null" ], "description": "24 hour change in trading volume, as a percentage." }, "percent_change_30d": { "type": [ "number", "null" ], "description": "30 day price change as a percentage." }, "percent_change_60d": { "type": [ "number", "null" ], "description": "60 day price change as a percentage." }, "percent_change_90d": { "type": [ "number", "null" ], "description": "90 day price change as a percentage." }, "market_cap_dominance": { "type": [ "number", "null" ], "description": "This cryptocurrency's share of the total cryptocurrency market cap, as a percentage." }, "fully_diluted_market_cap": { "type": [ "number", "null" ], "description": "Fully diluted market cap in the requested currency." }, "tvl": { "type": [ "number", "null" ], "description": "Total value locked in the requested currency. `null` when TVL is not available." } }, "required": [ "price", "volume_24h", "market_cap", "percent_change_1h", "percent_change_24h", "percent_change_7d", "last_updated" ] }, "Cryptocurrency_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "example": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } }, "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_-_Quote_object" } }, "Cryptocurrency_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for every cryptocurrency that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "cmc_rank": { "type": [ "integer", "null" ], "description": "The cryptocurrency's CoinMarketCap rank by market cap.", "example": 5 }, "num_market_pairs": { "type": "integer", "description": "The number of active trading pairs available for this cryptocurrency across supported exchanges.", "example": 500 }, "circulating_supply": { "type": "number", "description": "The approximate number of coins circulating for this cryptocurrency.", "example": 16950100 }, "total_supply": { "type": "number", "description": "The approximate total amount of coins in existence right now (minus any coins that have been verifiably burned).", "example": 16950100 }, "market_cap_by_total_supply": { "type": "number", "description": "The market cap by total supply. *This field is only returned if requested through the `aux` request parameter.*", "example": 158055024432 }, "max_supply": { "type": [ "number", "null" ], "description": "The expected maximum limit of coins ever to be available for this cryptocurrency.", "example": 21000000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's market data was updated.", "example": "2018-06-02T22:51:28.209Z" }, "date_added": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "tags": { "$ref": "#/components/schemas/tags" }, "platform": { "$ref": "#/components/schemas/platform" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_-_Quote_map" }, "is_active": { "type": "integer", "description": "1 if this cryptocurrency has at least 1 active market currently being tracked by the platform, otherwise 0." }, "infinite_supply": { "type": "boolean", "description": "Whether this cryptocurrency is known to have an infinite supply." }, "is_fiat": { "type": "integer", "description": "1 if this is a fiat currency, otherwise 0." }, "tvl_ratio": { "type": [ "number", "null" ], "description": "Ratio of total value locked to market cap. `null` when TVL is not available." }, "self_reported_circulating_supply": { "type": [ "number", "null" ], "description": "The circulating supply reported by the project team. `null` when not reported." }, "self_reported_market_cap": { "type": [ "number", "null" ], "description": "The market cap based on the self-reported circulating supply. `null` when not reported." }, "minted_market_cap": { "type": "number", "description": "Market cap calculated from the minted supply, in the requested currency." } }, "required": [ "id", "name", "symbol", "slug", "quote" ] }, "Cryptocurrency_-_Results_array": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/Cryptocurrency_-_Cryptocurrency_object" }, "required": ["Cryptocurrency - Cryptocurrency object"] }, "Category_-_Cryptocurrency_object": { "type": "object", "description": "A results object for each cryptocurrency found in the category.", "properties": { "id": { "type": "string", "description": "The unique ID of the category", "example": "169267882822616" }, "name": { "type": "string", "description": "The name of the category", "example": "A16Z Portfolio" }, "title": { "type": "string", "description": "The title of the category", "example": "A16Z Portfolio" }, "description": { "type": "string", "description": "The description of the category", "example": "A16Z Portfolio" }, "num_tokens": { "type": "integer", "example": 12 }, "avg_price_change": { "type": "number", "description": "Average price change of coins within this categry", "example": 0.03 }, "market_cap": { "type": "number", "description": "Market cap of coins within this categry", "example": 121020662982 }, "market_cap_change": { "type": "number", "description": "Market cap change of coins within this categry", "example": 0.03 }, "volume": { "type": "number", "description": "Volume of coins within this categry", "example": 121020662982 }, "volume_change": { "type": "number", "description": "Volume change of coins within this categry", "example": 0.03 }, "coins": { "$ref": "#/components/schemas/Cryptocurrency_-_Results_array" }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this was last updated.", "example": "2013-04-28T00:00:00.000Z" } }, "required": [ "id", "avg_price_change", "market_cap", "market_cap_change", "volume", "volume_change", "coins", "last_updated" ] }, "Category_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Category_-_Cryptocurrency_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "tags_1": { "type": "array", "description": "Tags associated with this cryptocurrency.", "example": ["mineable"], "items": { "type": "string" } }, "Cryptocurrencies_Info_-_URLs_object": { "type": "object", "description": "An object containing various resource URLs for this cryptocurrency.", "properties": { "website": { "$ref": "#/components/schemas/website" }, "technical_doc": { "$ref": "#/components/schemas/technical_doc" }, "explorer": { "$ref": "#/components/schemas/explorer" }, "source_code": { "$ref": "#/components/schemas/source_code" }, "message_board": { "$ref": "#/components/schemas/message_board" }, "chat": { "$ref": "#/components/schemas/chat" }, "announcement": { "$ref": "#/components/schemas/announcement" }, "reddit": { "$ref": "#/components/schemas/reddit" }, "twitter": { "$ref": "#/components/schemas/twitter" }, "facebook": { "type": "array", "description": "Facebook links for this cryptocurrency.", "items": { "type": "string" } } }, "required": [ "website", "technical_doc", "explorer", "source_code", "message_board", "chat", "announcement", "reddit", "twitter" ] }, "Cryptocurrencies_Info_-_Cryptocurrency_object._Please_note_this_will_be_wrapped_in_an_array_if_you_request_by_symbol_using_the_v2_endpoint.": { "type": "object", "description": "A results object for each cryptocurrency requested. The map key being the id/symbol used in the request.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "category": { "type": "string", "description": "The category for this cryptocurrency.", "example": "coin", "enum": ["coin", "token"] }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "logo": { "type": "string", "description": "Link to a CoinMarketCap hosted logo png for this cryptocurrency. 64px is default size returned. Replace \"64x64\" in the image path with these alternative sizes: 16, 32, 64, 128, 200", "example": "https://s2.coinmarketcap.com/static/img/coins/64x64/1.png" }, "description": { "type": "string", "description": "A CoinMarketCap supplied brief description of this cryptocurrency. This field will return null if a description is not available.", "example": "Bitcoin (BTC) is a consensus network that enables a new payment system and a completely digital currency. Powered by its users, it is a peer to peer payment network that requires no central authority to operate." }, "date_added": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "date_launched": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was launched.", "example": "2013-04-28T00:00:00.000Z" }, "notice": { "type": "string", "description": "A [Markdown](https://commonmark.org/help/) formatted notice that may highlight a significant event or condition that is impacting the cryptocurrency or how it is displayed, otherwise null. A notice may highlight a recent or upcoming mainnet swap, symbol change, exploit event, or known issue with a particular exchange or market, for example. If present, this notice is also displayed in an alert banner at the top of the cryptocurrency's page on coinmarketcap.com." }, "tags": { "anyOf": [ { "$ref": "#/components/schemas/tags_1" }, { "type": "null" } ] }, "platform": { "$ref": "#/components/schemas/platform" }, "self_reported_circulating_supply": { "type": ["number", "null"], "description": "The self reported number of coins circulating for this cryptocurrency.", "example": 16950100 }, "self_reported_market_cap": { "type": ["number", "null"], "description": "The self reported market cap for this cryptocurrency.", "example": 16950100 }, "self_reported_tags": { "$ref": "#/components/schemas/self_reported_tags" }, "infinite_supply": { "type": "boolean", "description": "The cryptocurrency is known to have an infinite supply.", "example": false }, "urls": { "$ref": "#/components/schemas/Cryptocurrencies_Info_-_URLs_object" }, "subreddit": { "type": "string", "description": "Name of the project's subreddit, if any." }, "twitter_username": { "type": "string", "description": "The project's X (Twitter) username, if any." }, "tag-names": { "type": [ "array", "null" ], "description": "Names of the tags in `tags`, in the same order.", "items": { "type": "string" } }, "tag-groups": { "type": [ "array", "null" ], "description": "Group of each tag in `tags`, in the same order. For example `ALGORITHM`, `CATEGORY` or `PLATFORM`.", "items": { "type": "string" } }, "contract_address": { "type": "array", "description": "Contract addresses of this cryptocurrency on each platform it is deployed on.", "items": { "type": "object", "properties": { "contract_address": { "type": "string", "description": "Token contract address on this platform." }, "platform": { "type": "object", "description": "The platform this contract address belongs to.", "properties": { "name": { "type": "string", "description": "Platform name." }, "coin": { "type": "object", "description": "The platform's native cryptocurrency.", "properties": { "id": { "type": "string", "description": "CoinMarketCap ID of the platform's native cryptocurrency." }, "name": { "type": "string", "description": "Name of the platform's native cryptocurrency." }, "symbol": { "type": "string", "description": "Symbol of the platform's native cryptocurrency." }, "slug": { "type": "string", "description": "URL-friendly slug of the platform's native cryptocurrency." } } } } } } } } }, "required": [ "id", "name", "symbol", "category", "slug", "logo", "description", "date_added", "tags", "platform", "urls" ] }, "Cryptocurrency_Info_-_Results_map": { "type": "object", "description": "Results of your query returned as an object map.", "example": { "1": { "urls": { "website": ["https://bitcoin.org/"], "technical_doc": ["https://bitcoin.org/bitcoin.pdf"], "twitter": [], "reddit": ["https://reddit.com/r/bitcoin"], "message_board": ["https://bitcointalk.org"], "announcement": [], "chat": [], "explorer": [ "https://blockchain.coinmarketcap.com/chain/bitcoin", "https://blockchain.info/", "https://live.blockcypher.com/btc/" ], "source_code": ["https://github.com/bitcoin/"] }, "logo": "https://s2.coinmarketcap.com/static/img/coins/64x64/1.png", "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "description": "Bitcoin (BTC) is a consensus network that enables a new payment system and a completely digital currency. Powered by its users, it is a peer to peer payment network that requires no central authority to operate. On October 31st, 2008, an individual or group of individuals operating under the pseudonym \"Satoshi Nakamoto\" published the Bitcoin Whitepaper and described it as: \"a purely peer-to-peer version of electronic cash would allow online payments to be sent directly from one party to another without going through a financial institution.\"", "date_added": "2013-04-28T00:00:00.000Z", "date_launched": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "category": "coin" } }, "additionalProperties": { "description": "On the v2 endpoint, requests by `symbol` return an array of objects for each symbol, because more than one cryptocurrency can share a symbol. Requests by `id` or `slug` return a single object.", "oneOf": [ { "$ref": "#/components/schemas/Cryptocurrencies_Info_-_Cryptocurrency_object._Please_note_this_will_be_wrapped_in_an_array_if_you_request_by_symbol_using_the_v2_endpoint." }, { "type": "array", "items": { "$ref": "#/components/schemas/Cryptocurrencies_Info_-_Cryptocurrency_object._Please_note_this_will_be_wrapped_in_an_array_if_you_request_by_symbol_using_the_v2_endpoint." } } ] } }, "Cryptocurrencies_Info_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Info_-_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Map_-_Cryotocurrency_Object": { "type": "object", "description": "Cryptocurrency object for each result", "properties": { "id": { "type": "integer", "description": "The unique cryptocurrency ID for this cryptocurrency.", "example": 1 }, "rank": { "type": "number", "description": "The rank of this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency, always in all caps.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "is_active": { "type": "integer", "description": "1 if this cryptocurrency has at least 1 active market currently being tracked by the platform, otherwise 0. A value of 1 is analogous with `listing_status=active`.", "example": 1, "minimum": 0, "maximum": 1 }, "status": { "type": "string", "description": "The listing status of the cryptocurrency. *This field is only returned if requested through the `aux` request parameter.*", "example": "active", "enum": ["active", "inactive", "untracked"] }, "first_historical_data": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the date this cryptocurrency was first available on the platform.", "example": "2013-04-28T18:47:21.000Z" }, "last_historical_data": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's market data was updated.", "example": "2018-06-02T22:51:28.209Z" }, "platform": { "$ref": "#/components/schemas/platform" } }, "required": ["id", "rank", "name", "symbol", "slug"] }, "Cryptocurrency_Map_-_Cryptocurrency_Array": { "type": "array", "description": "Array of cryptocurrency object results.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Map_-_Cryotocurrency_Object" } }, "Cryptocurrency_Map_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1, "rank": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "is_active": 1, "first_historical_data": "2013-04-28T18:47:21.000Z", "last_historical_data": "2020-05-05T20:44:01.000Z", "platform": null }, { "id": 1839, "rank": 3, "name": "Binance Coin", "symbol": "BNB", "slug": "binance-coin", "is_active": 1, "first_historical_data": "2017-07-25T04:30:05.000Z", "last_historical_data": "2020-05-05T20:44:02.000Z", "platform": { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "token_address": "0xB8c77482e45F1F44dE1745F52C74426C631bDD52" } }, { "id": 825, "rank": 5, "name": "Tether", "symbol": "USDT", "slug": "tether", "is_active": 1, "first_historical_data": "2015-02-25T13:34:26.000Z", "last_historical_data": "2020-05-05T20:44:01.000Z", "platform": { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "token_address": "0xdac17f958d2ee523a2206206994597c13d831ec7" } } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Map_-_Cryptocurrency_Array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "The_blockchain_platform_where_the_assets_are_held_on.": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "The CoinMarketCap ID for the blockchain platform where the assets are held on", "example": 1027 }, "symbol": { "type": "string", "description": "The symbol for the blockchain platform where the assets are held on", "example": "ETH" }, "name": { "type": "string", "description": "The name for the blockchain platform where the assets are held on", "example": "Ethereum" } } }, "The_cryptocurrency_of_the_holdings_in_the_wallet.": { "type": "object", "properties": { "crypto_id": { "type": "integer", "description": "The CoinMarketCap ID for the coin/token used for this wallet", "example": 1027 }, "symbol": { "type": "string", "description": "The symbol for the coin/token used for this wallet", "example": "ETH" }, "name": { "type": "string", "description": "The name for the coin/token used for this wallet", "example": "Ethereum" }, "price_usd": { "type": "number", "description": "The price in USD for 1 coin/token", "example": 1200.055 } } }, "Exchange_Assets_Wallets_-_Response_Model": { "type": "object", "properties": { "wallet_address": { "type": "string", "description": "The address of the wallet", "example": "0x5a52e96bacdabb82fd05763e25335261b270efcb" }, "balance": { "type": "number", "description": "The amount of coins/tokens held in this wallet", "example": 1000 }, "platform": { "$ref": "#/components/schemas/The_blockchain_platform_where_the_assets_are_held_on." }, "currency": { "$ref": "#/components/schemas/The_cryptocurrency_of_the_holdings_in_the_wallet." } }, "required": ["wallet_address", "balance", "platform", "currency"] }, "Exchange_Assets_-_Response_Model": { "type": "object", "example": { "status": { "timestamp": "2022-11-24T08:23:22.028Z", "error_code": 0, "error_message": null, "elapsed": 1828, "credit_count": 0, "notice": null }, "data": [ { "wallet_address": "0x5a52e96bacdabb82fd05763e25335261b270efcb", "balance": 45000000, "platform": { "crypto_id": 1027, "symbol": "ETH", "name": "Ethereum" }, "currency": { "crypto_id": 5117, "price_usd": 0.10241799413549, "symbol": "OGN", "name": "Origin Protocol" } }, { "wallet_address": "0xf977814e90da44bfa03b6295a0616a897441acec", "balance": 400000000, "platform": { "crypto_id": 1027, "symbol": "ETH", "name": "Ethereum" }, "currency": { "crypto_id": 5824, "price_usd": 0.00251174724338, "symbol": "SLP", "name": "Smooth Love Potion" } }, { "wallet_address": "0x5a52e96bacdabb82fd05763e25335261b270efcb", "balance": 5588175, "platform": { "crypto_id": 1027, "symbol": "ETH", "name": "Ethereum" }, "currency": { "crypto_id": 3928, "price_usd": 0.04813245442357, "symbol": "IDEX", "name": "IDEX" } }, { "wallet_address": "0x5a52e96bacdabb82fd05763e25335261b270efcb", "balance": 125000, "platform": { "crypto_id": 1027, "symbol": "ETH", "name": "Ethereum" }, "currency": { "crypto_id": 1552, "price_usd": 20.46545919550142, "symbol": "MLN", "name": "Enzyme" } }, { "wallet_address": "0x21a31ee1afc51d94c2efccaa2092ad1028285549", "balance": 27241191.98, "platform": { "crypto_id": 1027, "symbol": "ETH", "name": "Ethereum" }, "currency": { "crypto_id": 14806, "price_usd": 0.02390427295165, "symbol": "PEOPLE", "name": "ConstitutionDAO" } } ] }, "properties": { "data": { "$ref": "#/components/schemas/data" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } } }, "website_1": { "type": "array", "description": "Official website URLs.", "example": ["https://binance.com"], "items": { "type": "string", "x-format": { "uri": true } } }, "chat_1": { "type": "array", "description": "Official chat URLs.", "example": ["https://t.me/coinbene"], "items": { "type": "string", "x-format": { "uri": true } } }, "twitter_1": { "type": "array", "description": "Official twitter profile URLs.", "example": ["https://twitter.com/Bitcoin"], "items": { "type": "string", "x-format": { "uri": true } } }, "Exchanges_Info_-_URLs_object": { "type": "object", "description": "An object containing various resource URLs for this exchange.", "properties": { "website": { "$ref": "#/components/schemas/website_1" }, "blog": { "$ref": "#/components/schemas/blog" }, "chat": { "$ref": "#/components/schemas/chat_1" }, "fee": { "$ref": "#/components/schemas/fee" }, "twitter": { "$ref": "#/components/schemas/twitter_1" }, "actual": { "type": "array", "description": "Links to the exchange's main trading website.", "items": { "type": "string" } }, "register": { "type": "array", "description": "Links to the exchange's sign-up page.", "items": { "type": "string" } } }, "required": ["website", "blog", "chat", "fee", "twitter"] }, "Exchanges_Info_-_Exchange_Info_object": { "type": "object", "description": "A results object for each exchange requested. The map key being the id or slug used in the request.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this exchange.", "example": 1 }, "name": { "type": "string", "description": "The name of this exchange.", "example": "Binance" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of the exchange name.", "example": "binance" }, "logo": { "type": "string", "description": "Link to a CoinMarketCap hosted logo png for this exchange. 64px is default size returned. Replace \"64x64\" in the image path with these alternative sizes: 16, 32, 64, 128, 200", "example": "https://s2.coinmarketcap.com/static/img/exchanges/64x64/270.png", "x-format": { "uri": true } }, "description": { "type": "string", "description": "A CoinMarketCap supplied brief description of this cryptocurrency exchange. This field will return null if a description is not available.", "example": "Launched in Jul-2017, Binance is a centralized exchange based in Malta." }, "date_launched": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the launch date for this exchange.", "example": "2017-07-14T00:00:00.000Z" }, "notice": { "type": [ "string", "null" ], "description": "A [Markdown](https://commonmark.org/help/) formatted message outlining a condition that is impacting the availability of the exchange's market data or the secure use of the exchange, otherwise null. This may include a maintenance event on the exchange's end or CoinMarketCap's end, an alert about reported issues with withdrawls from this exchange, or another condition that may be impacting the exchange and it's markets. If present, this notice is also displayed in an alert banner at the top of the exchange's page on coinmarketcap.com." }, "weekly_visits": { "type": "number", "description": "The number of weekly visitors.", "example": 1000 }, "spot_volume_usd": { "type": "number", "description": "Reported all time spot volume in the specified currency.", "example": 768478308.529847 }, "urls": { "$ref": "#/components/schemas/Exchanges_Info_-_URLs_object" }, "countries": { "type": "array", "description": "Countries this exchange operates in. `GLOBAL` means no specific country.", "items": { "type": "string" } }, "fiats": { "type": "array", "description": "Fiat currencies accepted by this exchange.", "items": { "type": "string" } }, "maker_fee": { "type": "number", "description": "Maker fee charged by this exchange, as a percentage." }, "taker_fee": { "type": "number", "description": "Taker fee charged by this exchange, as a percentage." }, "spot_volume_last_updated": { "type": "string", "description": "Timestamp (ISO 8601) of the last update to `spot_volume_usd`.", "format": "date-time" }, "is_redistributable": { "type": "integer", "description": "1 if this exchange's data can be redistributed, otherwise 0." }, "on_ramp_direct_deposit": { "type": "string", "description": "Comma-separated fiat currencies you can deposit directly (for example by bank transfer)." }, "on_ramp_card_visa_mastercard": { "type": "string", "description": "Comma-separated fiat currencies you can use to buy crypto with a Visa or Mastercard card." }, "on_ramp_google_apple_pay": { "type": "string", "description": "Comma-separated fiat currencies you can use to buy crypto with Google Pay or Apple Pay." }, "on_ramp_third_party": { "type": "string", "description": "Comma-separated fiat currencies you can use to buy crypto through third-party payment providers." }, "on_ramp_p2p": { "type": "string", "description": "Comma-separated fiat currencies you can use to buy crypto through peer-to-peer trading." }, "off_ramp_direct_withdrawal": { "type": "string", "description": "Comma-separated fiat currencies you can withdraw directly (for example by bank transfer)." }, "off_ramp_p2p": { "type": "string", "description": "Comma-separated fiat currencies you can sell crypto for through peer-to-peer trading." } }, "required": ["id", "name", "slug", "logo", "description", "date_launched", "notice", "urls"] }, "Exchanges_Info_-_Results_map": { "type": "object", "description": "Results of your query returned as an object map.", "example": { "1": { "id": 270, "name": "Binance", "slug": "binance", "logo": "https://s2.coinmarketcap.com/static/img/exchanges/64x64/270.png", "description": "Launched in Jul-2017, Binance is a centralized exchange based in Malta.", "date_launched": "2017-07-14T00:00:00.000Z", "notice": "", "countries": [], "fiats": ["AED", "USD"], "maker_fee": 0.02, "taker_fee": 0.04, "weekly_visits": 5123451, "spot_volume_usd": 66926283498.60113, "spot_volume_last_updated": "2021-05-06T01:20:15.451Z", "urls": { "website": ["https://www.binance.com/"], "twitter": ["https://twitter.com/binance"], "blog": [], "chat": ["https://t.me/binanceexchange"], "fee": ["https://www.binance.com/fees.html"] } } }, "additionalProperties": { "$ref": "#/components/schemas/Exchanges_Info_-_Exchange_Info_object" } }, "Exchanges_Info_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Exchanges_Info_-_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Exchange_Map_-_Exchange_Object": { "type": "object", "description": "Exchange object description", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this exchange.", "example": 270 }, "name": { "type": "string", "description": "The name of this exchange.", "example": "Binance" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this exchange name.", "example": "binance" }, "is_active": { "type": "integer", "description": "1 if this exchange is still being actively tracked and updated, otherwise 0.", "example": 1, "minimum": 0, "maximum": 1 }, "status": { "type": "string", "description": "The listing status of the exchange. *This field is only returned if requested through the `aux` request parameter.*", "example": "active", "enum": ["active", "inactive", "untracked"] }, "first_historical_data": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the earliest market data record available to query using our historical endpoints. `null` if there is no historical data currently available for this exchange.", "example": "2018-04-26T00:45:00.000Z" }, "last_historical_data": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the latest market data record available to query using our historical endpoints. `null` if there is no historical data currently available for this exchange.", "example": "2019-06-02T21:25:00.000Z" }, "is_listed": { "type": "integer", "description": "1 if this exchange is currently listed on CoinMarketCap, otherwise 0." }, "is_redistributable": { "type": "integer", "description": "1 if this exchange's data can be redistributed, otherwise 0." } }, "required": ["id", "name", "slug"] }, "Exchange_Map_-_Exchanges_Array": { "type": "array", "description": "Array of exchange object results.", "items": { "$ref": "#/components/schemas/Exchange_Map_-_Exchange_Object" } }, "Exchange_Map_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Exchange_Map_-_Exchanges_Array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Fiat_Map_-_Fiat_Object": { "type": "object", "description": "Fiat object for each result", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this asset.", "example": 2781 }, "name": { "type": "string", "description": "The name of this asset.", "example": "United States Dollar" }, "sign": { "type": "string", "description": "The currency sign for this asset.", "example": "$" }, "symbol": { "type": "string", "description": "The ticker symbol for this asset, always in all caps.", "example": "USD" } }, "required": ["id", "name", "sign", "symbol"] }, "Fiat_Map_-_Fiat_Array": { "type": "array", "description": "Array of fiat object results.", "items": { "$ref": "#/components/schemas/Fiat_Map_-_Fiat_Object" } }, "Fiat_Map_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 2781, "name": "United States Dollar", "sign": "$", "symbol": "USD" }, { "id": 2787, "name": "Chinese Yuan", "sign": "¥", "symbol": "CNY" }, { "id": 2781, "name": "South Korean Won", "sign": "₩", "symbol": "KRW" } ], "status": { "timestamp": "2020-01-07T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 3, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Fiat_Map_-_Fiat_Array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Account_Info_-_Response_Object": { "type": "object", "description": "Details about your API key are returned in this object.", "properties": { "plan": { "$ref": "#/components/schemas/plan" }, "usage": { "$ref": "#/components/schemas/usage" } }, "required": ["plan", "usage"] }, "Account_Info_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Account_Info_-_Response_Object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Tools_Price_Conversion_-_Quote_object": { "type": "object", "description": "A quote object for each conversion requested. The map key being the id/symbol used in the request.", "properties": { "price": { "type": "number", "description": "Converted price in terms of the quoted currency and historic time (if supplied).", "example": 1235000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the destination currency's market value was recorded.", "example": "2018-06-02T00:00:00.000Z" } }, "required": ["price", "last_updated"] }, "Tools_Price_Conversion_-_Quotes_map._Please_note_this_will_be_wrapped_in_an_array_if_you_request_by_symbol_using_the_v2_endpoint.": { "type": "object", "description": "An object map of price conversions.", "additionalProperties": { "$ref": "#/components/schemas/Tools_Price_Conversion_-_Quote_object" } }, "Tools_Price_Conversion_-_Results_Object": { "type": "object", "description": "Results object for your API call.", "example": { "symbol": "BTC", "id": 1, "name": "Bitcoin", "amount": 50, "last_updated": "2018-06-06T08:04:36.000Z", "quote": { "USD": { "price": 284656.08465608465, "last_updated": "2018-06-06T06:00:00.000Z" } } }, "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for your base currency.", "example": 1 }, "name": { "type": "string", "description": "The name of your base currency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The symbol for your base currency.", "example": "BTC" }, "amount": { "type": "number", "description": "Amount of base currency to convert from.", "example": 50 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the referenced market value of the base currency was recorded.", "example": "2018-06-02T00:00:00.000Z" }, "quote": { "$ref": "#/components/schemas/Tools_Price_Conversion_-_Quotes_map._Please_note_this_will_be_wrapped_in_an_array_if_you_request_by_symbol_using_the_v2_endpoint." } }, "required": ["id", "name", "symbol", "amount", "last_updated", "quote"] }, "Tools_Price_Conversion_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tools_Price_Conversion_-_Results_Object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Fear_and_Greed_Historical_-_Fear_and_Greed_object": { "type": "object", "description": "Fear and Greed Historical", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp of when this historical quote was recorded." }, "value": { "type": "integer", "description": "The value of CMC Fear and Greed. \n\nWhen the value is closer to 0, the market is in Extreme Fear, and investors have over-sold irrationally.\n\nWhen the value is closer to 100, the market is in Extreme Greed, indicating a likely market correction." }, "value_classification": { "type": "string", "description": "The value classication of CMC Fear and Greed. \n \n1 ≤ x < 20: Extreme Fear \n20 ≤ x < 40: Fear \n40 ≤ x < 60: Neutral \n60 ≤ x < 80: Greed \n80 ≤ x ≤ 100: Extreme Greed" } }, "required": ["timestamp", "value", "value_classification"] }, "Fear_and_Greed_Historical_-_Results_map": { "type": "array", "description": "Fear and Greed Historical.", "example": [ { "timestamp": "1726617600", "value": 38, "value_classification": "Fear" }, { "timestamp": "1726531200", "value": 34, "value_classification": "Fear" }, { "timestamp": "1726444800", "value": 36, "value_classification": "Fear" }, { "timestamp": "1726358400", "value": 38, "value_classification": "Fear" }, { "timestamp": "1726272000", "value": 38, "value_classification": "Fear" } ], "items": { "$ref": "#/components/schemas/Fear_and_Greed_Historical_-_Fear_and_Greed_object" }, "required": ["Fear and Greed Historical - Fear and Greed object"] }, "Fear_and_Greed_Historical_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fear_and_Greed_Historical_-_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Fear_and_Greed_Latest_-_Response_Object": { "type": "object", "description": "The latest CMC Fear and Greed value.", "example": { "value": 40, "value_classification": "Neutral", "update_time": "2024-09-19T02:54:56.017Z" }, "properties": { "value": { "type": "integer", "description": "The value of CMC Fear and Greed. \n\nWhen the value is closer to 0, the market is in Extreme Fear, and investors have over-sold irrationally. \n\nWhen the value is closer to 100, the market is in Extreme Greed, indicating a likely market correction.", "minimum": 0, "maximum": 100 }, "value_classification": { "type": "string", "description": "The value classication of CMC Fear and Greed. \n \n1 ≤ x < 20: Extreme Fear \n20 ≤ x < 40: Fear \n40 ≤ x < 60: Neutral \n60 ≤ x < 80: Greed \n80 ≤ x ≤ 100: Extreme Greed" }, "update_time": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this record was updated." } }, "required": ["value", "value_classification", "update_time"] }, "Fear_and_Greed_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fear_and_Greed_Latest_-_Response_Object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Blockchain_Statistics_Latest_-_Blockchain_object": { "type": "object", "description": "A blockchain object for every blockchain that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this blockchain's cryptocurrency.", "example": 1 }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of the cryptocurrency's name.", "example": "bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for the cryptocurrency.", "example": "BTC" }, "block_reward_static": { "type": "string", "description": "The reward assigned to the miner of a block excluding fees.", "example": "12.5" }, "consensus_mechanism": { "type": "string", "description": "The consensus mechanism used by the blockchain, for example, \"proof-of-work\" or \"proof-of-stake\".", "example": "proof-of-work" }, "difficulty": { "type": "string", "description": "The global block difficulty determining how hard to find a hash on this blockchain. *Note: This integer is returned as a string to use with BigInt libraries as it may exceed the max safe integer size for many programming languages.*", "example": "2264398029247833" }, "hashrate_24h": { "type": "string", "description": "The average hashrate over the past 24 hours. *Note: This integer is returned as a string to use with BigInt libraries as it may exceed the max safe integer size for many programming languages.*", "example": "169267882822616" }, "pending_transactions": { "type": "string", "description": "The number of pending transactions.", "example": "5120" }, "reduction_rate": { "type": "string", "description": "The rate the block reward is adjusted at a specified interval.", "example": "50%" }, "total_blocks": { "type": "string", "description": "The total number of blocks.", "example": "8385036" }, "total_transactions": { "type": "string", "description": "The total number of transactions. *Note: This integer is returned as a string to use with BigInt libraries as it may exceed the max safe integer size for many programming languages.*", "example": "523059480" }, "tps_24h": { "type": "string", "description": "The average transactions per second over the past 24 hours.", "example": "8.463935185185186" }, "first_block_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the time the first block was mined on this chain.", "example": "2009-01-09T02:54:25.000Z" } }, "required": [ "id", "slug", "symbol", "block_reward_static", "consensus_mechanism", "difficulty", "hashrate_24h", "pending_transactions", "reduction_rate", "total_blocks", "total_transactions", "tps_24h", "first_block_timestamp" ] }, "Blockchain_Statistics_Latest_-_Results_map": { "type": "object", "description": "A map of blockchain objects by ID, symbol, or slug (as used in query parameters).", "example": { "1": { "id": 1, "slug": "bitcoin", "symbol": "BTC", "block_reward_static": "12.5", "consensus_mechanism": "proof-of-work", "difficulty": "11890594958796", "hashrate_24h": "85116194130018810000", "pending_transactions": "1177", "reduction_rate": "50%", "total_blocks": "595165", "total_transactions": "455738994", "tps_24h": "3.808090277777778", "first_block_timestamp": "2009-01-09T02:54:25.000Z" } }, "additionalProperties": { "$ref": "#/components/schemas/Blockchain_Statistics_Latest_-_Blockchain_object" } }, "Blockchain_Statistics_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Blockchain_Statistics_Latest_-_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Community_Trending_Token_-Results-Object": { "type": "object", "properties": { "rank": { "type": "number", "description": "The community rank of the coin", "example": 1 }, "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "cmc_rank": { "type": "integer", "description": "The cryptocurrency's CoinMarketCap rank by market cap.", "example": 5 } }, "required": ["id", "name", "symbol", "slug"] }, "Community_Trending_Token_-_Results": { "type": "array", "description": "Cntent objects.", "items": { "$ref": "#/components/schemas/Community_Trending_Token_-Results-Object" } }, "Community_Trending_Token_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 7102, "name": "Linear Finance", "symbol": "LINA", "slug": "linear", "cmc_rank": 461, "rank": 1 }, { "id": 26265, "name": "NiHao", "symbol": "NIHAO", "slug": "nihao", "cmc_rank": 5000, "rank": 2 }, { "id": 22538, "name": "T-mac DAO", "symbol": "TMG", "slug": "t-mac-dao", "cmc_rank": 4802, "rank": 3 }, { "id": 2398, "name": "SelfKey", "symbol": "KEY", "slug": "selfkey", "cmc_rank": 753, "rank": 4 }, { "id": 3437, "name": "ABBC Coin", "symbol": "ABBC", "slug": "abbc-coin", "cmc_rank": 178, "rank": 5 } ] }, "properties": { "data": { "$ref": "#/components/schemas/Community_Trending_Token_-_Results" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Community_Trending_Topic_-_Results": { "type": "object", "description": "Cntent objects.", "properties": { "rank": { "type": "number", "description": "The community rank of the topic", "example": 1 }, "topic": { "type": "string", "description": "The trending topic name", "example": "Bitcoin" } } }, "Community_Trending_Topic_-_Response_Model": { "type": "object", "example": { "data": [ { "topic": "BTC Price Analysis#", "rank": 1 }, { "topic": "Macro Insights#", "rank": 2 }, { "topic": "Altcoin Season#", "rank": 3 } ], "status": { "timestamp": "2026-10-19T05:15:20.182Z", "error_code": 0, "error_message": null, "elapsed": 1, "credit_count": 0 } }, "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Community_Trending_Topic_-_Results" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Model_2": { "type": "object", "properties": { "post_id": { "type": "string" }, "owner": { "$ref": "#/components/schemas/owner" }, "text_content": { "type": "string" }, "photos": { "$ref": "#/components/schemas/photos" }, "comment_count": { "type": "string" }, "like_count": { "type": "string" }, "post_time": { "type": "string" }, "language_code": { "type": "string" }, "comments_url": { "type": "string", "description": "Returns comments of the current post/comment" } }, "required": ["owner"] }, "Content_Post_Comments_-_Results_array": { "type": "array", "description": "Array of content objects.", "items": { "$ref": "#/components/schemas/Model_2" } }, "Content_Post_Comments_-_Response_Model": { "type": "object", "example": { "data": [ { "post_id": "317807035", "owner": { "nickname": "Amy", "avatar_url": "https://s3.coinmarketcap.com/static/img/portraits/61359449293ccc2c4bcf07c7.png" }, "text_content": "Someone's working on it!!", "photos": [], "comment_count": "0", "like_count": "0", "post_time": "1662640110429", "language_code": "en" }, { "post_id": "317807862", "owner": { "nickname": "Wanda", "avatar_url": "https://s3.coinmarketcap.com/static/img/portraits/6136cf1015b8f3308e283073.png" }, "text_content": "yes sir!!", "photos": [], "comment_count": "0", "like_count": "0", "post_time": "1662635039889", "language_code": "en" } ], "status": { "timestamp": "2022-09-08T16:07:30.033Z", "error_code": 0, "error_message": "SUCCESS", "elapsed": 10, "credit_count": 0 } }, "properties": { "data": { "$ref": "#/components/schemas/Content_Post_Comments_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Model_3": { "type": "object", "properties": { "id": { "type": "number" }, "symbol": { "type": "string" }, "slug": { "type": "string" }, "assetType": { "type": "string", "description": "Type of this asset, for example `crypto`." } } }, "Model_4": { "type": "object", "properties": { "post_id": { "type": "string" }, "owner": { "$ref": "#/components/schemas/owner" }, "text_content": { "type": "string" }, "photos": { "$ref": "#/components/schemas/photos" }, "comment_count": { "type": "string" }, "like_count": { "type": "string" }, "post_time": { "type": "string" }, "currencies": { "$ref": "#/components/schemas/currencies" }, "language_code": { "type": "string" }, "comments_url": { "type": "string", "description": "Returns comments of the current post/comment" } }, "required": ["owner"] }, "Content_Top_Posts_-_Results": { "type": "object", "description": "Cntent objects.", "properties": { "list": { "$ref": "#/components/schemas/list" }, "last_score": { "type": "string" } } }, "Content_Latest_Posts_-_Response_Model": { "type": "object", "example": { "data": { "list": [ { "post_id": "123456789", "comments_url": "{{baseUrl}}/v1/content/posts/comments?post_id=123456789", "owner": { "nickname": "CoinMarketCap", "avatar_url": "https://s3.coinmarketcap.com/static/img/portraits/621c22097aafe46422aa1161.png" }, "text_content": "$ETH regardless of merging or not merging...", "photos": [ "https://s3.coinmarketcap.com/static/img/portraits/621c22097aafe46422aa1161.png" ], "comment_count": "5", "like_count": "5", "post_time": "1662643031298", "currencies": [ { "id": 1027, "symbol": "ETH", "slug": "ethereum" } ], "language_code": "en" }, { "post_id": "123456790", "comments_url": "{{baseUrl}}/v1/content/posts/comments?post_id=123456790", "owner": { "nickname": "John", "avatar_url": "https://s3.coinmarketcap.com/static/img/portraits/61b9aaca1d79d0637758fdeb.png" }, "text_content": "$ETH The success and the failure are almost...", "photos": [ "https://s3.coinmarketcap.com/static/img/portraits/621c22097aafe46422aa1161.png" ], "comment_count": "6", "like_count": "60", "post_time": "1662612816768", "currencies": [ { "id": 1027, "symbol": "ETH", "slug": "ethereum" } ], "language_code": "en" } ], "last_score": "1662903634322" } }, "properties": { "data": { "$ref": "#/components/schemas/Content_Top_Posts_-_Results" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Content_Top_Posts_-_Response_Model": { "type": "object", "example": { "data": { "list": [ { "post_id": "123456789", "comments_url": "{{baseUrl}}/v1/content/posts/comments?post_id=123456789", "owner": { "nickname": "CoinMarketCap", "avatar_url": "https://s3.coinmarketcap.com/static/img/portraits/621c22097aafe46422aa1161.png" }, "text_content": "$ETH regardless of merging or not merging...", "photos": [ "https://s3.coinmarketcap.com/static/img/portraits/621c22097aafe46422aa1161.png" ], "comment_count": "5", "like_count": "5", "post_time": "1662643031298", "currencies": [ { "id": 1027, "symbol": "ETH", "slug": "ethereum" } ], "language_code": "en" }, { "post_id": "123456790", "comments_url": "{{baseUrl}}/v1/content/posts/comments?post_id=123456790", "owner": { "nickname": "John", "avatar_url": "https://s3.coinmarketcap.com/static/img/portraits/61b9aaca1d79d0637758fdeb.png" }, "text_content": "$ETH The success and the failure are almost...", "photos": [ "https://s3.coinmarketcap.com/static/img/portraits/621c22097aafe46422aa1161.png" ], "comment_count": "6", "like_count": "60", "post_time": "1662612816768", "currencies": [ { "id": 1027, "symbol": "ETH", "slug": "ethereum" } ], "language_code": "en" } ], "last_score": "38507.8865" }, "status": { "timestamp": "2022-09-08T16:08:52.641Z", "error_code": 0, "error_message": "SUCCESS", "elapsed": 0, "credit_count": 0 } }, "properties": { "data": { "$ref": "#/components/schemas/Content_Top_Posts_-_Results" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Listings_Latest_-_Quote_object": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "price": { "type": "number", "description": "Price in the specified currency at the end of the requested UTC day.", "example": 7139.82 }, "volume_24h": { "type": "number", "description": "24 hour adjusted volume in the specified currency at the end of the requested UTC day.", "example": 4885880000 }, "market_cap": { "type": "number", "description": "Market cap in the specified currency at the end of the requested UTC day.", "example": 121020662982 }, "percent_change_1h": { "type": "number", "description": "1 hour change in the specified currency at the end of the requested UTC day.", "example": 0.03 }, "percent_change_24h": { "type": "number", "description": "24 hour change in the specified currency at the end of the requested UTC day.", "example": 5.75 }, "percent_change_7d": { "type": "number", "description": "7 day change in the specified currency at the end of the requested UTC day.", "example": -19.64 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced.", "example": "2018-06-02T23:59:59.999Z" } }, "required": [ "price", "volume_24h", "market_cap", "percent_change_1h", "percent_change_24h", "percent_change_7d", "last_updated" ] }, "Cryptocurrency_Listings_Latest_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "example": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } }, "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Quote_object" } }, "Cryptocurrency_Listings_Latest_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for every cryptocurrency that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "cmc_rank": { "type": "integer", "description": "The cryptocurrency's historic CoinMarketCap rank at the end of the requested UTC day.", "example": 5 }, "num_market_pairs": { "type": "integer", "description": "The number of active trading pairs available for this cryptocurrency across supported exchanges.", "example": 500 }, "circulating_supply": { "type": "number", "description": "The approximate number of coins circulating for this cryptocurrency at the end of the requested UTC day.", "example": 16950100 }, "total_supply": { "type": "number", "description": "The approximate total amount of coins in existence right now (minus any coins that have been verifiably burned) at the end of the requested UTC day.", "example": 16950100 }, "max_supply": { "type": "number", "description": "The expected maximum limit of coins ever to be available for this cryptocurrency.", "example": 21000000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency's market data was referenced for this UTC date snapshot. This is always the last update available during the UTC date requested.", "example": "2018-06-02T22:51:28.209Z" }, "date_added": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "tags": { "$ref": "#/components/schemas/tags" }, "platform": { "$ref": "#/components/schemas/platform" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Quote_map" }, "infinite_supply": { "type": "boolean", "description": "Whether this cryptocurrency is known to have an infinite supply." }, "self_reported_circulating_supply": { "type": [ "number", "null" ], "description": "The circulating supply reported by the project team. `null` when not reported." }, "self_reported_market_cap": { "type": [ "number", "null" ], "description": "The market cap based on the self-reported circulating supply. `null` when not reported." }, "tvl_ratio": { "type": [ "number", "null" ], "description": "Ratio of total value locked to market cap. `null` when TVL is not available." } }, "required": [ "id", "name", "symbol", "slug", "cmc_rank", "circulating_supply", "total_supply", "last_updated", "date_added", "tags", "platform", "quote" ] }, "Cryptocurrency_Listings_Latest_-_Results_array": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Cryptocurrency_object" }, "required": ["Cryptocurrency Listings Latest - Cryptocurrency object"] }, "Cryptocurrency_Listings_Latest_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "cmc_rank": 1, "num_market_pairs": 500, "circulating_supply": 17200062, "total_supply": 17200062, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } } }, { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "num_market_pairs": 6089, "circulating_supply": 17200062, "total_supply": 17200062, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 1678.6501384942708, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } }, "cmc_rank": 2 } ], "status": { "timestamp": "2019-04-02T22:44:24.200Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Listings_Latest_-_Quote_object_1": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "price": { "type": "number", "description": "Price in the specified currency for this historical.", "example": 7139.82 }, "volume_24h": { "type": "number", "description": "Rolling 24 hour adjusted volume in the specified currency.", "example": 4885880000 }, "volume_change_24h": { "type": "number", "description": "24 hour change in the specified currencies volume.", "example": 5.75 }, "volume_24h_reported": { "type": "number", "description": "Rolling 24 hour reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d": { "type": "number", "description": "Rolling 7 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d_reported": { "type": "number", "description": "Rolling 7 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d": { "type": "number", "description": "Rolling 30 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d_reported": { "type": "number", "description": "Rolling 30 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "market_cap": { "type": "number", "description": "Market cap in the specified currency.", "example": 121020662982 }, "market_cap_dominance": { "type": "number", "description": "Market cap dominance in the specified currency.", "example": 121020662982 }, "fully_diluted_market_cap": { "type": "number", "description": "Fully diluted market cap in the specified currency.", "example": 121020662982 }, "tvl": { "type": [ "number", "null" ], "description": "Total Value Locked", "example": 0 }, "percent_change_1h": { "type": "number", "description": "1 hour change in the specified currency.", "example": 0.03 }, "percent_change_24h": { "type": "number", "description": "24 hour change in the specified currency.", "example": 5.75 }, "percent_change_7d": { "type": "number", "description": "7 day change in the specified currency.", "example": -19.64 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced.", "example": "2018-06-02T23:59:59.999Z" }, "cex_volume_24h": { "type": "number", "description": "24 hour trading volume from centralized exchanges in the requested currency." }, "dex_volume_24h": { "type": "number", "description": "24 hour trading volume from decentralized exchanges in the requested currency." }, "percent_change_30d": { "type": "number", "description": "30 day price change as a percentage." }, "percent_change_60d": { "type": "number", "description": "60 day price change as a percentage." }, "percent_change_90d": { "type": "number", "description": "90 day price change as a percentage." } }, "required": [ "price", "volume_24h", "market_cap", "market_cap_dominance", "fully_diluted_market_cap", "percent_change_1h", "percent_change_24h", "percent_change_7d", "last_updated" ] }, "Cryptocurrency_Listings_Latest_-_Quote_map_1": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "example": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "volume_change_24h": -0.152774, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "market_cap_dominance": 51, "fully_diluted_market_cap": 952835089431.14, "last_updated": "2018-08-09T22:53:32.000Z" } }, "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Quote_object_1" } }, "Cryptocurrency_Listings_Latest_-_Cryptocurrency_object_1": { "type": "object", "description": "A cryptocurrency object for every cryptocurrency that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "cmc_rank": { "type": "integer", "description": "The cryptocurrency's CoinMarketCap rank by market cap.", "example": 5 }, "num_market_pairs": { "type": "integer", "description": "The number of active trading pairs available for this cryptocurrency across supported exchanges.", "example": 500 }, "circulating_supply": { "type": "number", "description": "The approximate number of coins circulating for this cryptocurrency.", "example": 16950100 }, "total_supply": { "type": "number", "description": "The approximate total amount of coins in existence right now (minus any coins that have been verifiably burned).", "example": 16950100 }, "market_cap_by_total_supply": { "type": "number", "description": "The market cap by total supply. *This field is only returned if requested through the `aux` request parameter.*", "example": 158055024432 }, "max_supply": { "type": [ "number", "null" ], "description": "The expected maximum limit of coins ever to be available for this cryptocurrency.", "example": 21000000 }, "infinite_supply": { "type": "boolean", "description": "The cryptocurrency is known to have an infinite supply.", "example": false }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's market data was updated.", "example": "2018-06-02T22:51:28.209Z" }, "date_added": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "tags": { "$ref": "#/components/schemas/tags" }, "self_reported_circulating_supply": { "type": ["number", "null"], "description": "The self reported number of coins circulating for this cryptocurrency.", "example": 16950100 }, "self_reported_market_cap": { "type": ["number", "null"], "description": "The self reported market cap for this cryptocurrency.", "example": 16950100 }, "tvl_ratio": { "type": [ "number", "null" ], "description": "Percentage of Total Value Locked", "example": 0 }, "platform": { "$ref": "#/components/schemas/platform" }, "minted_market_cap": { "type": "number", "description": "The minted market cap for this cryptocurrency.", "example": 1802955697670.94 }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Quote_map_1" } }, "required": ["id", "name", "symbol", "slug", "last_updated", "quote"] }, "Cryptocurrency_Listings_Latest_-_Results_array_1": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Cryptocurrency_object_1" }, "required": ["Cryptocurrency Listings Latest - Cryptocurrency object"] }, "Cryptocurrency_Listings_Latest_-_Response_Model_1": { "type": "object", "example": { "data": [ { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "cmc_rank": 5, "num_market_pairs": 500, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "infinite_supply": false, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "self_reported_circulating_supply": null, "self_reported_market_cap": null, "minted_market_cap": 1802955697670.94, "quote": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "volume_change_24h": -0.152774, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 852164659250.2758, "market_cap_dominance": 51, "fully_diluted_market_cap": 952835089431.14, "last_updated": "2018-08-09T22:53:32.000Z" } } }, { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "num_market_pairs": 6360, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "infinite_supply": false, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "minted_market_cap": 364793475572.53, "quote": { "USD": { "price": 1283.92, "volume_24h": 7155680000, "volume_change_24h": -0.152774, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "market_cap_dominance": 51, "fully_diluted_market_cap": 952835089431.14, "last_updated": "2018-08-09T22:53:32.000Z" } } } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Results_array_1" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Listings_Latest_-_Quote_object_2": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "price": { "type": "number", "description": "Price in the specified currency for this historical.", "example": 7139.82 }, "volume_24h": { "type": "number", "description": "Rolling 24 hour adjusted volume in the specified currency.", "example": 4885880000 }, "volume_change_24h": { "type": "number", "description": "24 hour change in the specified currencies volume.", "example": 5.75 }, "volume_24h_reported": { "type": "number", "description": "Rolling 24 hour reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d": { "type": "number", "description": "Rolling 7 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d_reported": { "type": "number", "description": "Rolling 7 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d": { "type": "number", "description": "Rolling 30 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d_reported": { "type": "number", "description": "Rolling 30 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "market_cap": { "type": "number", "description": "Market cap in the specified currency.", "example": 121020662982 }, "market_cap_dominance": { "type": "number", "description": "Market cap dominance in the specified currency.", "example": 121020662982 }, "fully_diluted_market_cap": { "type": "number", "description": "Fully diluted market cap in the specified currency.", "example": 121020662982 }, "percent_change_1h": { "type": "number", "description": "1 hour change in the specified currency.", "example": 0.03 }, "percent_change_24h": { "type": "number", "description": "24 hour change in the specified currency.", "example": 5.75 }, "percent_change_7d": { "type": "number", "description": "7 day change in the specified currency.", "example": -19.64 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced.", "example": "2018-06-02T23:59:59.999Z" }, "cex_volume_24h": { "type": "number", "description": "24 hour trading volume from centralized exchanges in the requested currency." }, "dex_volume_24h": { "type": "number", "description": "24 hour trading volume from decentralized exchanges in the requested currency." }, "percent_change_30d": { "type": "number", "description": "30 day price change as a percentage." }, "percent_change_60d": { "type": "number", "description": "60 day price change as a percentage." }, "percent_change_90d": { "type": "number", "description": "90 day price change as a percentage." }, "tvl": { "type": [ "number", "null" ], "description": "Total value locked in the requested currency. `null` when TVL is not available." } }, "required": [ "price", "volume_24h", "market_cap", "market_cap_dominance", "fully_diluted_market_cap", "percent_change_1h", "percent_change_24h", "percent_change_7d", "last_updated" ] }, "Cryptocurrency_Listings_Latest_-_Quote_map_2": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "example": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "volume_change_24h": -0.152774, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "market_cap_dominance": 51, "fully_diluted_market_cap": 952835089431.14, "last_updated": "2018-08-09T22:53:32.000Z" } }, "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Quote_object_2" } }, "Cryptocurrency_Listings_Latest_-_Cryptocurrency_object_2": { "type": "object", "description": "A cryptocurrency object for every cryptocurrency that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "cmc_rank": { "type": "integer", "description": "The cryptocurrency's CoinMarketCap rank by market cap.", "example": 5 }, "num_market_pairs": { "type": "integer", "description": "The number of active trading pairs available for this cryptocurrency across supported exchanges.", "example": 500 }, "circulating_supply": { "type": "number", "description": "The approximate number of coins circulating for this cryptocurrency.", "example": 16950100 }, "total_supply": { "type": "number", "description": "The approximate total amount of coins in existence right now (minus any coins that have been verifiably burned).", "example": 16950100 }, "market_cap_by_total_supply": { "type": "number", "description": "The market cap by total supply. *This field is only returned if requested through the `aux` request parameter.*", "example": 158055024432 }, "max_supply": { "type": [ "number", "null" ], "description": "The expected maximum limit of coins ever to be available for this cryptocurrency.", "example": 21000000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's market data was updated.", "example": "2018-06-02T22:51:28.209Z" }, "date_added": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "tags": { "$ref": "#/components/schemas/tags" }, "platform": { "$ref": "#/components/schemas/platform" }, "minted_market_cap": { "type": "number", "description": "The minted market cap for this cryptocurrency.", "example": 1802955697670.94 }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Quote_map_2" }, "is_active": { "type": "integer", "description": "1 if this cryptocurrency has at least 1 active market currently being tracked by the platform, otherwise 0." }, "infinite_supply": { "type": "boolean", "description": "Whether this cryptocurrency is known to have an infinite supply." }, "is_fiat": { "type": "integer", "description": "1 if this is a fiat currency, otherwise 0." }, "tvl_ratio": { "type": [ "number", "null" ], "description": "Ratio of total value locked to market cap. `null` when TVL is not available." }, "self_reported_circulating_supply": { "type": [ "number", "null" ], "description": "The circulating supply reported by the project team. `null` when not reported." }, "self_reported_market_cap": { "type": [ "number", "null" ], "description": "The market cap based on the self-reported circulating supply. `null` when not reported." } }, "required": ["id", "name", "symbol", "slug", "last_updated", "quote"] }, "Cryptocurrency_Listings_New_-_Results_array": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Listings_Latest_-_Cryptocurrency_object_2" }, "required": ["Cryptocurrency Listings Latest - Cryptocurrency object"] }, "Cryptocurrency_Listings_New_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "cmc_rank": 5, "num_market_pairs": 500, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "minted_market_cap": 1802955697670.94, "quote": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "volume_change_24h": -0.152774, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 852164659250.2758, "market_cap_dominance": 51, "fully_diluted_market_cap": 952835089431.14, "last_updated": "2018-08-09T22:53:32.000Z" } } }, { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "num_market_pairs": 6360, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "minted_market_cap": 364793475572.53, "quote": { "USD": { "price": 1283.92, "volume_24h": 7155680000, "volume_change_24h": -0.152774, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "market_cap_dominance": 51, "fully_diluted_market_cap": 952835089431.14, "last_updated": "2018-08-09T22:53:32.000Z" } } } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Listings_New_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Market_Pairs_Latest_-_Exchange_Info_object": { "type": "object", "description": "Exchange details for this market pair.", "properties": { "id": { "type": "integer", "description": "The id of the exchange this market pair is under.", "example": 1 }, "slug": { "type": "string", "description": "The slug of the exchange this market pair is under.", "example": "binance" }, "name": { "type": "string", "description": "The name of the exchange this market pair is under.", "example": "binance" }, "notice": { "type": "string", "description": "A [Markdown](https://commonmark.org/help/) formatted message outlining a condition that is impacting the availability of this exchange's market data or the secure use of the exchange, otherwise null. This may include a maintenance event on the exchange's end or CoinMarketCap's end, an alert about reported issues with withdrawls from this exchange, or another condition that may be impacting this exchange and it's markets. If present, this notice is also displayed in an alert banner at the top of the exchange's page on coinmarketcap.com. *This field is only returned if requested through the `aux` request parameter.*", "example": "The BTC/USD market on BitMEX is a derivatives market NOT actually spot trading Bitcoin. As a result, it has been excluded from the price and volume averages of Bitcoin." } }, "required": ["id", "slug", "name"] }, "Cryptocurrency_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object": { "type": "object", "description": "Base currency details object for this market pair.", "properties": { "currency_id": { "type": "integer", "description": "The CoinMarketCap ID for the base currency in this market pair.", "example": 1 }, "currency_name": { "type": "string", "description": "The name of this cryptocurrency. *This field is only returned if requested through the `aux` request parameter.*", "example": "Bitcoin" }, "currency_symbol": { "type": "string", "description": "The CoinMarketCap identified symbol for the base currency in this market pair.", "example": "BTC" }, "currency_slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name. *This field is only returned if requested through the `aux` request parameter.*", "example": "bitcoin" }, "exchange_symbol": { "type": "string", "description": "The exchange reported symbol for the base currency in this market pair. In most cases this is identical to CoinMarketCap's symbol but it may differ if the exchange uses an outdated or contentious symbol that contrasts with the majority of other markets.", "example": "BTC" }, "currency_type": { "type": "string", "description": "The currency type for the base currency in this market pair.", "example": "cryptocurrency", "enum": ["cryptocurrency", "fiat"] } }, "required": ["currency_id", "currency_symbol", "exchange_symbol", "currency_type"] }, "Cryptocurrency_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object_1": { "type": "object", "description": "Quote (secondary) currency details object for this market pair.", "properties": { "currency_id": { "type": "integer", "description": "The CoinMarketCap ID for the quote (secondary) currency in this market pair.", "example": 2781 }, "currency_name": { "type": "string", "description": "The name of this cryptocurrency. *This field is only returned if requested through the `aux` request parameter.*", "example": "Bitcoin" }, "currency_symbol": { "type": "string", "description": "The symbol for the quote (secondary) currency in this market pair.", "example": "USD" }, "currency_slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name. *This field is only returned if requested through the `aux` request parameter.*", "example": "bitcoin" }, "exchange_symbol": { "type": "string", "description": "The exchange reported symbol for the quote (secondary) currency in this market pair. In most cases this is identical to CoinMarketCap's symbol but it may differ if the exchange uses an outdated or contentious symbol that contrasts with the majority of other markets.", "example": "USD" }, "currency_type": { "type": "string", "description": "The currency type for the quote (secondary) currency in this market pair.", "example": "fiat", "enum": ["cryptocurrency", "fiat"] } }, "required": ["currency_id", "currency_symbol", "exchange_symbol", "currency_type"] }, "Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Exchange_Reported_Quote": { "type": "object", "description": "A default exchange reported quote containing raw exchange reported values.", "properties": { "price": { "type": "number", "description": "The lastest exchange reported price for this market pair in quote currency units.", "example": 8000.23 }, "volume_24h_base": { "type": "number", "description": "The latest exchange reported 24 hour rolling volume for this market pair in base cryptocurrency units.", "example": 30768 }, "volume_24h_quote": { "type": "number", "description": "The latest exchange reported 24 hour rolling volume for this market pair in quote cryptocurrency units.", "example": 250448443.2 }, "effective_liquidity": { "type": "string", "x-hidden": true }, "market_score": { "type": "string", "x-hidden": true }, "market_reputation": { "type": "string", "x-hidden": true }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this market data was updated.", "example": "2018-06-02T23:59:59.999Z" } }, "required": ["price", "volume_24h_base", "volume_24h_quote", "last_updated"] }, "Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Quote": { "type": "object", "description": "One or more market quotes where $key is the conversion currency requested, ex. USD", "properties": { "price": { "type": "number", "description": "The lastest exchange reported price for this market pair converted into the requested convert currency.", "example": 8000.23 }, "price_quote": { "type": "number", "description": "The latest exchange reported price in base units converted into the requested convert currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 8000.23 }, "volume_24h": { "type": "number", "description": "The latest exchange reported 24 hour rolling volume in quote units for this market pair converted into the requested convert currency.", "example": 1600000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2018-06-02T23:59:59.999Z" } }, "required": ["price", "volume_24h", "last_updated"] }, "Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Quote_object": { "type": "object", "description": "Market Pair quotes object containing key->quote objects for each convert option requested. USD and \"exchange_reported\" are defaults.", "properties": { "exchange_reported": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Exchange_Reported_Quote" } }, "required": ["exchange_reported"], "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Quote" } }, "Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Info_object": { "type": "object", "description": "Market Pair info object.", "properties": { "exchange": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Exchange_Info_object" }, "market_id": { "type": "integer", "description": "The CoinMarketCap ID for this market pair. This ID can reliably be used to identify this unique market as the ID never changes.", "example": 9933 }, "market_pair": { "type": "string", "description": "The name of this market pair. Example: \"BTC/USD\"", "example": "BTC/USD" }, "category": { "type": "string", "description": "The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.", "example": "spot", "enum": ["spot", "derivatives", "otc"] }, "fee_type": { "type": "string", "description": "The fee type the exchange enforces for this market.", "example": "percentage", "enum": ["percentage", "no-fees", "transactional-mining", "unknown"] }, "market_url": { "type": "string", "description": "The URL to this market's trading page on the exchange if available. If not available the exchange's homepage URL is returned. *This field is only returned if requested through the `aux` request parameter.*", "example": "https://www.binance.com/en/trade/BTC_USDT" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Quote_object" }, "market_pair_base": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object" }, "market_pair_quote": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object_1" }, "outlier_detected": { "type": "integer", "description": "1 if this market pair has been flagged as an outlier, otherwise 0." }, "exclusions": { "type": ["array", "null"], "description": "Reasons this market pair is excluded from aggregate calculations, if any.", "items": { "type": "string" } } }, "required": ["exchange", "market_pair_base", "market_pair_quote", "quote"] }, "Cryptocurrency_Market_Pairs_Latest_-_Market_Pairs_array": { "type": "array", "description": "Array of all market pairs for this cryptocurrency.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Market_Pair_Info_object" }, "required": ["Cryptocurrency Market Pairs Latest - Market Pair Info object"] }, "Cryptocurrency_Market_Pairs_Latest_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "id": 1, "name": "Bitcoin", "symbol": "BTC", "num_market_pairs": 7526, "market_pairs": [ { "exchange": { "id": 157, "name": "BitMEX", "slug": "bitmex" }, "market_id": 4902, "market_pair": "BTC/USD", "category": "derivatives", "fee_type": "no-fees", "market_pair_base": { "currency_id": 1, "currency_symbol": "BTC", "exchange_symbol": "XBT", "currency_type": "cryptocurrency" }, "market_pair_quote": { "currency_id": 2781, "currency_symbol": "USD", "exchange_symbol": "USD", "currency_type": "fiat" }, "quote": { "exchange_reported": { "price": 7839, "volume_24h_base": 434215.85308502, "volume_24h_quote": 3403818072.33347, "last_updated": "2019-05-24T02:39:00.000Z" }, "USD": { "price": 7839, "volume_24h": 3403818072.33347, "last_updated": "2019-05-24T02:39:00.000Z" } } }, { "exchange": { "id": 108, "name": "Negocie Coins", "slug": "negocie-coins" }, "market_id": 3377, "market_pair": "BTC/BRL", "category": "spot", "fee_type": "percentage", "market_pair_base": { "currency_id": 1, "currency_symbol": "BTC", "exchange_symbol": "BTC", "currency_type": "cryptocurrency" }, "market_pair_quote": { "currency_id": 2783, "currency_symbol": "BRL", "exchange_symbol": "BRL", "currency_type": "fiat" }, "quote": { "exchange_reported": { "price": 33002.11, "volume_24h_base": 336699.03559957, "volume_24h_quote": 11111778609.7509, "last_updated": "2019-05-24T02:39:00.000Z" }, "USD": { "price": 8165.02539531659, "volume_24h": 2749156176.2491, "last_updated": "2019-05-24T02:39:00.000Z" } } } ] }, "properties": { "id": { "type": "integer", "description": "The CoinMarketCap ID for this cryptocurrency.", "example": 1, "minimum": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The symbol for this cryptocurrency.", "example": "BTC" }, "num_market_pairs": { "type": "integer", "description": "The number of active market pairs listed for this cryptocurrency. This number is filtered down to only matching markets if a `matched` parameter is used.", "example": 303 }, "market_pairs": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Market_Pairs_array" } }, "required": ["id", "name", "symbol", "market_pairs"] }, "Cryptocurrency_Market_Pairs_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Market_Pairs_Latest_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_OHLCV_Historical_-_Quote_object": { "type": "object", "description": "A market quote in each currency conversion option.", "properties": { "open": { "type": "number", "description": "Opening price for time series interval.", "example": 3849.21640853 }, "high": { "type": "number", "description": "Highest price during this time series interval.", "example": 3947.9812729 }, "low": { "type": "number", "description": "Lowest price during this time series interval.", "example": 3817.40949569 }, "close": { "type": "number", "description": "Closing price for this time series interval.", "example": 3943.40933686 }, "volume": { "type": "number", "description": "Adjusted volume for this time series interval. Volume is not currently supported for hourly OHLCV intervals before 2020-09-22.", "example": 5244856835.70851 }, "market_cap": { "type": "number", "description": "Market cap by circulating supply for this time series interval.", "example": 68849856731.6738 }, "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2019-01-02T23:59:59.999Z" } }, "required": ["open", "high", "low", "close", "volume", "market_cap", "timestamp"] }, "Cryptocurrency_OHLCV_Historical_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Quote_object" } }, "Cryptocurrency_OHLCV_Historical_-_Interval_Quote_object": { "type": "object", "description": "An OHLCV quote for the supplied interval.", "properties": { "time_open": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the start of this time series interval.", "example": "2018-06-02T00:00:00.000Z" }, "time_close": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the end of this time series interval.", "example": "2018-06-02T23:59:59.999Z" }, "time_high": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the high of this time series interval.", "example": "2018-06-02T22:59:59.999Z" }, "time_low": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the low of this time series interval.", "example": "2018-06-02T21:59:59.999Z" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Quote_map" } }, "required": ["time_open", "time_close", "time_high", "time_low", "quote"] }, "Cryptocurrency_OHLCV_Historical_-_Interval_Quotes_array": { "type": "array", "description": "An array of OHLCV quotes for the supplied interval.", "items": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Interval_Quote_object" }, "required": ["Cryptocurrency OHLCV Historical - Interval Quote object"] }, "Cryptocurrency_OHLCV_Historical_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "id": 1, "name": "Bitcoin", "symbol": "BTC", "quotes": [ { "time_open": "2019-01-02T00:00:00.000Z", "time_close": "2019-01-02T23:59:59.999Z", "time_high": "2019-01-02T03:53:00.000Z", "time_low": "2019-01-02T02:43:00.000Z", "quote": { "USD": { "open": 3849.21640853, "high": 3947.9812729, "low": 3817.40949569, "close": 3943.40933686, "volume": 5244856835.70851, "market_cap": 68849856731.6738, "timestamp": "2019-01-02T23:59:59.999Z" } } }, { "time_open": "2019-01-03T00:00:00.000Z", "time_close": "2019-01-03T23:59:59.999Z", "time_high": "2019-01-02T03:53:00.000Z", "time_low": "2019-01-02T02:43:00.000Z", "quote": { "USD": { "open": 3931.04863841, "high": 3935.68513083, "low": 3826.22287069, "close": 3836.74131867, "volume": 4530215218.84018, "market_cap": 66994920902.7202, "timestamp": "2019-01-03T23:59:59.999Z" } } } ] }, "properties": { "id": { "type": "integer", "description": "The CoinMarketCap cryptocurrency ID.", "example": 1 }, "name": { "type": "string", "description": "The cryptocurrency name.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The cryptocurrency symbol.", "example": "BTC" }, "quotes": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Interval_Quotes_array" } }, "required": ["id", "name", "symbol", "quotes"] }, "Cryptocurrency_OHLCV_Historical_-_Response_Model": { "type": "object", "properties": { "data": { "description": "A single object when you request one cryptocurrency, and an object map keyed by cryptocurrency ID when you request several.", "oneOf": [ { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Results_object" } }, { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Historical_-_Results_object" } ] }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_OHLCV_Latest_-_Quote_object": { "type": "object", "description": "A market quote in each currency conversion option.", "properties": { "open": { "type": "number", "description": "Price from first datapoint of today in UTC time for the convert option requested.", "example": 966.34 }, "high": { "type": "number", "description": "Highest price so far today in UTC time for the convert option requested.", "example": 1005 }, "low": { "type": "number", "description": "Lowest price today in UTC time for the convert option requested.", "example": 960.53 }, "close": { "type": "number", "description": "Latest price today in UTC time for the convert option requested. This is not the final price during close as the current day period is not over.", "example": 997.75 }, "volume": { "type": "number", "description": "Aggregate 24 hour adjusted volume for the convert option requested. Please note, this is a rolling 24 hours back from the current time.", "example": 6850.59330859 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was last updated when referenced for this conversion.", "example": "2018-06-02T00:00:00.000Z" } }, "required": ["open", "high", "low", "close", "volume", "last_updated"] }, "Cryptocurrency_OHLCV_Latest_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Latest_-_Quote_object" } }, "Cryptocurrency_OHLCV_Latest_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for each requested.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the lastest market value record included to generate the latest active day OHLCV values.", "example": "2018-06-02T23:59:59.999Z" }, "time_open": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the start of this OHLCV period.", "example": "2018-06-02T00:00:00.000Z" }, "time_high": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the high of this OHLCV period.", "example": "2018-06-02T00:00:00.000Z" }, "time_low": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the low of this OHLCV period.", "example": "2018-06-02T00:00:00.000Z" }, "time_close": { "type": [ "string", "null" ], "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the end of this OHLCV period. Always `null` as the current day is incomplete. See `last_updated` for the last UTC time included in the current OHLCV calculation.", "example": "null" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Latest_-_Quote_map" } }, "required": [ "id", "name", "symbol", "last_updated", "time_open", "time_high", "time_low", "time_close", "quote" ] }, "Cryptocurrency_OHLCV_Latest_-_Cryptocurrency_Results_map": { "type": "object", "description": "A map of cryptocurrency objects by ID or symbol (as passed in query parameters).", "example": { "1": { "id": 1, "name": "Bitcoin", "symbol": "BTC", "last_updated": "2018-09-10T18:54:00.000Z", "time_open": "2018-09-10T00:00:00.000Z", "time_close": "2019-08-30T23:59:59.999Z", "time_high": "2018-09-10T00:00:00.000Z", "time_low": "2018-09-10T00:00:00.000Z", "quote": { "USD": { "open": 6301.57, "high": 6374.98, "low": 6292.76, "close": 6308.76, "volume": 3786450000, "last_updated": "2018-09-10T18:54:00.000Z" } } } }, "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Latest_-_Cryptocurrency_object" } }, "Cryptocurrency_OHLCV_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_OHLCV_Latest_-_Cryptocurrency_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Price_Performance_Stats_Latest_-_Quote_object": { "type": "object", "description": "A time period quote in the currency conversion option.", "properties": { "open": { "type": "number", "description": "Cryptocurrency price at the start of the requested time period historically converted into units of the convert currency.", "example": 135.3000030517578 }, "open_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the closest convert currency reference price used during `open` price conversion.", "example": "2013-04-28T00:00:00.000Z" }, "high": { "type": "number", "description": "Highest USD price achieved within the requested time period historically converted into units of the convert currency.", "example": 20088.99609375 }, "high_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the closest convert currency reference price used during `high` price conversion. *For `yesterday` UTC close will be used.*", "example": "2017-12-17T12:19:14.000Z" }, "low": { "type": "number", "description": "Lowest USD price achieved within the requested time period historically converted into units of the convert currency.", "example": 65.5260009765625 }, "low_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the closest convert currency reference price used during `low` price conversion. *For `yesterday` UTC close will be used.*", "example": "2013-07-05T18:56:01.000Z" }, "close": { "type": "number", "description": "Cryptocurrency price at the end of the requested time period historically converted into units of the convert currency.", "example": 9908.99193585 }, "close_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the closest convert currency reference price used during `close` price conversion.", "example": "2019-08-22T01:52:18.618Z" }, "percent_change": { "type": "number", "description": "The approximate percentage change (ROI) if purchased at the start of the time period. This is the time of launch or earliest known price for the `all_time` period. This value includes historical change in market rate for the specified convert currency.", "example": 7223.718930042746 }, "price_change": { "type": "number", "description": "The actual price change between the start of the time period and end. This is the time of launch or earliest known price for the `all_time` period. This value includes historical change in market rate for the specified convert currency.", "example": 9773.691932798241 } }, "required": [ "open", "open_timestamp", "high", "high_timestamp", "low", "low_timestamp", "close", "close_timestamp", "percent_change", "price_change" ] }, "Cryptocurrency_Price_Performance_Stats_Latest_-_Quote_map": { "type": "object", "description": "An object map of time period quotes for each convert option requested. The default map included is USD.", "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Quote_object" } }, "Cryptocurrency_Price_Performance_Stats_Latest_-_Period_object": { "type": "object", "description": "A time period data object. `all_time` is the default.", "properties": { "open_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the start of this time period. Please note that this is a rolling period back from current time for time periods outside of `yesterday`.", "example": "2013-04-28T00:00:00.000Z" }, "high_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency achieved it's highest USD price during the requested time period. *Note: The `yesterday` period currently doesn't support this field and will return `null`.*", "example": "2017-12-17T12:19:14.000Z" }, "low_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency achieved it's lowest USD price during the requested time period. *Note: The `yesterday` period currently doesn't support this field and will return `null`.*", "example": "2013-07-05T18:56:01.000Z" }, "close_timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the end of this time period. Please note that this is a rolling period back from current time for time periods outside of `yesterday`.", "example": "2019-08-22T01:52:18.613Z" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Quote_map" } }, "required": [ "open_timestamp", "high_timestamp", "low_timestamp", "close_timestamp", "quote" ] }, "Cryptocurrency_Price_Performance_Stats_Latest_-_Period_object_map": { "type": "object", "description": "An object map of time periods by period requested.", "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Period_object" } }, "Cryptocurrency_Price_Performance_Stats_Latest_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for each requested.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's market data was updated.", "example": "2019-08-22T01:51:32.000Z" }, "periods": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Period_object_map" } }, "required": ["id", "name", "symbol", "slug", "last_updated", "periods"] }, "Cryptocurrency_Price_Performance_Stats_Latest_-_Cryptocurrency_Results_map": { "type": "object", "description": "An object map of cryptocurrency objects by ID, slug, or symbol (as used in query parameters).", "example": { "1": { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "last_updated": "2019-08-22T01:51:32.000Z", "periods": { "USD": { "open_timestamp": "2013-04-28T00:00:00.000Z", "high_timestamp": "2017-12-17T12:19:14.000Z", "low_timestamp": "2013-07-05T18:56:01.000Z", "close_timestamp": "2019-08-22T01:52:18.613Z", "quote": { "USD": { "open": 135.3000030517578, "open_timestamp": "2013-04-28T00:00:00.000Z", "high": 20088.99609375, "high_timestamp": "2017-12-17T12:19:14.000Z", "low": 65.5260009765625, "low_timestamp": "2013-07-05T18:56:01.000Z", "close": 65.5260009765625, "close_timestamp": "2019-08-22T01:52:18.618Z", "percent_change": 7223.718930042746, "price_change": 9773.691932798241 } } } } } }, "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Cryptocurrency_object" } }, "Cryptocurrency_Price_Performance_Stats_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Price_Performance_Stats_Latest_-_Cryptocurrency_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Quotes_Historical_-_Currency_Quote_object": { "type": "object", "description": "The market details for the current interval and currency conversion option. The map key being the curency symbol.", "properties": { "price": { "type": "number", "description": "Price at this interval quote.", "example": 1235000 }, "volume_24h": { "type": "number", "description": "Aggregate 24 hour adjusted volume for all market pairs tracked for this cryptocurrency at the current historical interval.", "example": 1235000 }, "market_cap": { "type": "number", "description": "Number of market pairs available at the current historical interval.", "example": 123456789 }, "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2018-06-02T22:51:28.209Z" }, "percent_change_1h": { "type": "number", "description": "1 hour price change as a percentage, at the time of this quote." }, "percent_change_24h": { "type": "number", "description": "24 hour price change as a percentage, at the time of this quote." }, "percent_change_7d": { "type": "number", "description": "7 day price change as a percentage, at the time of this quote." }, "percent_change_30d": { "type": "number", "description": "30 day price change as a percentage, at the time of this quote." }, "circulating_supply": { "type": "number", "description": "Circulating supply at the time of this quote." }, "total_supply": { "type": "number", "description": "Total supply at the time of this quote." } }, "required": [ "price", "volume_24h", "market_cap", "timestamp" ] }, "Cryptocurrency_Quotes_Historical_-_Quote_currency_map": { "type": "object", "description": "A map of market details for this quote in different currency conversions. The default map included is USD.", "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Currency_Quote_object" } }, "Cryptocurrency_Quotes_Historical_-_Interval_Quote_object": { "type": "object", "description": "An object containing details for the current interval quote.", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp of when this historical quote was recorded.", "example": "2018-06-02T23:59:59.999Z" }, "search_interval": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "The interval timestamp for the search period that this historical quote was located against. *This field is only returned if requested through the `aux` request parameter.*", "example": "2018-06-02T00:00:00.000Z" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Quote_currency_map" } }, "required": ["timestamp", "quote"] }, "Cryptocurrency_Quotes_Historical_-_Interval_Quotes_array": { "type": "array", "description": "An array of quotes for each interval for this cryptocurrency.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Interval_Quote_object" }, "required": ["Cryptocurrency Quotes Historical - Interval Quote object"] }, "Cryptocurrency_Quotes_Historical_-_Result_object": { "type": "object", "description": "A results object for each cryptocurrency requested. The map key being the id/symbol used in the request.", "properties": { "id": { "type": "integer", "description": "The CoinMarketCap cryptocurrency ID.", "example": 1 }, "name": { "type": "string", "description": "The cryptocurrency name.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The cryptocurrency symbol.", "example": "BTC" }, "is_active": { "type": "integer", "description": "1 if this cryptocurrency has at least 1 active market currently being tracked by the platform, otherwise 0. A value of 1 is analogous with `listing_status=active`.", "example": 1, "minimum": 0, "maximum": 1 }, "is_fiat": { "type": "integer", "description": "1 if this is a fiat", "example": 1, "minimum": 0, "maximum": 1 }, "quotes": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Interval_Quotes_array" } }, "required": ["id", "name", "symbol", "quotes"] }, "Cryptocurrency_Quotes_Historical_-_Results_map": { "type": "object", "description": "Results of your query returned as an object map.", "example": { "1": { "id": 1, "name": "Bitcoin", "symbol": "BTC", "is_active": 1, "is_fiat": 0, "quotes": [ { "timestamp": "2018-06-22T00:00:00.000Z", "quote": { "USD": { "price": 6242.48, "volume_24h": 4894120000, "market_cap": 107057808682, "timestamp": "2018-06-22T00:04:16.000Z" } } } ] } }, "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Result_object" } }, "Cryptocurrency_Quotes_Historical_-_Response_Model": { "type": "object", "properties": { "data": { "description": "The v3 endpoint always returns an object map keyed by cryptocurrency ID. The v1 and v2 endpoints return a single object when you request one cryptocurrency, and an object map keyed by ID when you request several.", "oneOf": [ { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Results_map" }, { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Historical_-_Result_object" } ] }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Quotes_Latest_-_Quote_object": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "price": { "type": [ "number", "null" ], "description": "Price in the specified currency.", "example": 7139.82 }, "volume_24h": { "type": "number", "description": "Rolling 24 hour adjusted volume in the specified currency.", "example": 4885880000 }, "volume_change_24h": { "type": "number", "description": "24 hour change in the specified currencies volume.", "example": 5.75 }, "volume_24h_reported": { "type": "number", "description": "Rolling 24 hour reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d": { "type": "number", "description": "Rolling 7 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_7d_reported": { "type": "number", "description": "Rolling 7 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d": { "type": "number", "description": "Rolling 30 day adjusted volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "volume_30d_reported": { "type": "number", "description": "Rolling 30 day reported volume in the specified currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 4885880000 }, "market_cap": { "type": [ "number", "null" ], "description": "Market cap in the specified currency.", "example": 121020662982 }, "market_cap_dominance": { "type": "number", "description": "Market cap dominance in the specified currency.", "example": 121020662982 }, "fully_diluted_market_cap": { "type": "number", "description": "Fully diluted market cap in the specified currency.", "example": 121020662982 }, "percent_change_1h": { "type": "number", "description": "1 hour change in the specified currency.", "example": 0.03 }, "percent_change_24h": { "type": "number", "description": "24 hour change in the specified currency.", "example": 5.75 }, "percent_change_7d": { "type": "number", "description": "7 day change in the specified currency.", "example": -19.64 }, "percent_change_30d": { "type": "number", "description": "30 day change in the specified currency.", "example": -19.64 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced.", "example": "2018-06-02T23:59:59.999Z" }, "cex_volume_24h": { "type": "number", "description": "24 hour trading volume from centralized exchanges in the requested currency." }, "dex_volume_24h": { "type": "number", "description": "24 hour trading volume from decentralized exchanges in the requested currency." }, "percent_change_60d": { "type": "number", "description": "60 day price change as a percentage." }, "percent_change_90d": { "type": "number", "description": "90 day price change as a percentage." }, "tvl": { "type": [ "number", "null" ], "description": "Total value locked in the requested currency. `null` when TVL is not available." } }, "required": [ "price", "volume_24h", "market_cap", "market_cap_dominance", "fully_diluted_market_cap", "percent_change_1h", "percent_change_24h", "percent_change_7d", "percent_change_30d", "last_updated" ] }, "Cryptocurrency_Quotes_Latest_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "additionalProperties": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Latest_-_Quote_object" } }, "Cryptocurrency_Quotes_Latest_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for each requested.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "is_active": { "type": "integer", "description": "1 if this cryptocurrency has at least 1 active market currently being tracked by the platform, otherwise 0. A value of 1 is analogous with `listing_status=active`.", "example": 1, "minimum": 0, "maximum": 1 }, "is_fiat": { "type": "integer", "description": "1 if this is a fiat", "example": 1, "minimum": 0, "maximum": 1 }, "cmc_rank": { "type": [ "integer", "null" ], "description": "The cryptocurrency's CoinMarketCap rank by market cap.", "example": 5 }, "num_market_pairs": { "type": "integer", "description": "The number of active trading pairs available for this cryptocurrency across supported exchanges.", "example": 500 }, "circulating_supply": { "type": "number", "description": "The approximate number of coins circulating for this cryptocurrency.", "example": 16950100 }, "total_supply": { "type": "number", "description": "The approximate total amount of coins in existence right now (minus any coins that have been verifiably burned).", "example": 16950100 }, "market_cap_by_total_supply": { "type": "number", "description": "The market cap by total supply. *This field is only returned if requested through the `aux` request parameter.*", "example": 158055024432 }, "max_supply": { "type": [ "number", "null" ], "description": "The expected maximum limit of coins ever to be available for this cryptocurrency.", "example": 21000000 }, "date_added": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "tags": { "type": "array", "description": "Tags associated with this cryptocurrency. The v1 endpoint returns tag slugs as strings. The v2 endpoint returns tag objects with `slug`, `name` and `category`.", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "slug": { "type": "string", "description": "Tag slug." }, "name": { "type": "string", "description": "Tag name." }, "category": { "type": "string", "description": "Tag category, for example `ALGORITHM` or `CATEGORY`." } } } ] } }, "platform": { "$ref": "#/components/schemas/platform" }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's market data was updated.", "example": "2018-06-02T23:59:59.999Z" }, "self_reported_circulating_supply": { "type": ["number", "null"], "description": "The self reported number of coins circulating for this cryptocurrency.", "example": 16950100 }, "self_reported_market_cap": { "type": ["number", "null"], "description": "The self reported market cap for this cryptocurrency.", "example": 16950100 }, "minted_market_cap": { "type": "number", "description": "The minted market cap for this cryptocurrency.", "example": 1802955697670.94 }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Latest_-_Quote_map" }, "infinite_supply": { "type": "boolean", "description": "Whether this cryptocurrency is known to have an infinite supply." }, "tvl_ratio": { "type": [ "number", "null" ], "description": "Ratio of total value locked to market cap. `null` when TVL is not available." } }, "required": ["id", "name", "symbol", "slug", "last_updated", "quote"] }, "Cryptocurrency_Quotes_Latest_-_Cryptocurrency_Results_map": { "type": "object", "description": "A map of cryptocurrency objects by ID, symbol, or slug (as used in query parameters).", "example": { "1": { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "is_active": 1, "is_fiat": 0, "circulating_supply": 17199862, "total_supply": 17199862, "max_supply": 21000000, "date_added": "2013-04-28T00:00:00.000Z", "num_market_pairs": 331, "cmc_rank": 1, "last_updated": "2018-08-09T21:56:28.000Z", "tags": ["mineable"], "platform": null, "self_reported_circulating_supply": null, "self_reported_market_cap": null, "minted_market_cap": 1802955697670.94, "quote": { "USD": { "price": 6602.60701122, "volume_24h": 4314444687.5194, "volume_change_24h": -0.152774, "percent_change_1h": 0.988615, "percent_change_24h": 4.37185, "percent_change_7d": -12.1352, "percent_change_30d": -12.1352, "market_cap": 852164659250.2758, "market_cap_dominance": 51, "fully_diluted_market_cap": 952835089431.14, "last_updated": "2018-08-09T21:56:28.000Z" } } } }, "additionalProperties": { "description": "On the v2 endpoint, requests by `symbol` return an array of objects for each symbol, because more than one cryptocurrency can share a symbol. Requests by `id` or `slug` return a single object.", "oneOf": [ { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Latest_-_Cryptocurrency_object" }, { "type": "array", "items": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Latest_-_Cryptocurrency_object" } } ] } }, "Cryptocurrency_Quotes_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Quotes_Latest_-_Cryptocurrency_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Trending_Gainers_Losers_-_Results_array": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/Cryptocurrency_-_Cryptocurrency_object" }, "required": ["Cryptocurrency Trending Gainers & Losers - Cryptocurrency object"] }, "Cryptocurrency_Trending_Gainers_Losers_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "cmc_rank": 5, "num_market_pairs": 500, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } } }, { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "num_market_pairs": 6360, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 1283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } } } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Trending_Gainers_Losers_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Trending_Latest_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for every cryptocurrency that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "cmc_rank": { "type": "integer", "description": "The cryptocurrency's CoinMarketCap rank by market cap.", "example": 5 }, "is_fiat": { "type": "integer", "description": "1 if this is a fiat", "example": 1, "minimum": 0, "maximum": 1 }, "self_reported_circulating_supply": { "type": ["number", "null"], "description": "The self reported number of coins circulating for this cryptocurrency.", "example": 16950100 }, "self_reported_market_cap": { "type": ["number", "null"], "description": "The self reported market cap for this cryptocurrency.", "example": 16950100 }, "is_active": { "type": "integer", "description": "1 if this cryptocurrency has at least 1 active market currently being tracked by the platform, otherwise 0. A value of 1 is analogous with `listing_status=active`.", "example": 1, "minimum": 0, "maximum": 1 }, "num_market_pairs": { "type": "integer", "description": "The number of active trading pairs available for this cryptocurrency across supported exchanges.", "example": 500 }, "circulating_supply": { "type": "number", "description": "The approximate number of coins circulating for this cryptocurrency.", "example": 16950100 }, "total_supply": { "type": "number", "description": "The approximate total amount of coins in existence right now (minus any coins that have been verifiably burned).", "example": 16950100 }, "market_cap_by_total_supply": { "type": "number", "description": "The market cap by total supply. *This field is only returned if requested through the `aux` request parameter.*", "example": 158055024432 }, "max_supply": { "type": [ "number", "null" ], "description": "The expected maximum limit of coins ever to be available for this cryptocurrency.", "example": 21000000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's market data was updated.", "example": "2018-06-02T22:51:28.209Z" }, "date_added": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this cryptocurrency was added to CoinMarketCap.", "example": "2013-04-28T00:00:00.000Z" }, "tags": { "$ref": "#/components/schemas/tags" }, "platform": { "$ref": "#/components/schemas/platform" }, "quote": { "$ref": "#/components/schemas/Cryptocurrency_-_Quote_map" }, "infinite_supply": { "type": "boolean", "description": "Whether this cryptocurrency is known to have an infinite supply." }, "tvl_ratio": { "type": [ "number", "null" ], "description": "Ratio of total value locked to market cap. `null` when TVL is not available." }, "minted_market_cap": { "type": "number", "description": "Market cap calculated from the minted supply, in the requested currency." } }, "required": ["id", "name", "symbol", "slug", "last_updated", "quote"] }, "Cryptocurrency_Trending_Latest_-_Results_array": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Trending_Latest_-_Cryptocurrency_object" }, "required": ["Cryptocurrency Trending Latest - Cryptocurrency object"] }, "Cryptocurrency_Trending_Latest_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "cmc_rank": 5, "is_active": 1, "is_fiat": 0, "self_reported_circulating_supply": null, "self_reported_market_cap": null, "num_market_pairs": 500, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } } }, { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "num_market_pairs": 6360, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 1283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } } } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Trending_Latest_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Cryptocurrency_Trending_Most_Visited_-_Results_array": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/Cryptocurrency_-_Cryptocurrency_object" }, "required": ["Cryptocurrency Trending Most Visited - Cryptocurrency object"] }, "Cryptocurrency_Trending_Most_Visited_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "cmc_rank": 5, "num_market_pairs": 500, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 9283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } } }, { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "num_market_pairs": 6360, "circulating_supply": 16950100, "total_supply": 16950100, "max_supply": 21000000, "last_updated": "2018-06-02T22:51:28.209Z", "date_added": "2013-04-28T00:00:00.000Z", "tags": ["mineable"], "platform": null, "quote": { "USD": { "price": 1283.92, "volume_24h": 7155680000, "percent_change_1h": -0.152774, "percent_change_24h": 0.518894, "percent_change_7d": 0.986573, "market_cap": 158055024432, "last_updated": "2018-08-09T22:53:32.000Z" } } } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Trending_Most_Visited_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Exchange_Listings_Latest_-_Quote_object": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2018-06-02T23:59:59.999Z" }, "volume_24h": { "type": "number", "description": "Reported 24 hour volume in the specified currency.", "example": 768478308.529847 }, "volume_24h_adjusted": { "type": "number", "description": "Adjusted 24 hour volume in the specified currency for spot markets excluding markets with no fees and transaction mining.", "example": 768478308.529847 }, "volume_7d": { "type": "number", "description": "7 day volume in the specified currency.", "example": 3666423776 }, "volume_30d": { "type": "number", "description": "30 day volume in the specified currency.", "example": 21338299776 }, "percent_change_volume_24h": { "type": "number", "description": "24 hour volume change percentage in the specified currency.", "example": 0.03 }, "percent_change_volume_7d": { "type": "number", "description": "7 day volume change percentage in the specified currency.", "example": 5.75 }, "percent_change_volume_30d": { "type": "number", "description": "30 day volume change percentage in the specified currency.", "example": -19.64 }, "effective_liquidity_24h": { "type": "number", "description": "24 hour liquidity in the specified currency.", "example": -19.64 }, "derivative_volume": { "type": "number", "description": "Reported 24 hour derivative volume in the specified currency.", "example": 768478308.529847 }, "open_interest": { "type": "number", "description": "Reported 24 hour derivative open interest in the specified currency.", "example": 768478308.529847 }, "spot_volume_usd": { "type": "number", "description": "Reported all time spot volume in the specified currency.", "example": 768478308.529847 }, "spot_volume": { "type": "number", "description": "Reported 24 hour spot volume in the specified currency.", "example": 768478308.529847 }, "derivative_volume_usd": { "type": "number", "description": "Aggregate 24h derivative trade volume in USD.", "example": 62828618628.85901 } }, "required": [ "last_updated", "volume_24h", "volume_24h_adjusted", "volume_7d", "volume_30d", "percent_change_volume_24h", "percent_change_volume_7d", "percent_change_volume_30d" ] }, "Exchange_Listings_Latest_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "example": { "USD": { "volume_24h": 1418940000, "last_updated": "2018-11-08T22:18:00.000Z", "volume_24h_adjusted": 1418940000, "volume_7d": 3666423776, "volume_30d": 21338299776, "percent_change_volume_24h": -11.62, "percent_change_volume_7d": 67.21, "percent_change_volume_30d": 0.0017, "effective_liquidity_24h": 629.98 } }, "additionalProperties": { "$ref": "#/components/schemas/Exchange_Listings_Latest_-_Quote_object" } }, "Exchange_Listings_Latest_-_Exchange_object": { "type": "object", "description": "An exchange object for every exchange that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this exchange.", "example": 1 }, "name": { "type": "string", "description": "The name of this exchange.", "example": "Binance" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this exchange name.", "example": "Binance" }, "num_market_pairs": { "type": "integer", "description": "The number of trading pairs actively tracked on this exchange.", "example": 500 }, "date_launched": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the date this exchange launched. *This field is only returned if requested through the `aux` request parameter.*", "example": "2018-06-02T00:00:00.000Z" }, "exchange_score": { "type": [ "number", "null" ], "description": "The exchange score.", "example": 9.8 }, "liquidity_score": { "type": "number", "description": "The liquidity score.", "example": 9.8 }, "rank": { "type": [ "integer", "null" ], "description": "The exchange rank.", "example": 5 }, "traffic_score": { "type": [ "number", "null" ], "description": "The traffic score.", "example": 1000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this record was upated.", "example": "2018-06-02T00:00:00.000Z" }, "quote": { "$ref": "#/components/schemas/Exchange_Listings_Latest_-_Quote_map" }, "num_coins": { "type": "integer", "description": "Number of distinct coins traded on this exchange." } }, "required": ["id", "name", "slug", "last_updated", "quote"] }, "Exchange_Listings_Latest_-_Results_array": { "type": "array", "description": "Array of exchange objects matching the list options.", "example": [ { "id": 270, "name": "Binance", "slug": "binance", "num_market_pairs": 1214, "traffic_score": 1000, "rank": 1, "exchange_score": 9.8, "liquidity_score": 9.8028, "last_updated": "2018-11-08T22:18:00.000Z", "quote": { "USD": { "volume_24h": 769291636.239632, "volume_24h_adjusted": 769291636.239632, "volume_7d": 3666423776, "volume_30d": 21338299776, "percent_change_volume_24h": -11.6153, "percent_change_volume_7d": 67.2055, "percent_change_volume_30d": 0.00169339, "effective_liquidity_24h": 629.9774, "derivative_volume_usd": 62828618628.85901, "spot_volume_usd": 39682580614.8572, "last_updated": "2018-11-08T22:18:00.000Z" } } }, { "id": 294, "name": "OKEx", "slug": "okex", "num_market_pairs": 385, "traffic_score": 845.1565, "rank": 1, "exchange_score": 8.5, "liquidity_score": 9.8028, "last_updated": "2018-11-08T22:18:00.000Z", "quote": { "USD": { "volume_24h": 677439315.721563, "volume_24h_adjusted": 677439315.721563, "volume_7d": 3506137120, "volume_30d": 14418225072, "percent_change_volume_24h": -13.9256, "percent_change_volume_7d": 60.0461, "percent_change_volume_30d": 67.2225, "effective_liquidity_24h": 629.9774, "derivative_volume_usd": 62828618628.85901, "spot_volume_usd": 39682580614.8572, "last_updated": "2018-11-08T22:18:00.000Z" } } } ], "items": { "$ref": "#/components/schemas/Exchange_Listings_Latest_-_Exchange_object" }, "required": ["Exchange Listings Latest - Exchange object"] }, "Exchange_Listings_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Exchange_Listings_Latest_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Exchange_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object": { "type": "object", "description": "Base currency details object for this market pair.", "properties": { "currency_id": { "type": "integer", "description": "The CoinMarketCap ID for the base currency in this market pair.", "example": 1 }, "currency_name": { "type": "string", "description": "The name of this cryptocurrency. *This field is only returned if requested through the `aux` request parameter.*", "example": "Bitcoin" }, "currency_symbol": { "type": "string", "description": "The symbol for the base currency in this market pair.", "example": "BTC" }, "exchange_symbol": { "type": "string", "description": "The exchange reported symbol for the base currency in this market pair. In most cases this is identical to CoinMarketCap's symbol but it may differ if the exchange uses an outdated or contentious symbol that contrasts with the majority of other markets.", "example": "BTC" }, "currency_slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name. *This field is only returned if requested through the `aux` request parameter.*", "example": "bitcoin" }, "currency_type": { "type": "string", "description": "The currency type for the base currency in this market pair.", "example": "cryptocurrency", "enum": ["cryptocurrency", "fiat"] } }, "required": ["currency_id", "currency_symbol", "exchange_symbol", "currency_type"] }, "Exchange_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object_1": { "type": "object", "description": "Quote (secondary) currency details object for this market pair", "properties": { "currency_id": { "type": "integer", "description": "The CoinMarketCap ID for the quote (secondary) currency in this market pair.", "example": 2781 }, "currency_name": { "type": "string", "description": "The name of this cryptocurrency. *This field is only returned if requested through the `aux` request parameter.*", "example": "Bitcoin" }, "currency_symbol": { "type": "string", "description": "The symbol for the quote (secondary) currency in this market pair.", "example": "USD" }, "exchange_symbol": { "type": "string", "description": "The exchange reported symbol for the quote (secondary) currency in this market pair. In most cases this is identical to CoinMarketCap's symbol but it may differ if the exchange uses an outdated or contentious symbol that contrasts with the majority of other markets.", "example": "USD" }, "currency_slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name. *This field is only returned if requested through the `aux` request parameter.*", "example": "bitcoin" }, "currency_type": { "type": "string", "description": "The currency type for the quote (secondary) currency in this market pair.", "example": "fiat", "enum": ["cryptocurrency", "fiat"] } }, "required": ["currency_id", "currency_symbol", "exchange_symbol", "currency_type"] }, "Exchange_Market_Pairs_Latest_-_Market_Pair_Exchange_Reported_Quote": { "type": "object", "description": "A default exchange reported quote containing raw exchange reported values.", "properties": { "price": { "type": "number", "description": "The last exchange reported price for this market pair in quote currency units.", "example": 8000.23 }, "volume_24h_base": { "type": "number", "description": "The last exchange reported 24 hour volume for this market pair in base cryptocurrency units.", "example": 30768 }, "volume_24h_quote": { "type": "number", "description": "The last exchange reported 24 hour volume for this market pair in quote cryptocurrency units.", "example": 250448443.2 }, "volume_percentage": { "type": "number", "description": "Percentage of total exchange volume_24h", "example": 0.03 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this market data was updated.", "example": "2018-06-02T23:59:59.999Z" } }, "required": [ "price", "volume_24h_base", "volume_24h_quote", "volume_percentage", "last_updated" ] }, "Exchange_Market_Pairs_Latest_-_Market_Pair_Quote": { "type": "object", "description": "One or more market quotes where $key is the conversion currency requested, ex. USD", "properties": { "price": { "type": "number", "description": "The last reported exchange price for this market pair converted into the requested convert currency.", "example": 8000.23 }, "price_quote": { "type": "number", "description": "The latest exchange reported price in base units converted into the requested convert currency. *This field is only returned if requested through the `aux` request parameter.*", "example": 8000.23 }, "volume_24h": { "type": "number", "description": "The last reported exchange volume for this market pair converted into the requested convert currency.", "example": 1600000 }, "depth_negative_two": { "type": "number", "description": "-2% Depth in the specified currency.", "example": 1600000 }, "depth_positive_two": { "type": "number", "description": "+2% Depth in the specified currency.", "example": 1600000 }, "effective_liquidity": { "type": "string", "x-hidden": true }, "market_score": { "type": "string", "x-hidden": true }, "market_reputation": { "type": "string", "x-hidden": true }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2018-06-02T23:59:59.999Z" } }, "required": ["price", "volume_24h", "last_updated"] }, "Exchange_Market_Pairs_Latest_-_Market_Pair_Quote_object": { "type": "object", "description": "Market Pair quotes object containing key->quote objects for each convert option requested. USD and \"exchange_reported\" are defaults.", "properties": { "exchange_reported": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Market_Pair_Exchange_Reported_Quote" } }, "required": ["exchange_reported"], "additionalProperties": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Market_Pair_Quote" } }, "Exchange_Market_Pairs_Latest_-_Market_Pair_Info_object": { "type": "object", "description": "Market Pair info object.", "properties": { "market_id": { "type": "integer", "description": "The CoinMarketCap ID for this market pair. This ID can reliably be used to identify this unique market as the ID never changes.", "example": 9933 }, "market_pair": { "type": "string", "description": "The name of this market pair. Example: \"BTC/USD\"", "example": "BTC/USD" }, "category": { "type": "string", "description": "The category of trading this market falls under. Spot markets are the most common but options include derivatives and OTC.", "example": "spot", "enum": ["spot", "derivatives", "otc"] }, "fee_type": { "type": "string", "description": "The fee type the exchange enforces for this market.", "example": "percentage", "enum": ["percentage", "no-fees", "transactional-mining", "unknown"] }, "market_url": { "type": "string", "description": "The URL to this market's trading page on the exchange if available. If not available the exchange's homepage URL is returned. *This field is only returned if requested through the `aux` request parameter.*", "example": "https://www.binance.com/en/trade/BTC_USDT" }, "quote": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Market_Pair_Quote_object" }, "market_pair_base": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object" }, "market_pair_quote": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Pair_Base_Currency_Info_object_1" }, "outlier_detected": { "type": "integer", "description": "1 if this market pair has been flagged as an outlier, otherwise 0." }, "exclusions": { "type": ["array", "null"], "description": "Reasons this market pair is excluded from aggregate calculations, if any.", "items": { "type": "string" } } }, "required": [ "market_id", "market_pair", "category", "market_pair_base", "market_pair_quote", "quote" ] }, "Exchange_Market_Pairs_Latest_-_Market_Pairs_array": { "type": "array", "description": "Array of all active market pairs for this exchange.", "items": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Market_Pair_Info_object" }, "required": ["Exchange Market Pairs Latest - Market Pair Info object"] }, "Exchange_Market_Pairs_Latest_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "id": 270, "name": "Binance", "slug": "binance", "num_market_pairs": 473, "volume_24h": 769291636.239632, "market_pairs": [ { "market_id": 9933, "market_pair": "BTC/USDT", "category": "spot", "fee_type": "percentage", "outlier_detected": 0, "exclusions": null, "market_pair_base": { "currency_id": 1, "currency_symbol": "BTC", "exchange_symbol": "BTC", "currency_type": "cryptocurrency" }, "market_pair_quote": { "currency_id": 825, "currency_symbol": "USDT", "exchange_symbol": "USDT", "currency_type": "cryptocurrency" }, "quote": { "exchange_reported": { "price": 7901.83, "volume_24h_base": 47251.3345550653, "volume_24h_quote": 373372012.927251, "volume_percentage": 19.4346563602467, "last_updated": "2019-05-24T01:40:10.000Z" }, "USD": { "price": 7933.66233493434, "volume_24h": 374876133.234903, "depth_negative_two": 40654.68019906, "depth_positive_two": 17352.9964811, "last_updated": "2019-05-24T01:40:10.000Z" } } }, { "market_id": 36329, "market_pair": "MATIC/BTC", "category": "spot", "fee_type": "percentage", "outlier_detected": 0, "exclusions": null, "market_pair_base": { "currency_id": 3890, "currency_symbol": "MATIC", "exchange_symbol": "MATIC", "currency_type": "cryptocurrency" }, "market_pair_quote": { "currency_id": 1, "currency_symbol": "BTC", "exchange_symbol": "BTC", "currency_type": "cryptocurrency" }, "quote": { "exchange_reported": { "price": 0.0000034, "volume_24h_base": 8773968381.05, "volume_24h_quote": 29831.49249557, "volume_percentage": 19.4346563602467, "last_updated": "2019-05-24T01:41:16.000Z" }, "USD": { "price": 0.0269295015799739, "volume_24h": 236278595.380127, "depth_negative_two": 40654.68019906, "depth_positive_two": 17352.9964811, "last_updated": "2019-05-24T01:41:16.000Z" } } } ] }, "properties": { "id": { "type": "integer", "description": "The CoinMarketCap ID for this exchange.", "example": 1 }, "name": { "type": "string", "description": "The name of this exchange.", "example": "Binance" }, "slug": { "type": "string", "description": "The slug for this exchange.", "example": "binance" }, "num_market_pairs": { "type": "integer", "description": "The number of market pairs that are open for trading on this exchange.", "example": 303 }, "volume_24h": { "type": "number", "description": "Reported 24 hour volume in USD.", "example": 768478308.529847 }, "market_pairs": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Market_Pairs_array" } }, "required": ["id", "name", "slug", "num_market_pairs", "volume_24h", "market_pairs"] }, "Exchange_Market_Pairs_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Exchange_Market_Pairs_Latest_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Exchange_Historical_Quotes_-_Currency_Quote_object": { "type": "object", "description": "The market details for the current interval and currency conversion option. The map key being the curency symbol.", "properties": { "volume_24h": { "type": "number", "description": "Combined 24 hour volume for all market pairs on this exchange at the current historical interval.", "example": 1235000 }, "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2018-06-02T22:51:28.209Z" } }, "required": ["volume_24h", "timestamp"] }, "Exchange_Historical_Quotes_-_Quote_currency_map": { "type": "object", "description": "A map of market details for this quote in different currency conversions. The default map included is USD.", "additionalProperties": { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_Currency_Quote_object" } }, "Exchange_Historical_Quotes_-_nterval_Quote_object": { "type": "object", "description": "An object containing details for the current interval quote.", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this historical quote was recorded.", "example": "2018-06-02T00:00:00.000Z" }, "num_market_pairs": { "type": "number", "description": "Number of market pairs available at the current historical interval.", "example": 123456789 }, "quote": { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_Quote_currency_map" } }, "required": ["timestamp", "num_market_pairs", "quote"] }, "Exchange_Historical_Quotes_-_Interval_Quotes_array": { "type": "array", "description": "An array of quotes for each interval for this exchange.", "items": { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_nterval_Quote_object" }, "required": ["Exchange Historical Quotes - nterval Quote object"] }, "Exchange_Historical_Quotes_-_exchange_object": { "type": "object", "description": "An exchange object for each exchange requested. The map key being the id/slug used in the request.", "properties": { "id": { "type": "integer", "description": "The CoinMarketCap exchange ID.", "example": 1 }, "name": { "type": "string", "description": "The exchange name.", "example": "Binance" }, "slug": { "type": "string", "description": "The exchange slug.", "example": "binance" }, "quotes": { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_Interval_Quotes_array" } }, "required": ["id", "name", "slug", "quotes"] }, "Exchange_Historical_Quotes_-_Results_map": { "type": "object", "description": "Results of your query returned as an object map.", "example": { "1": { "id": 270, "name": "Binance", "slug": "binance", "quotes": [ { "timestamp": "2018-06-03T00:00:00.000Z", "quote": { "USD": { "volume_24h": 1632390000, "timestamp": "2018-06-03T00:00:00.000Z" } }, "num_market_pairs": 338 }, { "timestamp": "2018-06-10T00:00:00.000Z", "quote": { "USD": { "volume_24h": 1034720000, "timestamp": "2018-06-10T00:00:00.000Z" } }, "num_market_pairs": 349 }, { "timestamp": "2018-06-17T00:00:00.000Z", "quote": { "USD": { "volume_24h": 883885000, "timestamp": "2018-06-17T00:00:00.000Z" } }, "num_market_pairs": 357 } ] } }, "additionalProperties": { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_exchange_object" } }, "Exchange_Historical_Quotes_-_Response_Model": { "type": "object", "properties": { "data": { "description": "A single object when you request one exchange, and an object map keyed by exchange ID when you request several.", "oneOf": [ { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_Results_map" }, { "$ref": "#/components/schemas/Exchange_Historical_Quotes_-_exchange_object" } ] }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Exchange_Quotes_Latest_-_Quote_object": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2018-06-02T22:51:28.209Z" }, "volume_24h": { "type": "number", "description": "Reported 24 hour volume in the specified currency.", "example": 768478308.529847 }, "volume_24h_adjusted": { "type": "number", "description": "Adjusted 24 hour volume in the specified currency for spot markets excluding markets with no fees and transaction mining.", "example": 768478308.529847 }, "volume_7d": { "type": "number", "description": "7 day volume in the specified currency.", "example": 3666423776 }, "volume_30d": { "type": "number", "description": "30 day volume in the specified currency.", "example": 21338299776 }, "percent_change_volume_24h": { "type": "number", "description": "24 hour percent change in the specified currency.", "example": 0.03 }, "percent_change_volume_7d": { "type": "number", "description": "7 day percent change in the specified currency.", "example": 5.75 }, "percent_change_volume_30d": { "type": "number", "description": "30 day percent change in the specified currency.", "example": -19.64 }, "effective_liquidity_24h": { "type": "number", "description": "24 hour liquidity in the specified currency.", "example": -19.64 }, "derivative_volume": { "type": [ "number", "null" ], "description": "Reported 24 hour derivative volume in the specified currency.", "example": 768478308.529847 }, "spot_volume": { "type": "number", "description": "Reported 24 hour spot volume in the specified currency.", "example": 768478308.529847 }, "derivative_volume_usd": { "type": [ "number", "null" ], "description": "Aggregate 24h derivative trade volume in USD.", "example": 62828618628.85901 }, "spot_volume_usd": { "type": "number", "description": "Reported all time spot volume in the specified currency.", "example": 768478308.529847 }, "open_interest": { "type": [ "number", "null" ], "description": "Reported 24 hour derivative open interest in the specified currency.", "example": 768478308.529847 } }, "required": [ "last_updated", "volume_24h", "volume_24h_adjusted", "volume_7d", "volume_30d", "percent_change_volume_24h", "percent_change_volume_7d", "percent_change_volume_30d" ] }, "Exchange_Quotes_Latest_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "additionalProperties": { "$ref": "#/components/schemas/Exchange_Quotes_Latest_-_Quote_object" } }, "Exchange_Quotes_Latest_-_Exchange_object": { "type": "object", "description": "An exchange object for each requested.", "properties": { "id": { "type": "integer", "description": "The CoinMarketCap exchange ID.", "example": 1 }, "name": { "type": "string", "description": "The exchange name.", "example": "Binance" }, "slug": { "type": "string", "description": "The exchange slug.", "example": "binance" }, "num_market_pairs": { "type": "integer", "description": "The number of active trading pairs available for this exchange.", "example": 500 }, "exchange_score": { "type": [ "number", "null" ], "description": "The exchange score.", "example": 9.8 }, "liquidity_score": { "type": "number", "description": "The liquidity score.", "example": 9.8 }, "rank": { "type": "integer", "description": "The exchange rank.", "example": 5 }, "traffic_score": { "type": "number", "description": "The traffic score.", "example": 1000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this exchange's market data was updated.", "example": "2018-06-02T00:00:00.000Z" }, "quote": { "$ref": "#/components/schemas/Exchange_Quotes_Latest_-_Quote_map" }, "num_coins": { "type": "integer", "description": "Number of distinct coins traded on this exchange." } }, "required": ["id", "name", "slug", "num_market_pairs", "last_updated", "quote"] }, "Exchange_Quotes_Latest_-_Exchange_Results_map": { "type": "object", "description": "A map of exchange objects by ID or slugs (as used in query parameters).", "example": { "1": { "id": 270, "name": "Binance", "slug": "binance", "num_coins": 132, "num_market_pairs": 385, "last_updated": "2018-11-08T22:11:00.000Z", "traffic_score": 1000, "rank": 1, "exchange_score": 9.8, "liquidity_score": 9.8028, "quote": { "USD": { "volume_24h": 768478308.529847, "volume_24h_adjusted": 768478308.529847, "volume_7d": 3666423776, "volume_30d": 21338299776, "percent_change_volume_24h": -11.8232, "percent_change_volume_7d": 67.0306, "percent_change_volume_30d": -0.0821558, "effective_liquidity_24h": 629.9774, "last_updated": "2018-11-08T22:18:00.000Z" } } } }, "additionalProperties": { "$ref": "#/components/schemas/Exchange_Quotes_Latest_-_Exchange_object" } }, "Exchange_Quotes_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Exchange_Quotes_Latest_-_Exchange_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Global_Metrics_Quotes_Historic_-_Currency_Quote_object": { "type": "object", "description": "The market details for the current interval and currency conversion option. The map key being the curency symbol.", "properties": { "total_market_cap": { "type": "number", "description": "The sum of all individual cryptocurrency market capitalizations at the given point in time, historically converted into units of the requested currency.", "example": 375179000000 }, "total_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume (as outlined in our methodology) for all cryptocurrencies at the given point in time, historically converted into units of the requested currency.", "example": 19918400000 }, "total_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all cryptocurrencies at the given point in time, historically converted into units of the requested currency. *Note: This field is only available after 2019-05-10 and will return `null` prior to that time.*", "example": 19918400000 }, "altcoin_market_cap": { "type": "number", "description": "The sum of all individual cryptocurrency market capitalizations excluding Bitcoin at the given point in time, historically converted into units of the requested currency.", "example": 187589500000 }, "altcoin_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume (as outlined in our methodology) for all cryptocurrencies excluding Bitcoin at the given point in time, historically converted into units of the requested currency.", "example": 19918400000 }, "altcoin_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all cryptocurrencies excluding Bitcoin at the given point in time, historically converted into units of the requested currency. *Note: This field is only available after 2019-05-10 and will return `null` prior to that time.*", "example": 19918400000 }, "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced for this conversion.", "example": "2018-06-02T22:51:28.209Z" } }, "required": [ "total_market_cap", "total_volume_24h", "total_volume_24h_reported", "altcoin_market_cap", "altcoin_volume_24h", "altcoin_volume_24h_reported", "timestamp" ] }, "Global_Metrics_Quotes_Historic_-_Quote_currency_map": { "type": "object", "description": "An object containing market data for this interval by currency option. The default currency mapped is USD.", "additionalProperties": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Historic_-_Currency_Quote_object" } }, "Global_Metrics_Quotes_Historic_-_Interval_Quote_object": { "type": "object", "description": "An object containing details for the current interval quote.", "properties": { "timestamp": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when this historical quote was recorded.", "example": "2018-06-02T00:00:00.000Z" }, "search_interval": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "The interval timestamp for the search period that this historical quote was located against. *This field is only returned if requested through the `aux` request parameter.*", "example": "2018-06-02T00:00:00.000Z" }, "btc_dominance": { "type": "number", "description": "Percent of BTC market dominance by marketcap at this interval." }, "eth_dominance": { "type": "number", "description": "Percent of ETH market dominance by marketcap at this interval." }, "active_cryptocurrencies": { "type": "number", "description": "Number of active cryptocurrencies tracked by CoinMarketCap at the given point in time. This includes all cryptocurrencies with a `listing_status` of \"active\" or \"untracked\" as returned from our /cryptocurrency/map call. *Note: This field is only available after 2019-05-10 and will return `null` prior to that time.*", "example": 500 }, "active_exchanges": { "type": "number", "description": "Number of active exchanges tracked by CoinMarketCap at the given point in time. This includes all exchanges with a `listing_status` of \"active\" or \"untracked\" as returned by our /exchange/map call. *Note: This field is only available after 2019-06-18 and will return `null` prior to that time.*", "example": 200 }, "active_market_pairs": { "type": "number", "description": "Number of active market pairs tracked by CoinMarketCap across all exchanges at the given point in time. *Note: This field is only available after 2019-05-10 and will return `null` prior to that time.*", "example": 1000 }, "quote": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Historic_-_Quote_currency_map" } }, "required": [ "timestamp", "btc_dominance", "eth_dominance", "active_cryptocurrencies", "active_exchanges", "active_market_pairs", "quote" ] }, "Global_Metrics_Quotes_Historic_-_Interval_Quotes_array": { "type": "array", "description": "An array of aggregate market quotes for each interval.", "items": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Historic_-_Interval_Quote_object" }, "required": ["Global Metrics Quotes Historic - Interval Quote object"] }, "Global_Metrics_Quotes_Historic_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "quotes": [ { "timestamp": "2018-07-31T00:02:00.000Z", "eth_dominance": 16.099, "btc_dominance": 47.9949, "active_cryptocurrencies": 2500, "active_exchanges": 600, "active_market_pairs": 1000, "quote": { "USD": { "total_market_cap": 292863223827.394, "total_volume_24h": 17692152629.7864, "total_volume_24h_reported": 375179000000, "altcoin_market_cap": 187589500000, "altcoin_volume_24h": 375179000000, "altcoin_volume_24h_reported": 375179000000, "timestamp": "2018-07-31T00:02:00.000Z" } } }, { "timestamp": "2018-08-01T00:02:00.000Z", "eth_dominance": 16.099, "btc_dominance": 48.0585, "active_cryptocurrencies": 2500, "active_exchanges": 600, "active_market_pairs": 1000, "quote": { "USD": { "total_market_cap": 277770824530.303, "total_volume_24h": 15398085549.0344, "total_volume_24h_reported": 375179000000, "altcoin_market_cap": 187589500000, "altcoin_volume_24h": 375179000000, "altcoin_volume_24h_reported": 375179000000, "timestamp": "2018-07-31T00:02:00.000Z" } } }, { "timestamp": "2018-08-02T00:02:00.000Z", "eth_dominance": 16.099, "btc_dominance": 48.041, "active_cryptocurrencies": 2500, "active_exchanges": 600, "active_market_pairs": 1000, "quote": { "USD": { "total_market_cap": 273078776005.223, "total_volume_24h": 14300071695.0547, "total_volume_24h_reported": 375179000000, "altcoin_market_cap": 187589500000, "altcoin_volume_24h": 375179000000, "altcoin_volume_24h_reported": 375179000000, "timestamp": "2018-07-31T00:02:00.000Z" } } } ] }, "properties": { "quotes": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Historic_-_Interval_Quotes_array" } }, "required": ["quotes"] }, "Global_Metrics_Quotes_Historic_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Historic_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Global_Metrics_Quotes_Latest_-_Quote_object": { "type": "object", "description": "A market quote in the currency conversion option.", "properties": { "total_market_cap": { "type": "number", "description": "The sum of all individual cryptocurrency market capitalizations in the requested currency.", "example": 250385096532.124 }, "total_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume (as outlined in our methodology) for all cryptocurrencies in the requested currency.", "example": 119270642406.968 }, "total_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all cryptocurrencies in the requested currency.", "example": 1514905418.39087 }, "altcoin_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume (as outlined in our methodology) for all cryptocurrencies excluding Bitcoin in the requested currency.", "example": 119270642406.968 }, "altcoin_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all cryptocurrencies excluding Bitcoin in the requested currency.", "example": 1514905418.39087 }, "altcoin_market_cap": { "type": "number", "description": "The sum of all individual cryptocurrency market capitalizations excluding Bitcoin in the requested currency.", "example": 250385096532.124 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of when the conversion currency's current value was referenced.", "example": "2019-05-16T18:47:00.000Z" }, "defi_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume for all DeFi cryptocurrencies in the requested currency." }, "defi_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all DeFi cryptocurrencies in the requested currency." }, "defi_market_cap": { "type": "number", "description": "The sum of market caps for all DeFi cryptocurrencies in the requested currency." }, "defi_24h_percentage_change": { "type": "number", "description": "Percentage change in 24 hour DeFi volume compared with the previous 24 hours." }, "stablecoin_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume for all stablecoins in the requested currency." }, "stablecoin_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all stablecoins in the requested currency." }, "stablecoin_market_cap": { "type": "number", "description": "The sum of market caps for all stablecoins in the requested currency." }, "stablecoin_24h_percentage_change": { "type": "number", "description": "Percentage change in 24 hour stablecoin volume compared with the previous 24 hours." }, "derivatives_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume for all derivatives markets in the requested currency." }, "derivatives_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all derivatives markets in the requested currency." }, "derivatives_24h_percentage_change": { "type": "number", "description": "Percentage change in 24 hour derivatives volume compared with the previous 24 hours." }, "total_market_cap_yesterday": { "type": "number", "description": "Total cryptocurrency market cap as of yesterday, in the requested currency." }, "total_volume_24h_yesterday": { "type": "number", "description": "Total 24 hour volume as of yesterday, in the requested currency." }, "total_market_cap_yesterday_percentage_change": { "type": "number", "description": "Percentage change in total market cap compared with yesterday." }, "total_volume_24h_yesterday_percentage_change": { "type": "number", "description": "Percentage change in total 24 hour volume compared with yesterday." } }, "required": [ "total_market_cap", "total_volume_24h", "total_volume_24h_reported", "altcoin_volume_24h", "altcoin_volume_24h_reported", "altcoin_market_cap", "last_updated" ] }, "Global_Metrics_Quotes_Latest_-_Quote_map": { "type": "object", "description": "A map of market quotes in different currency conversions. The default map included is USD.", "example": { "USD": { "total_market_cap": 250284668020.67, "total_volume_24h": 16903498628.86, "total_volume_24h_reported": 16903498628.86, "altcoin_volume_24h": 11883384723.14, "altcoin_volume_24h_reported": 11883384723.14, "altcoin_market_cap": 119597549931.01, "last_updated": "2018-06-02T23:46:14.000Z" } }, "additionalProperties": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Latest_-_Quote_object" } }, "Global_Metrics_Quotes_Latest_-_Results_Object": { "type": "object", "description": "Results object for your API call.", "properties": { "btc_dominance": { "type": "number", "description": "Bitcoin's market dominance percentage by market cap.", "example": 67.0057 }, "eth_dominance": { "type": "number", "description": "Ethereum's market dominance percentage by market cap.", "example": 9.02205 }, "active_cryptocurrencies": { "type": "number", "description": "Count of active cryptocurrencies tracked by CoinMarketCap. This includes all cryptocurrencies with a `listing_status` of \"active\" or \"listed\" as returned from our /cryptocurrency/map call.", "example": 2941 }, "total_cryptocurrencies": { "type": "number", "description": "Count of all cryptocurrencies tracked by CoinMarketCap. This includes \"inactive\" `listing_status` cryptocurrencies.", "example": 4637 }, "active_market_pairs": { "type": "number", "description": "Count of active market pairs tracked by CoinMarketCap across all exchanges.", "example": 21209 }, "active_exchanges": { "type": "number", "description": "Count of active exchanges tracked by CoinMarketCap. This includes all exchanges with a `listing_status` of \"active\" or \"listed\" as returned by our /exchange/map call.", "example": 445 }, "total_exchanges": { "type": "number", "description": "Count of all exchanges tracked by CoinMarketCap. This includes \"inactive\" `listing_status` exchanges.", "example": 677 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp of when this record was last updated.", "example": "2019-05-16T18:47:00.000Z" }, "quote": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Latest_-_Quote_map" }, "eth_dominance_yesterday": { "type": "number", "description": "Ethereum's market dominance percentage by market cap as of yesterday." }, "btc_dominance_yesterday": { "type": "number", "description": "Bitcoin's market dominance percentage by market cap as of yesterday." }, "eth_dominance_24h_percentage_change": { "type": "number", "description": "Change in Ethereum's market dominance since yesterday, in percentage points." }, "btc_dominance_24h_percentage_change": { "type": "number", "description": "Change in Bitcoin's market dominance since yesterday, in percentage points." }, "defi_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume for all DeFi cryptocurrencies in USD." }, "defi_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all DeFi cryptocurrencies in USD." }, "defi_market_cap": { "type": "number", "description": "The sum of market caps for all DeFi cryptocurrencies in USD." }, "defi_24h_percentage_change": { "type": "number", "description": "Percentage change in 24 hour DeFi volume compared with the previous 24 hours." }, "stablecoin_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume for all stablecoins in USD." }, "stablecoin_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all stablecoins in USD." }, "stablecoin_market_cap": { "type": "number", "description": "The sum of market caps for all stablecoins in USD." }, "stablecoin_24h_percentage_change": { "type": "number", "description": "Percentage change in 24 hour stablecoin volume compared with the previous 24 hours." }, "derivatives_volume_24h": { "type": "number", "description": "The sum of rolling 24 hour adjusted volume for all derivatives markets in USD." }, "derivatives_volume_24h_reported": { "type": "number", "description": "The sum of rolling 24 hour reported volume for all derivatives markets in USD." }, "derivatives_24h_percentage_change": { "type": "number", "description": "Percentage change in 24 hour derivatives volume compared with the previous 24 hours." }, "total_crypto_dex_currencies": { "type": "integer", "description": "Total number of DEX tokens tracked by CoinMarketCap." }, "today_incremental_crypto_number": { "type": "integer", "description": "Number of new cryptocurrencies and DEX tokens tracked so far today (UTC)." }, "past_24h_incremental_crypto_number": { "type": "integer", "description": "Number of new cryptocurrencies and DEX tokens tracked in the past 24 hours." }, "past_7d_incremental_crypto_number": { "type": "integer", "description": "Number of new cryptocurrencies and DEX tokens tracked in the past 7 days." }, "past_30d_incremental_crypto_number": { "type": "integer", "description": "Number of new cryptocurrencies and DEX tokens tracked in the past 30 days." }, "tracked_yearly_number": { "type": "object", "description": "The highest and lowest number of new cryptocurrencies and DEX tokens tracked in a single day over the past year.", "properties": { "maxIncrementalNumber": { "type": "integer", "description": "Highest number of new assets tracked in a single day." }, "minIncrementalNumber": { "type": "integer", "description": "Lowest number of new assets tracked in a single day." }, "maxIncrementalDate": { "type": "string", "description": "Date (ISO 8601) of the day with the highest number.", "format": "date-time" }, "minIncrementalDate": { "type": "string", "description": "Date (ISO 8601) of the day with the lowest number.", "format": "date-time" } } } }, "required": [ "active_cryptocurrencies", "total_cryptocurrencies", "active_market_pairs", "active_exchanges", "total_exchanges", "last_updated", "quote" ] }, "Global_Metrics_Quotes_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Global_Metrics_Quotes_Latest_-_Results_Object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "FCAS_Listings_Latest_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for every cryptocurrency that matched list options.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "score": { "type": "integer", "description": "The cryptocurrency's current FCAS score out of 1000", "example": 1000, "minimum": 0, "maximum": 1000 }, "grade": { "type": "string", "description": "The cryptocurrency's current FCAS letter grade", "example": "A" }, "percent_change_24h": { "type": "number", "description": "24 hour % FCAS score change", "example": 0.03 }, "point_change_24h": { "type": "number", "description": "24 hour FCAS point change", "example": 5, "minimum": -1000, "maximum": 1000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's FCAS value was updated.", "example": "2018-06-02T23:59:59.999Z" } }, "required": ["id", "name", "symbol", "slug"] }, "FCAS_Listings_Latest_-_Results_array": { "type": "array", "description": "Array of cryptocurrency objects matching the list options.", "items": { "$ref": "#/components/schemas/FCAS_Listings_Latest_-_Cryptocurrency_object" }, "required": ["FCAS Listings Latest - Cryptocurrency object"] }, "FCAS_Listings_Latest_-_Response_Model": { "type": "object", "example": { "data": [ { "id": 1027, "name": "Ethereum", "symbol": "ETH", "slug": "ethereum", "score": 971, "grade": "S", "last_updated": "2021-05-05T00:00:00Z" }, { "id": 2010, "name": "Cardano", "symbol": "ADA", "slug": "cardano", "score": 961, "grade": "S", "last_updated": "2021-05-05T00:00:00Z" } ], "status": { "timestamp": "2018-06-02T22:51:28.209Z", "error_code": 0, "error_message": "", "elapsed": 10, "credit_count": 1 } }, "properties": { "data": { "$ref": "#/components/schemas/FCAS_Listings_Latest_-_Results_array" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "FCAS_Quote_Latest_-_Cryptocurrency_object": { "type": "object", "description": "A cryptocurrency object for each requested.", "properties": { "id": { "type": "integer", "description": "The unique CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The ticker symbol for this cryptocurrency.", "example": "BTC" }, "slug": { "type": "string", "description": "The web URL friendly shorthand version of this cryptocurrency name.", "example": "bitcoin" }, "score": { "type": "integer", "description": "The cryptocurrency's current FCAS score out of 1000", "example": 1000, "minimum": 0, "maximum": 1000 }, "grade": { "type": "string", "description": "The cryptocurrency's current FCAS letter grade", "example": "A" }, "percent_change_24h": { "type": "number", "description": "24 hour % FCAS score change", "example": 0.03 }, "point_change_24h": { "type": "number", "description": "24 hour FCAS point change", "example": 5, "minimum": -1000, "maximum": 1000 }, "last_updated": { "type": "string", "format": "yyyy-MM-dd'T'HH:mm:ss.SSSZ", "description": "Timestamp (ISO 8601) of the last time this cryptocurrency's FCAS value was updated.", "example": "2018-06-02T23:59:59.999Z" } }, "required": ["id", "name", "symbol", "slug"] }, "FCAS_Quote_Latest_-_Cryptocurrency_Results_map": { "type": "object", "description": "A map of cryptocurrency objects by ID or symbol (as used in query parameters).", "example": { "1": { "id": 1, "name": "Bitcoin", "symbol": "BTC", "slug": "bitcoin", "score": 894, "grade": "A", "percent_change_24h": 0.56, "point_change_24h": 5, "last_updated": "2019-08-08T00:00:00Z" } }, "additionalProperties": { "$ref": "#/components/schemas/FCAS_Quote_Latest_-_Cryptocurrency_object" } }, "FCAS_Quote_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FCAS_Quote_Latest_-_Cryptocurrency_Results_map" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Altcoin_Season_Index_Latest_-_Response_Object": { "type": "object", "description": "Altcoin Season Index latest snapshot.", "properties": { "altcoin_index": { "type": "integer", "format": "int32", "description": "Altcoin Season Index (0-100). Values above 75 indicate altcoin season; below 25 indicate Bitcoin season." }, "altcoin_marketcap": { "type": "number", "description": "Altcoin market capitalization (USD)." }, "snapshot_time": { "type": "string", "description": "Snapshot timestamp (ISO 8601)." }, "yearly_high": { "type": "integer", "format": "int32", "description": "Highest index value in the past year." }, "yearly_high_date": { "type": "string", "description": "Date of yearly high (ISO 8601 date)." }, "yearly_low": { "type": "integer", "format": "int32", "description": "Lowest index value in the past year." }, "yearly_low_date": { "type": "string", "description": "Date of yearly low (ISO 8601 date)." } }, "required": ["altcoin_index", "altcoin_marketcap", "snapshot_time"] }, "Altcoin_Season_Index_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Altcoin_Season_Index_Latest_-_Response_Object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Altcoin_Season_Index_Historical_-_Point_Object": { "type": "object", "description": "Single Altcoin Season Index sample in a historical series.", "properties": { "timestamp": { "type": "string", "description": "Sample time (ISO 8601)." }, "altcoin_index": { "type": "integer", "format": "int32", "description": "Altcoin Season Index value (0-100)." }, "altcoin_marketcap": { "type": "number", "description": "Altcoin market capitalization at sample time (USD)." } }, "required": ["timestamp", "altcoin_index"] }, "Altcoin_Season_Index_Historical_-_Response_Object": { "type": "object", "description": "Altcoin Season Index historical series for a timeframe.", "properties": { "timeframe": { "type": "string", "description": "Requested timeframe (7d, 30d, or 90d)." }, "points": { "type": "array", "description": "Historical points sorted by timestamp (oldest first).", "items": { "$ref": "#/components/schemas/Altcoin_Season_Index_Historical_-_Point_Object" } } }, "required": ["timeframe", "points"] }, "Altcoin_Season_Index_Historical_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Altcoin_Season_Index_Historical_-_Response_Object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Simple_Price_-_Item_Object": { "type": "object", "description": "Simple spot price entry for a single cryptocurrency.", "properties": { "id": { "type": "integer", "format": "int32", "description": "CoinMarketCap cryptocurrency ID.", "example": 1 }, "price": { "type": "number", "description": "Spot price in USD.", "example": 65432.12 }, "market_cap": { "type": "number", "description": "Market cap in USD. Returned only when include_market_cap=true.", "example": 1284000000000 }, "volume_24h": { "type": "number", "description": "24-hour trading volume in USD. Returned only when include_volume_24h=true.", "example": 32500000000 }, "percent_change_24h": { "type": "number", "description": "24-hour price change percentage. Returned only when include_percent_change_24h=true.", "example": 1.23 }, "last_updated": { "type": "string", "description": "Last update time (ISO 8601 UTC). Returned only when include_last_updated=true.", "example": "2024-09-30T12:00:00.000Z" } }, "required": ["id", "price"] }, "Simple_Price_-_Response_Model": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Simple_Price_-_Item_Object" } }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Derivatives_Market_Pairs_List_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Derivatives_Market_Pairs_List_Latest_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Derivatives_Market_Pairs_List_Latest_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "exchange_id": 270, "exchange_name": "Binance", "exchange_slug": "binance", "num_market_pairs": 2045, "volume_24h": 69306677552.93349, "market_pairs": [ { "market_id": 47150, "market_pair_symbol": "BTC/USDT", "category": "perpetual", "fee_type": "percentage", "outlier_detected": false, "exclusions": null, "market_pair_base": { "exchange_symbol": "BTC", "symbol": "BTC", "crypto_id": 1, "currency_type": "cryptocurrency" }, "market_pair_quote": { "exchange_symbol": "USDT", "symbol": "USDT", "crypto_id": 825, "currency_type": "cryptocurrency" }, "exchange_reported_quotes": [ { "convert_id": 2781, "convert_symbol": "USD", "price": 80521.2, "volume_24h_base": 184589.83976729, "volume_24h_quote": 14863395405.87, "open_interest": 5000000, "index_price": 80498.5, "index_basis": 0.0023, "funding_rate": 0.0001, "last_updated": "2026-05-15T06:54:18.743Z", "volume_percentage": 21.441131937316662 } ], "quotes": [ { "convert_id": 2781, "convert_symbol": "USD", "price": 80504.01770192, "volume_24h": 14860136175.4951, "open_interest": 5000000, "last_updated": "2026-05-15T06:54:18.743Z" } ] } ] }, "properties": { "exchange_id": { "type": "integer", "description": "The CoinMarketCap ID for this exchange.", "example": 270 }, "exchange_name": { "type": "string", "description": "The name of this exchange.", "example": "Binance" }, "exchange_slug": { "type": "string", "description": "The slug for this exchange.", "example": "binance" }, "num_market_pairs": { "type": "integer", "description": "Number of derivative market pairs CoinMarketCap tracks for this exchange.", "example": 2045 }, "volume_24h": { "type": "number", "description": "Reported 24h trade volume across all derivative market pairs for this exchange in USD.", "example": 69306677552.93349 }, "market_pairs": { "type": "array", "description": "Array of derivative market pairs for this exchange.", "items": { "type": "object", "properties": { "market_id": { "type": "integer", "description": "The CoinMarketCap ID for this market pair.", "example": 47150 }, "market_pair_symbol": { "type": "string", "description": "Symbol pair identifier as listed on the exchange.", "example": "BTC/USDT" }, "category": { "type": "string", "description": "Derivative category.", "enum": ["perpetual", "futures"], "example": "perpetual" }, "fee_type": { "type": "string", "description": "Fee type the exchange enforces for this market.", "enum": ["percentage", "no-fees", "transactional-mining", "unknown"], "example": "percentage" }, "outlier_detected": { "type": "boolean", "description": "Whether this market pair has been flagged as an outlier.", "example": false }, "exclusions": { "type": ["array", "null"], "description": "Reasons this market pair is excluded from aggregate calculations, if any.", "items": { "type": "string" } }, "market_pair_base": { "type": "object", "description": "Base currency of the market pair.", "properties": { "exchange_symbol": { "type": "string", "description": "Symbol as listed on the exchange.", "example": "BTC" }, "symbol": { "type": "string", "description": "CoinMarketCap canonical symbol.", "example": "BTC" }, "crypto_id": { "type": "integer", "description": "CoinMarketCap ID for the base currency.", "example": 1 }, "currency_type": { "type": "string", "description": "Currency type.", "enum": ["cryptocurrency", "fiat"], "example": "cryptocurrency" } } }, "market_pair_quote": { "type": "object", "description": "Quote currency of the market pair.", "properties": { "exchange_symbol": { "type": "string", "description": "Symbol as listed on the exchange.", "example": "USDT" }, "symbol": { "type": "string", "description": "CoinMarketCap canonical symbol.", "example": "USDT" }, "crypto_id": { "type": "integer", "description": "CoinMarketCap ID for the quote currency.", "example": 825 }, "currency_type": { "type": "string", "description": "Currency type.", "enum": ["cryptocurrency", "fiat"], "example": "cryptocurrency" } } }, "exchange_reported_quotes": { "type": "array", "description": "Quotes as reported directly by the exchange, one entry per requested conversion currency.", "items": { "type": "object", "properties": { "convert_id": { "type": "integer", "description": "CoinMarketCap ID of the conversion currency.", "example": 2781 }, "convert_symbol": { "type": "string", "description": "Symbol of the conversion currency.", "example": "USD" }, "price": { "type": "number", "description": "Last reported price in the conversion currency.", "example": 80521.2 }, "volume_24h_base": { "type": "number", "description": "24h trade volume denominated in the base currency.", "example": 184589.83976729 }, "volume_24h_quote": { "type": "number", "description": "24h trade volume denominated in the conversion currency.", "example": 14863395405.87 }, "open_interest": { "type": "number", "description": "Open interest in the conversion currency.", "example": 5000000 }, "index_price": { "type": "number", "description": "Index price the exchange uses for this contract.", "example": 80498.5 }, "index_basis": { "type": "number", "description": "Spread between the contract price and the index price (basis).", "example": 0.0023 }, "funding_rate": { "type": "number", "description": "Current funding rate (perpetuals only).", "example": 0.0001 }, "last_updated": { "type": "string", "format": "date-time", "description": "Timestamp (RFC 3339 UTC) of the last update from the exchange.", "example": "2026-05-15T06:54:18.743Z" }, "volume_percentage": { "type": [ "number", "null" ], "description": "Share of this market pair in the exchange's total 24h derivative volume.", "example": 21.441131937316662 } } } }, "quotes": { "type": "array", "description": "CoinMarketCap-normalized quotes, one entry per requested conversion currency.", "items": { "type": "object", "properties": { "convert_id": { "type": "integer", "description": "CoinMarketCap ID of the conversion currency.", "example": 2781 }, "convert_symbol": { "type": "string", "description": "Symbol of the conversion currency.", "example": "USD" }, "price": { "type": "number", "description": "Normalized last price in the conversion currency.", "example": 80504.01770192 }, "volume_24h": { "type": "number", "description": "Normalized 24h trade volume in the conversion currency.", "example": 14860136175.4951 }, "open_interest": { "type": "number", "description": "Normalized open interest in the conversion currency.", "example": 5000000 }, "last_updated": { "type": "string", "format": "date-time", "description": "Timestamp (RFC 3339 UTC) of the last update.", "example": "2026-05-15T06:54:18.743Z" } } } } } } } } }, "Derivatives_Crypto_Market_Pairs_List_Latest_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Derivatives_Crypto_Market_Pairs_List_Latest_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Derivatives_Crypto_Market_Pairs_List_Latest_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "crypto_id": 1, "crypto_name": "Bitcoin", "symbol": "BTC", "num_market_pairs": 5, "market_pairs": [ { "market_id": 79477, "market_pair_symbol": "BTC/USDT", "category": "perpetual", "fee_type": "percentage", "outlier_detected": false, "exclusions": null, "exchange": { "exchange_id": 270, "exchange_name": "Binance", "exchange_slug": "binance" }, "market_pair_base": { "crypto_id": 1, "symbol": "BTC", "exchange_symbol": "BTC", "currency_type": "cryptocurrency" }, "market_pair_quote": { "crypto_id": 825, "symbol": "USDT", "exchange_symbol": "USDT", "currency_type": "cryptocurrency" }, "exchange_reported_quotes": [ { "convert_id": 2781, "convert_symbol": "USD", "price": 80496.6, "volume_24h_base": 686357.90331837, "volume_24h_quote": 55249477600.25728, "open_interest": 5000000, "index_price": 80498.5, "index_basis": 0.0023, "funding_rate": 0.0001, "last_updated": "2026-05-15T06:36:15.586Z" } ], "quotes": [ { "convert_id": 2781, "convert_symbol": "USD", "price": 80470.69372308, "volume_24h": 55231696622.35106, "open_interest": 5000000, "last_updated": "2026-05-15T06:36:15.586Z" } ] } ] }, "properties": { "crypto_id": { "type": "integer", "description": "The CoinMarketCap ID for this cryptocurrency.", "example": 1 }, "crypto_name": { "type": "string", "description": "The name of this cryptocurrency.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "The symbol of this cryptocurrency.", "example": "BTC" }, "num_market_pairs": { "type": "integer", "description": "Number of derivative market pairs CoinMarketCap tracks for this cryptocurrency across all exchanges.", "example": 5 }, "market_pairs": { "type": "array", "description": "Array of derivative market pairs for this cryptocurrency, across exchanges.", "items": { "type": "object", "properties": { "market_id": { "type": "integer", "description": "The CoinMarketCap ID for this market pair.", "example": 79477 }, "market_pair_symbol": { "type": "string", "description": "Symbol pair identifier as listed on the exchange.", "example": "BTC/USDT" }, "category": { "type": "string", "description": "Derivative category.", "enum": ["perpetual", "futures"], "example": "perpetual" }, "fee_type": { "type": "string", "description": "Fee type the exchange enforces for this market.", "enum": ["percentage", "no-fees", "transactional-mining", "unknown"], "example": "percentage" }, "outlier_detected": { "type": "boolean", "description": "Whether this market pair has been flagged as an outlier.", "example": false }, "exclusions": { "type": ["array", "null"], "description": "Reasons this market pair is excluded from aggregate calculations, if any.", "items": { "type": "string" } }, "exchange": { "type": "object", "description": "Exchange this market pair is listed on.", "properties": { "exchange_id": { "type": "integer", "description": "CoinMarketCap ID for the exchange.", "example": 270 }, "exchange_name": { "type": "string", "description": "Exchange name.", "example": "Binance" }, "exchange_slug": { "type": "string", "description": "Exchange slug.", "example": "binance" } } }, "market_pair_base": { "type": "object", "description": "Base currency of the market pair.", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID for the base currency.", "example": 1 }, "symbol": { "type": "string", "description": "CoinMarketCap canonical symbol.", "example": "BTC" }, "exchange_symbol": { "type": "string", "description": "Symbol as listed on the exchange.", "example": "BTC" }, "currency_type": { "type": "string", "description": "Currency type.", "enum": ["cryptocurrency", "fiat"], "example": "cryptocurrency" } } }, "market_pair_quote": { "type": "object", "description": "Quote currency of the market pair.", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap ID for the quote currency.", "example": 825 }, "symbol": { "type": "string", "description": "CoinMarketCap canonical symbol.", "example": "USDT" }, "exchange_symbol": { "type": "string", "description": "Symbol as listed on the exchange.", "example": "USDT" }, "currency_type": { "type": "string", "description": "Currency type.", "enum": ["cryptocurrency", "fiat"], "example": "cryptocurrency" } } }, "exchange_reported_quotes": { "type": "array", "description": "Quotes as reported directly by the exchange, one entry per requested conversion currency.", "items": { "type": "object", "properties": { "convert_id": { "type": "integer", "description": "CoinMarketCap ID of the conversion currency.", "example": 2781 }, "convert_symbol": { "type": "string", "description": "Symbol of the conversion currency.", "example": "USD" }, "price": { "type": "number", "description": "Last reported price in the conversion currency.", "example": 80496.6 }, "volume_24h_base": { "type": "number", "description": "24h trade volume denominated in the base currency.", "example": 686357.90331837 }, "volume_24h_quote": { "type": "number", "description": "24h trade volume denominated in the conversion currency.", "example": 55249477600.25728 }, "open_interest": { "type": "number", "description": "Open interest in the conversion currency.", "example": 5000000 }, "index_price": { "type": "number", "description": "Index price the exchange uses for this contract.", "example": 80498.5 }, "index_basis": { "type": "number", "description": "Spread between the contract price and the index price (basis).", "example": 0.0023 }, "funding_rate": { "type": "number", "description": "Current funding rate (perpetuals only).", "example": 0.0001 }, "last_updated": { "type": "string", "format": "date-time", "description": "Timestamp (RFC 3339 UTC) of the last update from the exchange.", "example": "2026-05-15T06:36:15.586Z" } } } }, "quotes": { "type": "array", "description": "CoinMarketCap-normalized quotes, one entry per requested conversion currency.", "items": { "type": "object", "properties": { "convert_id": { "type": "integer", "description": "CoinMarketCap ID of the conversion currency.", "example": 2781 }, "convert_symbol": { "type": "string", "description": "Symbol of the conversion currency.", "example": "USD" }, "price": { "type": "number", "description": "Normalized last price in the conversion currency.", "example": 80470.69372308 }, "volume_24h": { "type": "number", "description": "Normalized 24h trade volume in the conversion currency.", "example": 55231696622.35106 }, "open_interest": { "type": "number", "description": "Normalized open interest in the conversion currency.", "example": 5000000 }, "last_updated": { "type": "string", "format": "date-time", "description": "Timestamp (RFC 3339 UTC) of the last update.", "example": "2026-05-15T06:36:15.586Z" } } } } } } } } }, "Derivatives_Exchanges_List_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Derivatives_Exchanges_List_-_Results_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data"] }, "Derivatives_Exchanges_List_-_Results_object": { "type": "object", "description": "Results of your query returned as an object.", "example": { "exchanges": [ { "exchange_id": 270, "exchange_name": "Binance", "exchange_slug": "binance", "num_market_pairs": 645, "fiats": [], "traffic_score": 1000, "rank": 1, "exchange_score": 7.82345678, "liquidity_score": 9.8028, "last_updated": "2026-04-21T10:30:00.000Z", "quotes": [ { "convert_id": 2781, "convert_symbol": "USD", "open_interest": 23306624960.78, "open_interest_usd": 23306624960.78, "derivative_volume": 62828618628.85901, "derivative_volume_usd": 62828618628.85901, "maker_fees": 0.04, "taker_fees": 0.04, "last_updated": "2026-04-21T10:30:00.000Z" } ] } ] }, "properties": { "exchanges": { "type": "array", "description": "Array of derivatives exchanges, sorted per the `sort` and `sort_dir` parameters.", "items": { "type": "object", "properties": { "exchange_id": { "type": "integer", "description": "The CoinMarketCap ID for this exchange.", "example": 270 }, "exchange_name": { "type": "string", "description": "The name of this exchange.", "example": "Binance" }, "exchange_slug": { "type": "string", "description": "The slug for this exchange.", "example": "binance" }, "num_market_pairs": { "type": "integer", "description": "Number of active derivative market pairs CoinMarketCap tracks for this exchange.", "example": 645 }, "fiats": { "type": "array", "description": "Fiat currencies accepted by this exchange.", "items": { "type": "string" }, "example": [] }, "traffic_score": { "type": "number", "description": "CoinMarketCap's traffic score for this exchange.", "example": 1000 }, "rank": { "type": "integer", "description": "CoinMarketCap derivative-volume rank for this exchange (lower is higher).", "example": 1 }, "exchange_score": { "type": "number", "description": "CoinMarketCap's overall exchange score.", "example": 7.82345678 }, "liquidity_score": { "type": "number", "description": "CoinMarketCap's liquidity score for this exchange's derivatives markets.", "example": 9.8028 }, "last_updated": { "type": "string", "format": "date-time", "description": "Timestamp (RFC 3339 UTC) of the last update for this exchange's aggregate stats.", "example": "2026-04-21T10:30:00.000Z" }, "quotes": { "type": "array", "description": "Per-conversion-currency aggregate quotes, one entry per requested `convert` / `convert_id`.", "items": { "type": "object", "properties": { "convert_id": { "type": "integer", "description": "CoinMarketCap ID of the conversion currency.", "example": 2781 }, "convert_symbol": { "type": "string", "description": "Symbol of the conversion currency.", "example": "USD" }, "open_interest": { "type": "number", "description": "Aggregate open interest across this exchange's derivative markets, in the conversion currency.", "example": 23306624960.78 }, "open_interest_usd": { "type": "number", "description": "Aggregate open interest in USD.", "example": 23306624960.78 }, "derivative_volume": { "type": "number", "description": "Aggregate 24h derivative trade volume in the conversion currency.", "example": 62828618628.85901 }, "derivative_volume_usd": { "type": "number", "description": "Aggregate 24h derivative trade volume in USD.", "example": 62828618628.85901 }, "maker_fees": { "type": "number", "description": "Maker fee charged by this exchange (percentage).", "example": 0.04 }, "taker_fees": { "type": "number", "description": "Taker fee charged by this exchange (percentage).", "example": 0.04 }, "last_updated": { "type": "string", "format": "date-time", "description": "Timestamp (RFC 3339 UTC) of the last update for this quote.", "example": "2026-04-21T10:30:00.000Z" } } } } } } } } }, "Cryptocurrency_Multiplier_-_Item_object": { "type": "object", "description": "Current ERC-8056 UI multiplier details for a single cryptocurrency.", "properties": { "crypto_id": { "type": "integer", "description": "CoinMarketCap cryptocurrency ID.", "example": 1 }, "crypto_slug": { "type": "string", "description": "CoinMarketCap cryptocurrency slug.", "example": "bitcoin" }, "name": { "type": "string", "description": "Cryptocurrency name.", "example": "Bitcoin" }, "symbol": { "type": "string", "description": "Cryptocurrency symbol.", "example": "BTC" }, "multiplier": { "type": "number", "description": "Current effective UI multiplier.", "example": 1 }, "effective_at": { "type": "string", "description": "Timestamp (ISO 8601) of when the current multiplier became effective.", "example": "2026-05-10T10:30:00Z" }, "token_address": { "type": "string", "description": "On-chain contract address from multiplier history. Omitted when the extra multiplier does not match the latest scheduled change, the scheduled change is not yet effective, or the value was changed administratively.", "example": "0x2260fac5e5542a773aa44fbcfedf7c193bc2c599" }, "platform_id": { "type": "integer", "description": "CoinMarketCap platform ID paired with `token_address`. Omitted under the same conditions as `token_address`.", "example": 14 } }, "required": ["crypto_id", "crypto_slug", "name", "symbol", "multiplier", "effective_at"] }, "Cryptocurrency_Multiplier_-_Items_array": { "type": "array", "description": "Multiplier records for the current page.", "items": { "$ref": "#/components/schemas/Cryptocurrency_Multiplier_-_Item_object" } }, "Cryptocurrency_Multiplier_-_Data_object": { "type": "object", "description": "Paginated multiplier results.", "properties": { "total_size": { "type": "integer", "description": "Total number of results before pagination.", "example": 21 }, "has_more": { "type": "boolean", "description": "Whether additional candidate IDs remain after the current `start` and `limit` window.", "example": true }, "items": { "$ref": "#/components/schemas/Cryptocurrency_Multiplier_-_Items_array" } }, "required": ["total_size", "has_more", "items"] }, "Cryptocurrency_Multiplier_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Cryptocurrency_Multiplier_-_Data_object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data", "status"] }, "Dex_Multiplier_-_Item_Object": { "type": "object", "description": "ERC-8056 multiplier information for a single token.", "properties": { "platform_id": { "type": "integer", "description": "Platform ID.", "example": 14 }, "platform": { "type": "string", "description": "Platform name.", "example": "bsc" }, "token_address": { "type": "string", "description": "Token address.", "example": "0x1234567890abcdef1234567890abcdef12345678" }, "name": { "type": "string", "description": "Token name.", "example": "Dogecoin" }, "symbol": { "type": "string", "description": "Token symbol.", "example": "DOGE" }, "multiplier": { "type": "number", "description": "ERC-8056 multiplier value.", "example": 0.01 }, "effective_at": { "type": "string", "description": "Timestamp (ISO 8601) of when the current multiplier became effective.", "example": "2026-05-19T10:30:00Z" } }, "required": [ "platform_id", "platform", "token_address", "name", "symbol", "multiplier", "effective_at" ] }, "Dex_Multiplier_-_Data_Object": { "type": "object", "description": "Paginated ERC-8056 multiplier results.", "properties": { "total_size": { "type": "integer", "description": "Total number of results before pagination.", "example": 2 }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Dex_Multiplier_-_Item_Object" } }, "has_more": { "type": "boolean", "description": "Whether more results exist beyond the current page.", "example": false } }, "required": ["total_size", "items", "has_more"] }, "Dex_Multiplier_-_Response_Model": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Dex_Multiplier_-_Data_Object" }, "status": { "$ref": "#/components/schemas/API_Status_Object" } }, "required": ["data", "status"] }, "Dex_Multiplier_-_Validation_Status_Object": { "type": "object", "description": "Validation error status object for DEX multiplier.", "properties": { "error_code": { "type": "integer", "description": "Application error code.", "example": 4001 }, "category": { "type": "string", "description": "Error category.", "example": "VALIDATION" }, "error_message": { "type": "string", "description": "Error message.", "example": "Invalid parameter." }, "error_detail": { "type": "string", "description": "Detailed error information.", "example": "start should be an integer >= 1." } }, "required": ["error_code", "category", "error_message", "error_detail"] }, "Dex_Multiplier_-_Validation_Error_Object": { "type": "object", "description": "Bad Request (validation error).", "properties": { "status": { "$ref": "#/components/schemas/Dex_Multiplier_-_Validation_Status_Object" } }, "required": ["status"] } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-CMC_PRO_API_KEY", "description": "Your CoinMarketCap Pro API key. Get one at https://pro.coinmarketcap.com/signup" } } }, "security": [ { "ApiKeyAuth": [] } ], "x-tagGroups": [ { "name": "Pro API", "tags": [ "Cryptocurrency", "Exchange", "Real World Assets", "Derivatives", "CMC AI", "Global Metrics", "Content", "Community", "CMC Index", "Crypto Others" ] }, { "name": "Dex API", "tags": ["Token", "Platform", "Holder", "OHLCV", "Others"] }, { "name": "Tools", "tags": ["Tools"] }, { "name": "Deprecated", "tags": ["Deprecated"] } ] }