Interface OrderBookRealTimeClientOptions

Orderbook Client Options

See

typedoc Reference Documentation

interface OrderBookRealTimeClientOptions {
    apiKey?: string;
    sandbox?: boolean;
    baseRestApiURL?: string;
    baseWebSocketURL?: string;
}

Properties

apiKey? sandbox? baseRestApiURL? baseWebSocketURL?

Properties

Optional apiKey

apiKey?: string

Optionally provide an apiKey for increased rate limiting

Optional sandbox

sandbox?: boolean

Controls whether the production or sandbox endpoints will be used

Optional baseRestApiURL

baseRestApiURL?: string

Optionally provide a custom url to use when making IDEX REST API requests.

  • Will override the sandbox option when given.

Optional baseWebSocketURL

baseWebSocketURL?: string

Optionally provide a custom WebSocket API URL to use when connecting to the IDEX WebSocket API.

  • Will override the sandbox option when given.

Settings

Member Visibility

Theme

On This Page

apiKeysandboxbaseRestApiURLbaseWebSocketURL