{ "openapi": "3.0.1", "info": { "title": "Crypto Price API - CoinDesk Data OHLCV, CADLI Index and News", "description": "Crypto price API for CoinDesk Data (CryptoCompare): live spot ticks and OHLCV candles by day, hour or minute for 180 exchanges, CADLI and other CoinDesk index values, asset metadata and market cap top list, and crypto news with sentiment. Bring your own API key.", "version": "0.1", "x-build-id": "ajFYqlDCoyIdwyBwt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~crypto-price-index-news-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-crypto-price-index-news-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~crypto-price-index-news-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-crypto-price-index-news-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~crypto-price-index-news-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-crypto-price-index-news-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "What to read", "enum": [ "spotLatestTick", "spotHistory", "indexLatestTick", "indexHistory", "assetMetadata", "assetTopList", "newsArticles", "newsSources" ], "type": "string", "description": "Every mode needs your own CoinDesk Data API key (the free key works for the routes its plan covers). Spot latest tick and OHLCV candles read exchange markets; index modes read CoinDesk index families such as CADLI; asset modes read metadata and the top list; news modes read articles and sources.", "default": "spotLatestTick" }, "market": { "title": "Exchange", "enum": [ "aax", "abcc", "acx", "aidosmarket", "alphaex", "archax", "ascendex", "ataix", "backpack", "bequant", "bgogo", "bibox365", "bigone", "bilaxy", "binance", "binanceaggregate", "binanceusa", "bingx", "bisq", "bit", "bit2c", "bit2me", "bitbank", "bitbay", "bitbns", "bitbuy", "bitci", "bitexbook", "bitfex", "bitfinex", "bitflyer", "bitflyereu", "bitflyerfx", "bitflyerus", "bitforex", "bitget", "bithumbglobal", "bithumbkorea", "bitinka", "bitkub", "bitmart", "bitmex", "bitopro", "bitpanda", "bitrue", "bitso", "bitstamp", "bittrex", "bitunix", "bitvavo", "bkex", "blackturtle", "bleutrade", "blockchaincom", "btcalpha", "btcbox", "btcex", "btcmarkets", "btcturk", "btse", "buda", "bullish", "buyucoin", "bwexchange", "bybit", "bydfi", "catex", "cexio", "coinbase", "coinbaseinternational", "coincheck", "coincorner", "coindcx", "coindeal", "coinex", "coinfalcon", "coinfield", "coinjar", "coinmate", "coinone", "coinsbit", "coinspro", "cointiger", "coinw", "coss", "crex24", "crosstower", "cryptocarbon", "cryptodotcom", "cryptology", "cryptopia", "cryptsy", "cube", "currency", "dcoin", "ddex", "decoin", "deribit", "digifinex", "edxmarkets", "erisx", "etoro", "exmo", "fastex", "fcoin", "figuremarkets", "flipster", "foxbit", "ftx", "ftxus", "garantex", "gateio", "gemini", "globitex", "gopax", "graviex", "hashkey", "hitbtc", "huobijapan", "huobipro", "hyperliquid", "independentreserve", "indodax", "indoex", "inx", "itbit", "korbit", "kraken", "kucoin", "kuna", "latoken", "lbank", "liqnet", "liquid", "litebit", "lmax", "luno", "lykke", "mercadobtc", "mercatox", "mexc", "mock", "mtgox", "ndax", "nominex", "okcoin", "okex", "onetrading", "osl", "oslhongkong", "p2pb2b", "pancakeswap", "paramountdax", "paribu", "phemex", "poloniex", "probit", "safetrade", "sigenpro", "therocktrading", "tidefi", "timex", "tokenomy", "toobit", "tradeogre", "uniswap", "unocoin", "upbit", "valr", "vitex", "wazirx", "whitebit", "woo", "xcoex", "xtpub", "yellow", "yobit", "zaif", "zbdotcom", "zbg", "zebitex", "zonda" ], "type": "string", "description": "Spot modes. The exchange to read, such as coinbase, binance, kraken or bitstamp.", "default": "coinbase" }, "indexMarket": { "title": "Index family", "enum": [ "cadli", "cchkex", "cchkex_eod", "ccix", "cber", "cbr", "cbrsett", "cbersett", "ccixdev", "ccmvda_coint", "ccmvda_virt", "ccxrp", "cd_mc", "cdi_b", "cdi_mda", "cdi_ti", "cdisett", "cdmcdev", "cdor", "nasdaq_single", "rr_spot", "rr_vwap", "sda", "sgx_rr", "sgxrt", "sgxtwap" ], "type": "string", "description": "Index modes. The CoinDesk index family. cadli is the 24-hour volume-weighted average with time penalty and outlier adjustment; some families need a key with that family's entitlement.", "default": "cadli" }, "instruments": { "title": "Instruments", "type": "array", "description": "Spot and index modes. Instruments, one per line, case sensitive: BTC-USD, ETH-USD, SOL-USDT on an exchange (the exchange's own code such as XXBTZUSD on kraken works too), or BTC-USD, ETH-USD on cadli. Latest tick reads up to 50 a call; candles read one instrument at a time.", "default": [ "BTC-USD", "ETH-USD" ], "items": { "type": "string" } }, "timeframe": { "title": "Candle timeframe", "enum": [ "days", "hours", "minutes" ], "type": "string", "description": "Candle modes. Days (up to 5,000 a call), hours or minutes (up to 2,000 a call). The run pages further back on its own.", "default": "days" }, "aggregate": { "title": "Aggregate", "minimum": 1, "maximum": 30, "type": "integer", "description": "Candle modes. Points merged into each candle, 1 to 30: 5 on minutes gives 5-minute candles, 7 on days weekly candles.", "default": 1 }, "fill": { "title": "Fill empty periods", "type": "boolean", "description": "Candle modes. On (the provider default) returns a candle for periods with no trading; off leaves them out.", "default": true }, "startTime": { "title": "Start time", "type": "string", "description": "Candle and news modes. Oldest point to return, as YYYY-MM-DD, a UTC time such as 2026-01-31T12:00:00Z, or Unix seconds. Left empty, the run reads back until the maximum results cap." }, "endTime": { "title": "End time", "type": "string", "description": "Candle and news modes. Newest point to return (the documented to_ts), same formats. Left empty, the run starts from now." }, "assets": { "title": "Assets", "type": "array", "description": "Asset metadata. Asset symbols, CoinDesk asset IDs or URIs, one per line: BTC, ETH, SOL, USDC. Up to 50 a call.", "default": [ "BTC", "ETH" ], "items": { "type": "string" } }, "assetLookupPriority": { "title": "Match assets by", "enum": [ "SYMBOL", "ID", "URI" ], "type": "string", "description": "Asset metadata. Whether each asset entry is matched first as a symbol, a CoinDesk asset ID or a URI.", "default": "SYMBOL" }, "quoteAsset": { "title": "Quote asset", "type": "string", "description": "Asset metadata and top list. The asset prices and market caps are converted into, such as USD (default), EUR or BTC.", "default": "USD" }, "assetLanguage": { "title": "Description language", "enum": [ "en-US", "de-DE", "es-ES", "fr-FR", "pt-BR", "it-IT", "ja-JP", "ko-KR", "zh-CN", "vi-VN", "sv-SE", "tr-TR", "tl-PH", "ru-RU", "uk-UA", "ro-RO", "nl-NL", "sq-AL" ], "type": "string", "description": "Asset metadata. Language for asset descriptions and other translated fields.", "default": "en-US" }, "sortBy": { "title": "Sort top list by", "enum": [ "CREATED_ON", "LAUNCH_DATE", "UPDATED_ON", "PRICE_USD", "CIRCULATING_MKT_CAP_USD", "TOTAL_MKT_CAP_USD", "SPOT_MOVING_24_HOUR_QUOTE_VOLUME_TOP_TIER_DIRECT_USD", "SPOT_MOVING_24_HOUR_QUOTE_VOLUME_DIRECT_USD", "SPOT_MOVING_24_HOUR_QUOTE_VOLUME_TOP_TIER_USD", "SPOT_MOVING_24_HOUR_QUOTE_VOLUME_USD", "SPOT_MOVING_24_HOUR_CHANGE_USD", "SPOT_MOVING_24_HOUR_CHANGE_PERCENTAGE_USD", "SPOT_MOVING_7_DAY_QUOTE_VOLUME_TOP_TIER_DIRECT_USD", "SPOT_MOVING_7_DAY_QUOTE_VOLUME_DIRECT_USD", "SPOT_MOVING_7_DAY_QUOTE_VOLUME_TOP_TIER_USD", "SPOT_MOVING_7_DAY_QUOTE_VOLUME_USD", "SPOT_MOVING_7_DAY_CHANGE_USD", "SPOT_MOVING_7_DAY_CHANGE_PERCENTAGE_USD", "SPOT_MOVING_30_DAY_QUOTE_VOLUME_TOP_TIER_DIRECT_USD", "SPOT_MOVING_30_DAY_QUOTE_VOLUME_DIRECT_USD", "SPOT_MOVING_30_DAY_QUOTE_VOLUME_TOP_TIER_USD", "SPOT_MOVING_30_DAY_QUOTE_VOLUME_USD", "SPOT_MOVING_30_DAY_CHANGE_USD", "SPOT_MOVING_30_DAY_CHANGE_PERCENTAGE_USD", "TOTAL_ENDPOINTS_WITH_ISSUES" ], "type": "string", "description": "Asset top list. The ranking field.", "default": "CIRCULATING_MKT_CAP_USD" }, "sortDirection": { "title": "Sort direction", "enum": [ "DESC", "ASC" ], "type": "string", "description": "Asset top list. Highest first or lowest first.", "default": "DESC" }, "assetType": { "title": "Asset type", "enum": [ "any", "BLOCKCHAIN", "TOKEN", "FIAT", "STOCK", "INDEX", "COMMODITY", "ETF", "BOND", "REIT", "FUND" ], "type": "string", "description": "Asset top list. Only assets of this type.", "default": "any" }, "assetIndustry": { "title": "Asset industry", "enum": [ "any", "PAYMENT", "PLATFORM", "STABLECOIN", "CROSS_CHAIN_INFRASTRUCTURE", "DECENTRALIZED_INFRASTRUCTURE", "IDENTITY", "MEMBERSHIP", "COLLECTIBLE", "REPUTATION", "GOVERNANCE", "WRAPPED_COLLATERAL", "DECENTRALIZED_FINANCE_PROTOCOL", "EXCHANGE_UTILITY", "MEME", "YIELD_FARMING", "LIQUID_STAKED", "GAMING", "ARTIFICIAL_INTELLIGENCE", "METAVERSE", "ORACLE", "REAL_WORLD_ASSETS", "PRIVACY" ], "type": "string", "description": "Asset top list. Only assets in this industry, such as stablecoins, DeFi protocols or meme coins.", "default": "any" }, "newsLanguage": { "title": "News language", "enum": [ "EN", "ES", "TR", "FR", "JP", "PT" ], "type": "string", "description": "News modes. Articles or sources in this language.", "default": "EN" }, "newsSources": { "title": "News sources", "type": "array", "description": "News articles. Source keys, one per line, such as coindesk or cointelegraph. The news sources mode lists every key. Left empty, all active sources for the language.", "items": { "type": "string" } }, "newsCategories": { "title": "News categories", "type": "array", "description": "News articles. Only articles in any of these categories, one per line, such as BTC, ETH, REGULATION or MARKET.", "items": { "type": "string" } }, "newsExcludeCategories": { "title": "Exclude categories", "type": "array", "description": "News articles. Leave out articles in any of these categories, one per line, such as SPONSORED.", "items": { "type": "string" } }, "includeArticleBody": { "title": "Include article body", "type": "boolean", "description": "News articles. Off by default: rows carry the title, subtitle, link, source, keywords, categories and sentiment. On adds the full BODY text the provider returns. Article text belongs to its publisher.", "default": false }, "sourceType": { "title": "Source type", "enum": [ "RSS", "API", "TWITTER" ], "type": "string", "description": "News sources. Integration type of the source.", "default": "RSS" }, "sourceStatus": { "title": "Source status", "enum": [ "ACTIVE", "INACTIVE", "ANY" ], "type": "string", "description": "News sources. Active sources (default), inactive ones, or both.", "default": "ACTIVE" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "The most rows this run returns and charges for.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Pacing. Keep it under your key's per-minute call limit; the actor also waits and retries when the provider answers 429.", "default": 120 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own CoinDesk Data API key, from developers.coindesk.com. Sent in the Authorization header and never logged. You can instead set the DATA_API_KEY environment secret. Without a key the run ends with a message and nothing is charged." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }