Interface RestRequestGetCandles

GET candles request interface

See

interface RestRequestGetCandles {
    market: string;
    interval: CandleInterval;
    start?: number;
    end?: number;
    limit?: number;
}

Hierarchy (view full)

Properties

market interval start? end? limit?

Properties

market

market: string

Base-quote pair e.g. 'ETH-USD'

interval

interval: CandleInterval

Time interval for data

  • Use the CandleInterval enum to get auto completion and inline documentation on the enumerations.

Example

import { RestPublicClient, CandleInterval } from '@idexio/idex-sdk';

const client = new RestPublicClient();

const candles = await client.getCandles({
 market: 'ETH-USD',
 interval: CandleInterval.ONE_HOUR
})

See

enum CandleInterval

Optional start

start?: number

If provided, indicates the earliest (oldest) timestamp of an object to include in the response.

  • This value is inclusive, meaning objects with timestamps that exactly match start are included in the response.
  • start MUST be earlier than end if provided.

Optional end

end?: number

If provided, indicates the latest (newest) timestamp of an object to include the response.

  • This value is inclusive, meaning objects with timestamps that exactly match end are included in the response.
  • end MUST be a later timestamp than start.

Optional limit

limit?: number

Maximum number to return of the requested type.

Settings

Member Visibility

Theme

On This Page

marketintervalstartendlimit