v1

latestOpenAPI 3.1.02026-07-264019.5 KB

Hourly & Daily Reference Rates

Retrieve the historical (time series) hourly and daily reference rates for a specific asset.

get/spot/reference-rates/{assetId}

Path parameters

assetId'btc' | 'eth' required

The id of the asset for which reference rates are needed.

Query parameters

startDatestring date-time

[Optional] Payload only includes data after this date (inclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

endDatestring date-time

[Optional] Payload only includes data before this date (exclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

timeFormat'milliseconds' | 'ms*' | 'iso' | 'iso8601' | 'hr' | 'human_readable'

[Optional] Time format of the timestamps in the return payload.

timeInterval'hours' | 'days'

Specify the granularity of the desired reference rate.

dailyTime'T16:00-05:00' | 'T16:00-04:00' | 'T16:00+00:00' | 'T16:00+01:00' | 'T16:00+04:00' | 'T16:00+08:00' | 'T16:00+09:00'

Use with timeInterval=days. Filter for the asset's daily reference rate at 16:00 hours for a specific timezone. [Examples] dailyTime=T16:00+08:00 is 16:00 Singapore & Hong Kong

direction'desc' | 'asc'

The order in which to return the results (ascending or descending). By default, records are returned in descending order, so the most recent records are returned first.

Headers

Accept-Encodingstring required

api-versionstring

Response

200

statusinteger

titlestring

descriptionstring

Example response

{
  "status": 200,
  "title": "OK",
  "description": "Successful request",
  "payload": {
    "metadata": {
      "timeInterval": "hours",
      "api-version": "2023-09-30"
    },
    "data": {
      "assetARCID": "eth",
      "assetSymbol": "eth",
      "assetName": "Ether",
      "currency": "usd",
      "referenceRates": [
        {
          "timestamp": "2023-11-05 18:00:00 000",
          "unitPrice": 1896.2722539256226
        }
      ]
    }
  }
}