API docs by Redocly

Prices API (2.0.0)

Download OpenAPI specification:

Public HTTP API for asset metadata, spot prices, OHLC candles, and the OpenAPI document.

System

Get API health

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Get the OpenAPI specification

Responses

Response samples

Content type
application/json
{ }

Assets

List enabled assets

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ]
}

Get an asset

path Parameters
ticker
required
string non-empty

Canonical asset ticker.

Responses

Response samples

Content type
application/json
{
  • "assetType": "crypto",
  • "display": {
    },
  • "enabledSources": [
    ],
  • "freshness": {
    },
  • "name": "string",
  • "risk": "Low",
  • "description": "string",
  • "supportedCurrencies": [
    ],
  • "symbol": "string",
  • "venue": {
    }
}

Prices

Get OHLC candles

Returns OHLC candles for a source or the median aggregation. JSON responses are capped to the latest 2 calendar months by clamping the effective from value in the response body so clients can page backwards by comparing the requested and returned range. Request Accept: application/octet-stream to receive the native binary candle stream instead; binary requests beyond the same 2-month public range limit are rejected with 429. Each candle row is 7 IEEE 754 little-endian 64-bit floating point values in this order: openTime, open, high, low, close, closeTime, volume.

query Parameters
asset
required
string non-empty

Canonical asset ticker.

currency
required
string non-empty

Quote currency.

interval
required
string^[1-9][0-9]*(m|h|d)$

OHLC interval. Values must represent a positive multiple of 5 minutes. Hour and day aliases such as 1h and 1d are accepted and normalized in responses.

from
required
string non-empty

Inclusive start timestamp in milliseconds since 1970, encoded as a string. JSON responses may clamp this to to - 2 months and return the effective range in the response payload.

to
required
string non-empty

Exclusive end timestamp in milliseconds since 1970, encoded as a string.

source
string non-empty

Optional source identifier. When omitted, the API returns median candles across fresh enabled sources.

Responses

Response samples

Content type
Example
{
  • "aggregation": "source",
  • "asset": "string",
  • "candles": [
    ],
  • "currency": "string",
  • "from": 0,
  • "interval": "string",
  • "source": "string",
  • "to": 0
}

Get chart candles

Returns chart-optimized OHLC candles for supported common ranges. The endpoint reads through a chart cache and refreshes cached windows by rebuilding only the trailing tail when enough time has elapsed since the last cached candle close. Public requests that ask for more detail than the per-range minimum interval permits are rejected with 429: 1d >= 5m, 1w >= 15m, 1m >= 1h, 3m >= 4h, ytd >= 12h, 1y >= 12h.

query Parameters
asset
required
string non-empty

Canonical asset ticker.

currency
required
string non-empty

Quote currency.

range
string
Enum: "1d" "1w" "1m" "3m" "ytd" "1y"

Requested chart range. Defaults to 1m.

resolution
integer [ 1 .. 1000 ]

Requested chart resolution as a target candle count. Defaults to 100. Requests fail with 400 when the implied interval would be below 5 minutes, and with 429 when the range-resolution combination exceeds the public cost limit for that range.

source
string non-empty

Optional source identifier. When omitted, the API returns the median chart across enabled sources.

Responses

Response samples

Content type
application/json
Example
{
  • "aggregation": "source",
  • "asset": "string",
  • "candles": [
    ],
  • "currency": "string",
  • "from": 0,
  • "intervalMs": 0,
  • "range": "1d",
  • "resolution": 0,
  • "source": "string",
  • "to": 0
}

Get batch spot prices

Returns spot prices for up to 50 requested asset-currency-source combinations in request order.

Request Body schema: application/json
required
required
Array of objects (SpotPriceQuery) <= 50 items

Responses

Request samples

Content type
application/json
{
  • "requests": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get a spot price

query Parameters
asset
required
string non-empty

Canonical asset ticker.

currency
required
string non-empty

Quote currency.

source
string non-empty

Optional source identifier. When omitted, the API returns the median across fresh enabled sources.

Responses

Response samples

Content type
application/json
Example
{
  • "aggregation": "source",
  • "asset": "string",
  • "asOf": 0,
  • "currency": "string",
  • "fresh": true,
  • "price": 0,
  • "providerTimestamp": 0,
  • "quality": {
    },
  • "source": "string"
}

Sources

List configured sources

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ]
}