Sign in

v1

latestSwagger 2.02026-07-179553242.0 KB
Quote

Get previous quotes in time buckets.

Timestamps returned by our bucketed endpoints are the end of the period, indicating when the bucket was written to disk. Some other common systems use the timestamp as the beginning of the period. Please be aware of this when using this endpoint.

get/quote/bucketed

Query parameters

binSizestring

Time interval to bucket by. Available options: [1m,5m,1h,1d].

partialboolean

If true, will send in-progress (incomplete) bins for the current time period.

symbolstring

Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

You can also send a timeframe, e.g. XBT:quarterly. Timeframes are nearest, daily, weekly, monthly, quarterly, biquarterly, and perpetual.

Symbols are case-insensitive.

filterstring JSON

Generic table filter. Send JSON key/value pairs, such as {"key": "value"}. You can key on individual fields, and do more advanced querying on timestamps. See the Timestamp Docs for more details.

columnsstring JSON

Array of column names to fetch. If omitted, will return all columns.

Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.

countinteger

Number of results to fetch. Must be a positive integer.

startinteger

Starting point for results.

reverseboolean

If true, will sort results newest first.

startTimestring date-time

Starting date filter for results.

endTimestring date-time

Ending date filter for results.

Response

Request was successful

timestampstring date-time required
symbolstring required
bidSizeinteger
bidPricenumber double
askPricenumber double
askSizeinteger

Example response

[
  {
    "symbol": "symbol",
    "askPrice": 1.4658129805029452,
    "bidSize": 0,
    "bidPrice": 6.027456183070403,
    "askSize": 5,
    "timestamp": "2000-01-23T04:56:07.000+00:00"
  }
]