GET
/
spot
/
vwap
/
pairs
/
{pair}
/
historical
Pairs Historical
curl --request GET \
  --url https://api.amberdata.com/market/spot/vwap/pairs/{pair}/historical \
  --header 'x-api-key: <api-key>'
{
  "status": 200,
  "title": "OK",
  "description": "Successful request",
  "payload": [
    {
      "timestamp": "2020-09-11T20:41:00.000Z",
      "pair": "btc_usd",
      "price": 10311.5,
      "volume": 0.1212,
      "vwap": 10315.9
    }
  ]
}

Authorizations

​
x-api-key
string
header
default:API_KEY
required

Path Parameters

​
pair
string
default:btc_usd
required

The pair for which to retrieve the requested data.

Query Parameters

​
exchange
string

[Optional] The exchange for which to retrieve the requested data.<br/>Note that daily vwap is not supported with this parameter.

​
includeCrossRates
boolean

[Optional] If true, cross rate pairs are included in the price & VWAP calculations - this option only supports pairs quoted in usd (ie *_usd pairs).<br/>[Defaults] false* | true

​
startDate
string<date-time>

[Optional] Payload only includes data after this date (inclusive). <br>The interval can not exceed 12 months (d), 30 days (h) or 24 hours (m).<br>[Formats] seconds | milliseconds | iso8601<br>[Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
endDate
string<date-time>

[Optional] Payload only includes data before this date (exclusive). <br>The interval can not exceed 12 months (d), 30 days (h) or 24 hours (m).<br>[Formats] seconds | milliseconds | iso8601<br>[Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

​
timeInterval
string

[Optional] The time interval of the timeseries in the return payload.<br/>[Defaults] m* | minute | h | hour | d | day

​
lookbackPeriod
integer

[Optional] Number of historical data points used in the calculation.<br/>[Defaults] 60 for minutely, 24 for hourly and 20 for daily

​
timeFormat
string

[Optional] Time format of the timestamps in the return payload.<br/>[Defaults] milliseconds | ms* | iso | iso8601 | hr | human_readable

Response

200
application/json

200

The response is of type object.