Skip to main content
Version: release (v0.77)

List candle data

GET 

/api/v2/candle

Get a list of candle data for a given candle ID. A candle ID encapsulates a market ID and candle interval. A list of available candle IDs, and therefore candle intervals can be found using the list-candle-intervals API.

Request

Query Parameters

    candleId stringrequired

    Candle ID to retrieve candle data for.

    fromTimestamp int64

    Timestamp in Unix nanoseconds to retrieve candles from.

    toTimestamp int64

    Timestamp in Unix nanoseconds to retrieve candles to.

    pagination.first int32

    Number of records to be returned that sort greater than row identified by cursor supplied in 'after'.

    pagination.after string

    If paging forwards, the cursor string for the last row of the previous page.

    pagination.last int32

    Number of records to be returned that sort less than row identified by cursor supplied in 'before'.

    pagination.before string

    If paging forwards, the cursor string for the first row of the previous page.

    pagination.newestFirst boolean

    Whether to order the results with the newest records first. If not set, the default value is true.

Responses

A successful response.

Schema
    candles object

    Page of candle data and corresponding page information.

    edges object[]

    Page of candle data items and their corresponding cursors.

  • Array [
  • cursor string

    Cursor that can be used to fetch further pages.

    node object

    Candlestick data, i.e. high, low, open, and closing prices for an interval of trading.

    close string

    Closing trade price.

    high string

    Highest price for trading during the candle interval.

    lastUpdate int64

    Timestamp in Unix nanoseconds for the point in time when the candle was last updated.

    low string

    Lowest price for trading during the candle interval.

    notional uint64

    Total notional value traded during the candle interval. This value is determined by multiplying price, using market decimal places, by size, using position decimal places. The number of decimal places needed to convert this value to a decimal is market decimal places plus position decimal places.

    open string

    Open trade price.

    start int64

    Timestamp in Unix nanoseconds for the point in time when the candle was initially created/opened.

    volume uint64

    Total trading volume during the candle interval.

  • ]
  • pageInfo object

    Page information that is used for fetching further pages.

    endCursor string

    End cursor.

    hasNextPage boolean

    Indicator if there is a next page.

    hasPreviousPage boolean

    Indicator if there is a previous page.

    startCursor string

    Start cursor.

Loading...