{"openapi":"3.1.0","info":{"title":"BitcoinCounterFlow API","version":"2.0.0","description":"Bitcoin market intelligence built around derivatives positioning and forced liquidation. Authenticate with the X-API-Key header. Plans and rate limits are described at https://bitcoincounterflow.com/api-pricing."},"servers":[{"url":"https://api.bitcoincounterflow.com","description":"Production"},{"url":"http://localhost:3000","description":"Local"}],"tags":[{"name":"Derivatives"},{"name":"Institutional"},{"name":"Liquidation"},{"name":"Macro"},{"name":"Market"},{"name":"On-chain"},{"name":"Price"},{"name":"Sentiment"},{"name":"Tools"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key"}},"schemas":{"Error":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}},"responses":{"Success":{"description":"Requested series or object. Shape varies per endpoint — see summary/description above.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"object","additionalProperties":true}},{"type":"object","additionalProperties":true}]}}}},"Forbidden":{"description":"Missing, invalid or expired API key, or tier not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"TooManyRequests":{"description":"Rate limit exceeded. Check the Retry-After header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ServiceUnavailable":{"description":"Upstream or key validation temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"security":[{"ApiKeyAuth":[]}],"paths":{"/api/funding-rate":{"get":{"operationId":"fundingRate","summary":"Aggregated funding rate history across exchanges.","description":"Aggregated funding rate history across exchanges. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/all-history-global-funding-rate":{"get":{"operationId":"allHistoryGlobalFundingRate","summary":"Full history of the global aggregated funding rate.","description":"Full history of the global aggregated funding rate. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/last-global-funding-rate":{"get":{"operationId":"lastGlobalFundingRate","summary":"Most recent global aggregated funding rate reading.","description":"Most recent global aggregated funding rate reading. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/list-global-funding-rate":{"get":{"operationId":"listGlobalFundingRate","summary":"Global funding rate series, optionally merged with price.","description":"Global funding rate series, optionally merged with price. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}},{"name":"merge_price","in":"query","required":false,"description":"Merge the price series into each row instead of returning it separately.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/exchanges-funding-rate":{"get":{"operationId":"exchangesFundingRate","summary":"Current funding rate broken down by exchange.","description":"Current funding rate broken down by exchange. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/exchanges-funding-history":{"get":{"operationId":"exchangesFundingHistory","summary":"Historical funding rate broken down by exchange.","description":"Historical funding rate broken down by exchange. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"start","in":"query","required":false,"description":"Alias of \"from\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"end","in":"query","required":false,"description":"Alias of \"to\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"from_timestamp","in":"query","required":false,"description":"Start of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/final-data-funding":{"get":{"operationId":"finalDataFunding","summary":"Consolidated funding rate dataset used by the charts.","description":"Consolidated funding rate dataset used by the charts. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/open-interest":{"get":{"operationId":"openInterest","summary":"Aggregated open interest, optionally merged with price and volume.","description":"Aggregated open interest, optionally merged with price and volume. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"start","in":"query","required":false,"description":"Alias of \"from\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"end","in":"query","required":false,"description":"Alias of \"to\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"from_timestamp","in":"query","required":false,"description":"Start of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"source","in":"query","required":false,"description":"Upstream data source to read from when more than one is available.","schema":{"type":"string"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}},{"name":"merge_price","in":"query","required":false,"description":"Merge the price series into each row instead of returning it separately.","schema":{"type":"boolean"}},{"name":"with_volume","in":"query","required":false,"description":"Include the volume series alongside the metric.","schema":{"type":"boolean"}},{"name":"merge_volume","in":"query","required":false,"description":"Merge the volume series into each row instead of returning it separately.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/final-data-open":{"get":{"operationId":"finalDataOpen","summary":"Consolidated open interest dataset used by the charts.","description":"Consolidated open interest dataset used by the charts. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/options-open-interest":{"get":{"operationId":"optionsOpenInterest","summary":"Open interest on Bitcoin options contracts.","description":"Open interest on Bitcoin options contracts. Requires an API key on the BUILDER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"start","in":"query","required":false,"description":"Alias of \"from\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"end","in":"query","required":false,"description":"Alias of \"to\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"from_timestamp","in":"query","required":false,"description":"Start of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/long-short":{"get":{"operationId":"longShort","summary":"Long and short account positioning across exchanges.","description":"Long and short account positioning across exchanges. Requires an API key on the BUILDER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"source","in":"query","required":false,"description":"Upstream data source to read from when more than one is available.","schema":{"type":"string"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}},{"name":"merge_price","in":"query","required":false,"description":"Merge the price series into each row instead of returning it separately.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/long-short-ratio":{"get":{"operationId":"longShortRatio","summary":"Long to short ratio series across exchanges.","description":"Long to short ratio series across exchanges. Requires an API key on the BUILDER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"source","in":"query","required":false,"description":"Upstream data source to read from when more than one is available.","schema":{"type":"string"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}},{"name":"merge_price","in":"query","required":false,"description":"Merge the price series into each row instead of returning it separately.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/volume":{"get":{"operationId":"volume","summary":"Current trading volume by exchange.","description":"Current trading volume by exchange. Requires an API key on the BUILDER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/volume-history":{"get":{"operationId":"volumeHistory","summary":"Historical trading volume by exchange and series type.","description":"Historical trading volume by exchange and series type. Requires an API key on the DEVELOPER plan or above.","tags":["Derivatives"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"exchange","in":"query","required":false,"description":"Exchange to filter by, for example binance or BinanceUSDM.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Volume series variant to return, for example spot or futures.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/liquidations":{"get":{"operationId":"liquidations","summary":"Liquidation events by exchange and timeframe.","description":"Liquidation events by exchange and timeframe. Requires an API key on the BUILDER plan or above.","tags":["Liquidation"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"timeframe","in":"query","required":false,"description":"Candle timeframe, for example 1m, 5m, 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"description":"Exchange to filter by, for example binance or BinanceUSDM.","schema":{"type":"string"}},{"name":"symbol","in":"query","required":false,"description":"Trading pair, for example BTCUSDT.","schema":{"type":"string"}},{"name":"order","in":"query","required":false,"description":"Sort direction of the result set.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/liquidations-by-exchange":{"get":{"operationId":"liquidationsByExchange","summary":"Liquidation totals per exchange over a rolling window, long and short split.","description":"Liquidation totals per exchange over a rolling window, long and short split. Requires an API key on the BUILDER plan or above.","tags":["Liquidation"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"hours","in":"query","required":false,"description":"Number of hours to look back from now (rolling window). Default 24, max 720.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/liquidation-heatmap":{"get":{"operationId":"liquidationHeatmap","summary":"Liquidation heatmap showing where leverage is stacked on the book.","description":"Liquidation heatmap showing where leverage is stacked on the book. Requires an API key on the BUILDER plan or above.","tags":["Liquidation"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"period","in":"query","required":false,"description":"Named lookback window, for example 24h, 1week, 1month, 1year.","schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"description":"Exchange to filter by, for example binance or BinanceUSDM.","schema":{"type":"string"}},{"name":"symbol","in":"query","required":false,"description":"Trading pair, for example BTCUSDT.","schema":{"type":"string"}},{"name":"rangeStep","in":"query","required":false,"description":"Price bucket width used to build the heatmap grid.","schema":{"type":"integer"}},{"name":"format","in":"query","required":false,"description":"Response encoding when the endpoint supports more than JSON.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/liquidation-heatmap-pro":{"get":{"operationId":"liquidationHeatmapPro","summary":"High resolution liquidation heatmap. Scale or Institutional API plan required.","description":"High resolution liquidation heatmap. Scale or Institutional API plan required. Requires an API key on the SCALE plan or above.","tags":["Liquidation"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"symbol","in":"query","required":false,"description":"Trading pair, for example BTCUSDT.","schema":{"type":"string"}},{"name":"maxBins","in":"query","required":false,"description":"Maximum number of price bins in the pro heatmap.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/liquidation-map":{"get":{"operationId":"liquidationMap","summary":"Projected liquidation levels grouped by leverage bracket.","description":"Projected liquidation levels grouped by leverage bracket. Requires an API key on the DEVELOPER plan or above.","tags":["Liquidation"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"period","in":"query","required":false,"description":"Named lookback window, for example 24h, 1week, 1month, 1year.","schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"description":"Exchange to filter by, for example binance or BinanceUSDM.","schema":{"type":"string"}},{"name":"symbol","in":"query","required":false,"description":"Trading pair, for example BTCUSDT.","schema":{"type":"string"}},{"name":"rangeStep","in":"query","required":false,"description":"Price bucket width used to build the heatmap grid.","schema":{"type":"integer"}},{"name":"clusters","in":"query","required":false,"description":"Number of liquidation clusters to group the map into.","schema":{"type":"integer"}},{"name":"maxPoints","in":"query","required":false,"description":"Maximum number of points returned in the map.","schema":{"type":"integer"}},{"name":"format","in":"query","required":false,"description":"Response encoding when the endpoint supports more than JSON.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/mvrv":{"get":{"operationId":"mvrv","summary":"MVRV ratio, market value against realized value.","description":"MVRV ratio, market value against realized value. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/nupl":{"get":{"operationId":"nupl","summary":"Net unrealized profit and loss, current reading.","description":"Net unrealized profit and loss, current reading. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/nupl-history":{"get":{"operationId":"nuplHistory","summary":"Net unrealized profit and loss, full history.","description":"Net unrealized profit and loss, full history. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/sopr":{"get":{"operationId":"sopr","summary":"Spent output profit ratio, daily series.","description":"Spent output profit ratio, daily series. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/puell-multiple":{"get":{"operationId":"puellMultiple","summary":"Puell multiple, miner revenue against its yearly average.","description":"Puell multiple, miner revenue against its yearly average. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/realized-pl":{"get":{"operationId":"realizedPl","summary":"Realized profit and loss booked on chain.","description":"Realized profit and loss booked on chain. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/vdd":{"get":{"operationId":"vdd","summary":"Value days destroyed, coin age weighted spending.","description":"Value days destroyed, coin age weighted spending. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/hash-rate":{"get":{"operationId":"hashRate","summary":"Network hash rate, daily series.","description":"Network hash rate, daily series. Requires an API key on the BUILDER plan or above.","tags":["On-chain"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/kline":{"get":{"operationId":"kline","summary":"Bitcoin candles at the requested interval.","description":"Bitcoin candles at the requested interval. Requires an API key on the DEVELOPER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/bitcoin-kline":{"get":{"operationId":"bitcoinKline","summary":"Bitcoin candles with continuous series support.","description":"Bitcoin candles with continuous series support. Requires an API key on the DEVELOPER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"start","in":"query","required":false,"description":"Alias of \"from\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"end","in":"query","required":false,"description":"Alias of \"to\", accepted by some legacy handlers.","schema":{"type":"string"}},{"name":"from_timestamp","in":"query","required":false,"description":"Start of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"continuous","in":"query","required":false,"description":"Return a gap free series, filling missing candles.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/btc-usdt":{"get":{"operationId":"btcUsdt","summary":"Bitcoin priced in USDT.","description":"Bitcoin priced in USDT. Requires an API key on the DEVELOPER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/btc-brl":{"get":{"operationId":"btcBrl","summary":"Bitcoin priced in Brazilian real.","description":"Bitcoin priced in Brazilian real. Requires an API key on the DEVELOPER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/btc-eur":{"get":{"operationId":"btcEur","summary":"Bitcoin priced in euro.","description":"Bitcoin priced in euro. Requires an API key on the DEVELOPER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/paxgold-kline":{"get":{"operationId":"paxgoldKline","summary":"PAX Gold candles, used as the tokenized gold reference.","description":"PAX Gold candles, used as the tokenized gold reference. Requires an API key on the BUILDER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Sort direction of the result set.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"format","in":"query","required":false,"description":"Response encoding when the endpoint supports more than JSON.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/paxgold/latest":{"get":{"operationId":"paxgoldLatest","summary":"Most recent PAX Gold records.","description":"Most recent PAX Gold records. Requires an API key on the BUILDER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"count","in":"query","required":false,"description":"Number of most recent records to return.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/paxgold/stats":{"get":{"operationId":"paxgoldStats","summary":"PAX Gold summary statistics over a window.","description":"PAX Gold summary statistics over a window. Requires an API key on the BUILDER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"period","in":"query","required":false,"description":"Named lookback window, for example 24h, 1week, 1month, 1year.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/paxgold/analysis":{"get":{"operationId":"paxgoldAnalysis","summary":"PAX Gold trend analysis with a moving average.","description":"PAX Gold trend analysis with a moving average. Requires an API key on the BUILDER plan or above.","tags":["Price"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"ma_period","in":"query","required":false,"description":"Moving average window, in periods.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/btc-spx":{"get":{"operationId":"btcSpx","summary":"Bitcoin against the S&P 500.","description":"Bitcoin against the S&P 500. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/btc-gold":{"get":{"operationId":"btcGold","summary":"Bitcoin against gold.","description":"Bitcoin against gold. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/btc-ibov":{"get":{"operationId":"btcIbov","summary":"Bitcoin against the Ibovespa.","description":"Bitcoin against the Ibovespa. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dxy":{"get":{"operationId":"dxy","summary":"US dollar index series.","description":"US dollar index series. Requires an API key on the BUILDER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/m2-global":{"get":{"operationId":"m2Global","summary":"Global M2 money supply.","description":"Global M2 money supply. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/cme-vs-bitcoin":{"get":{"operationId":"cmeVsBitcoin","summary":"CME futures against spot Bitcoin, including the gap.","description":"CME futures against spot Bitcoin, including the gap. Requires an API key on the BUILDER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"sort","in":"query","required":false,"description":"Sort direction of the result set.","schema":{"type":"string","enum":["asc","desc"]}},{"name":"format","in":"query","required":false,"description":"Response encoding when the endpoint supports more than JSON.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/sp500-realtime":{"get":{"operationId":"sp500Realtime","summary":"S&P 500 realtime quote.","description":"S&P 500 realtime quote. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/sp500-daily":{"get":{"operationId":"sp500Daily","summary":"S&P 500 daily candles.","description":"S&P 500 daily candles. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/sp500-15min":{"get":{"operationId":"sp50015min","summary":"S&P 500 fifteen minute candles.","description":"S&P 500 fifteen minute candles. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/nasdaq-daily":{"get":{"operationId":"nasdaqDaily","summary":"Nasdaq daily candles.","description":"Nasdaq daily candles. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/nasdaq-15min":{"get":{"operationId":"nasdaq15min","summary":"Nasdaq fifteen minute candles.","description":"Nasdaq fifteen minute candles. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/nvidia-daily":{"get":{"operationId":"nvidiaDaily","summary":"Nvidia daily candles, used as the risk appetite proxy.","description":"Nvidia daily candles, used as the risk appetite proxy. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/nvidia-15min":{"get":{"operationId":"nvidia15min","summary":"Nvidia fifteen minute candles.","description":"Nvidia fifteen minute candles. Requires an API key on the DEVELOPER plan or above.","tags":["Macro"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/etf-data":{"get":{"operationId":"etfData","summary":"Spot Bitcoin ETF flows.","description":"Spot Bitcoin ETF flows. Requires an API key on the DEVELOPER plan or above.","tags":["Institutional"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/bitcoin-treasuries":{"get":{"operationId":"bitcoinTreasuries","summary":"Corporate and sovereign Bitcoin treasury holdings.","description":"Corporate and sovereign Bitcoin treasury holdings. Requires an API key on the BUILDER plan or above.","tags":["Institutional"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/mstr-treasury":{"get":{"operationId":"mstrTreasury","summary":"MicroStrategy Bitcoin treasury position.","description":"MicroStrategy Bitcoin treasury position. Requires an API key on the BUILDER plan or above.","tags":["Institutional"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/mstr-daily":{"get":{"operationId":"mstrDaily","summary":"MicroStrategy daily candles.","description":"MicroStrategy daily candles. Requires an API key on the DEVELOPER plan or above.","tags":["Institutional"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/mstr-15min":{"get":{"operationId":"mstr15min","summary":"MicroStrategy fifteen minute candles.","description":"MicroStrategy fifteen minute candles. Requires an API key on the DEVELOPER plan or above.","tags":["Institutional"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/fear-greed":{"get":{"operationId":"fearGreed","summary":"Fear and greed index, daily series.","description":"Fear and greed index, daily series. Requires an API key on the DEVELOPER plan or above.","tags":["Sentiment"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/google-trends":{"get":{"operationId":"googleTrends","summary":"Google search interest for Bitcoin.","description":"Google search interest for Bitcoin. Requires an API key on the DEVELOPER plan or above.","tags":["Sentiment"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/google-trends-10y":{"get":{"operationId":"googleTrends10y","summary":"Google search interest for Bitcoin over ten years.","description":"Google search interest for Bitcoin over ten years. Requires an API key on the DEVELOPER plan or above.","tags":["Sentiment"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/bitcoin-stats":{"get":{"operationId":"bitcoinStats","summary":"Consolidated Bitcoin market statistics.","description":"Consolidated Bitcoin market statistics. Requires an API key on the DEVELOPER plan or above.","tags":["Market"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/bitcoin-performance":{"get":{"operationId":"bitcoinPerformance","summary":"Bitcoin performance across standard periods.","description":"Bitcoin performance across standard periods. Requires an API key on the DEVELOPER plan or above.","tags":["Market"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/bitcoin-indicators":{"get":{"operationId":"bitcoinIndicators","summary":"Composite indicator readings used by the dashboards.","description":"Composite indicator readings used by the dashboards. Requires an API key on the DEVELOPER plan or above.","tags":["Market"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/bitcoin-dominance":{"get":{"operationId":"bitcoinDominance","summary":"Bitcoin dominance against the wider crypto market cap.","description":"Bitcoin dominance against the wider crypto market cap. Requires an API key on the DEVELOPER plan or above.","tags":["Market"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"with_price","in":"query","required":false,"description":"Include the BTC price series alongside the metric.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dominance-history":{"get":{"operationId":"dominanceHistory","summary":"Dominance history with selectable focus asset and resolution.","description":"Dominance history with selectable focus asset and resolution. Requires an API key on the DEVELOPER plan or above.","tags":["Market"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to_timestamp","in":"query","required":false,"description":"End of the range as a unix timestamp in seconds.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"source","in":"query","required":false,"description":"Upstream data source to read from when more than one is available.","schema":{"type":"string"}},{"name":"focus","in":"query","required":false,"description":"Asset to centre the dominance series on.","schema":{"type":"string"}},{"name":"resolution","in":"query","required":false,"description":"Output granularity of the dominance series.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/superchart-indicators-latest":{"get":{"operationId":"superchartIndicatorsLatest","summary":"Latest open interest and funding indicator readings for internal chart composition.","description":"Latest open interest and funding indicator readings for internal chart composition. Requires an API key on the DEVELOPER plan or above.","tags":["Market"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"indicators","in":"query","required":false,"description":"Comma separated list of indicators to compute alongside the candles.","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/superchart-candles":{"get":{"operationId":"superchartCandles","summary":"Candles with optional indicators, powering the Superchart terminal.","description":"Candles with optional indicators, powering the Superchart terminal. Requires an API key on the SCALE plan or above.","tags":["Market"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"from","in":"query","required":false,"description":"Start of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"to","in":"query","required":false,"description":"End of an explicit range, ISO date or unix timestamp.","schema":{"type":"string"}},{"name":"startTime","in":"query","required":false,"description":"Legacy Binance candle range start as a unix timestamp in milliseconds.","schema":{"type":"integer"}},{"name":"endTime","in":"query","required":false,"description":"Legacy Binance candle range end as a unix timestamp in milliseconds.","schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of rows returned.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"timeframe","in":"query","required":false,"description":"Candle timeframe, for example 1m, 5m, 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"symbol","in":"query","required":false,"description":"Trading pair, for example BTCUSDT.","schema":{"type":"string"}},{"name":"indicators","in":"query","required":false,"description":"Comma separated list of indicators to compute alongside the candles.","schema":{"type":"string"}},{"name":"strictRange","in":"query","required":false,"description":"Fail instead of widening the range when the requested window has no data.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/strategy-history":{"get":{"operationId":"strategyHistory","summary":"MicroStrategy treasury and stock price history.","description":"MicroStrategy treasury and stock price history. Requires an API key on the BUILDER plan or above.","tags":["Institutional"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}},"/api/dca-calculator":{"get":{"operationId":"dcaCalculator","summary":"Dollar cost averaging outcomes over a chosen window.","description":"Dollar cost averaging outcomes over a chosen window. Requires an API key on the DEVELOPER plan or above.","tags":["Tools"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"days","in":"query","required":false,"description":"Number of days to look back from now. History limits depend on the API plan.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Aggregation bucket, for example 15m, 1h, 4h, 1d, 1w.","schema":{"type":"string"}},{"name":"with_cache","in":"query","required":false,"description":"Allow the handler to serve a precomputed cached result.","schema":{"type":"boolean"}}],"responses":{"200":{"$ref":"#/components/responses/Success"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"},"503":{"$ref":"#/components/responses/ServiceUnavailable"}}}}}}