Class RestClient

Hierarchy

RestClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RestClient(__namedParameters: IExanteOptions): RestClient

- Defined in src/rest.ts:703
Parameters
- __namedParameters: IExanteOptions
Returns RestClient

Properties

Private Readonly #app_id

#app_id: string

Private Readonly #client_id

#client_id: string

Private Readonly #shared_key

#shared_key: string

Readonly url

url: URL

Accessors

Private #headers

get #headers(): Headers

- Defined in src/rest.ts:1071
Get authorization headers

Returns Headers

Private #token

get #token(): string

- Defined in src/rest.ts:1047
Get a JSON Web Token

Returns string

Methods

fetch

fetch<T>(url: string | URL, __namedParameters?: RequestInit): Promise<T>

- Defined in src/rest.ts:717
Make a request and parse the body as JSON

Type parameters
- T = unknown
Parameters
- url: string | URL
- __namedParameters: RequestInit = {}
Returns Promise<T>

fetchStream

fetchStream(url: string | URL, options?: RequestInit): Promise<JSONStream>

- Defined in src/rest.ts:1036
Make a request and return JSONStream

Parameters
- url: string | URL
- options: RequestInit = {}
Returns Promise<JSONStream>

getAccountSummary

getAccountSummary(__namedParameters: IAccountSummaryOptions): Promise<IAccountSummary>

- Defined in src/rest.ts:939
Get the summary for the specified account and session date

Parameters
- __namedParameters: IAccountSummaryOptions
Returns Promise<IAccountSummary>

getAccountSummaryWithoutDate

getAccountSummaryWithoutDate(__namedParameters: IBaseAccountSummaryOptions): Promise<IAccountSummary>

- Defined in src/rest.ts:928
Get the summary for the specified account

Parameters
- __namedParameters: IBaseAccountSummaryOptions
Returns Promise<IAccountSummary>

getAccounts

getAccounts(__namedParameters?: IVersion): Promise<IUserAccount[]>

- Defined in src/rest.ts:725
Get the list of user accounts and their statuses

Parameters
- __namedParameters: IVersion = {}
Returns Promise<IUserAccount[]>

getActiveOrders

getActiveOrders(__namedParameters: IActiveOrdersOptions): Promise<IOrder[]>

- Defined in src/rest.ts:988
Get the list of active trading orders

Parameters
- __namedParameters: IActiveOrdersOptions
Returns Promise<IOrder[]>

getCandles

getCandles(__namedParameters: ICandlesOptions): Promise<ICandle[]>

- Defined in src/rest.ts:902
Get the list of OHLC candles

Parameters
- __namedParameters: ICandlesOptions
Returns Promise<ICandle[]>

getCrossrate

getCrossrate(__namedParameters: ICrossrateOptions): Promise<ICrossrate>

- Defined in src/rest.ts:759
Get the crossrate from one currency to another

Parameters
- __namedParameters: ICrossrateOptions
Returns Promise<ICrossrate>

getCurrencies

getCurrencies(__namedParameters?: IVersion): Promise<ICurrencies>

- Defined in src/rest.ts:751
Get the list of available currencies

Parameters
- __namedParameters: IVersion = {}
Returns Promise<ICurrencies>

getDailyChange

getDailyChange(__namedParameters: ISymbolId): Promise<IDailyChange[]>

- Defined in src/rest.ts:741
Get the list of daily changes for requested instruments

Parameters
- __namedParameters: ISymbolId
Returns Promise<IDailyChange[]>

getDailyChanges

getDailyChanges(__namedParameters?: IVersion): Promise<IDailyChange[]>

- Defined in src/rest.ts:733
Get the list of daily changes

Parameters
- __namedParameters: IVersion = {}
Returns Promise<IDailyChange[]>

getExchangeSymbols

getExchangeSymbols(__namedParameters: IExchangeId): Promise<IIntruments>

- Defined in src/rest.ts:777
Get instruments by exchange

Parameters
- __namedParameters: IExchangeId
Returns Promise<IIntruments>

getExchanges

getExchanges(__namedParameters?: IVersion): Promise<IExchange[]>

- Defined in src/rest.ts:769
Get list of exchanges

Parameters
- __namedParameters: IVersion = {}
Returns Promise<IExchange[]>

getGroupNearestSymbol

getGroupNearestSymbol(__namedParameters: IGroupId): Promise<IIntrument>

- Defined in src/rest.ts:803
Get financial instrument which has the nearest expiration in the group

Parameters
- __namedParameters: IGroupId
Returns Promise<IIntrument>

getGroupSymbols

getGroupSymbols(__namedParameters: IGroupId): Promise<IIntruments>

- Defined in src/rest.ts:794
Get financial instruments which belong to specified group

Parameters
- __namedParameters: IGroupId
Returns Promise<IIntruments>

getGroups

getGroups(__namedParameters?: IVersion): Promise<IInstrumentGroup[]>

- Defined in src/rest.ts:786
Get list of available instrument groups

Parameters
- __namedParameters: IVersion = {}
Returns Promise<IInstrumentGroup[]>

getLastQuote

getLastQuote(__namedParameters: ILastQuoteOptions): Promise<ILastQuote[]>

- Defined in src/rest.ts:869
Get the last quote

Parameters
- __namedParameters: ILastQuoteOptions
Returns Promise<ILastQuote[]>

getOrder

getOrder(__namedParameters: IOrderId): Promise<IOrder>

- Defined in src/rest.ts:1009
Get the order with specified identifier

Parameters
- __namedParameters: IOrderId
Returns Promise<IOrder>

getOrders

getOrders(__namedParameters: IOrdersOptions): Promise<IOrder[]>

- Defined in src/rest.ts:978
Get the list of historical orders

Parameters
- __namedParameters: IOrdersOptions
Returns Promise<IOrder[]>

getQuoteStream

getQuoteStream(__namedParameters: ILastQuoteOptions, __namedParameters?: { signal?: AbortSignal }): Promise<JSONStream>

- Defined in src/rest.ts:891
Get the trades stream for the specified financial instrument

Parameters
- __namedParameters: ILastQuoteOptions
- __namedParameters: { signal?: AbortSignal } = {}
  - Optional signal?: AbortSignal
Returns Promise<JSONStream>

getSymbol

getSymbol(__namedParameters: ISymbolIdOptions): Promise<IIntrument>

- Defined in src/rest.ts:820
Get instrument available for authorized user

Parameters
- __namedParameters: ISymbolIdOptions
Returns Promise<IIntrument>

getSymbolSchedule

getSymbolSchedule(__namedParameters: ISymbolSchedule): Promise<IInstrumentSchedule>

- Defined in src/rest.ts:829
Get financial schedule for requested instrument

Parameters
- __namedParameters: ISymbolSchedule
Returns Promise<IInstrumentSchedule>

getSymbolSpecification

getSymbolSpecification(__namedParameters: ISymbolId): Promise<IInstrumentSpecification>

- Defined in src/rest.ts:841
Get additional parameters for requested instrument

Parameters
- __namedParameters: ISymbolId
Returns Promise<IInstrumentSpecification>

getSymbols

getSymbols(__namedParameters?: IVersion): Promise<IIntruments>

- Defined in src/rest.ts:812
Get list of instruments available for authorized user

Parameters
- __namedParameters: IVersion = {}
Returns Promise<IIntruments>

getTicks

getTicks(__namedParameters: ITicksOptions): Promise<ITick[]>

- Defined in src/rest.ts:916
Get the list of ticks

Parameters
- __namedParameters: ITicksOptions
Returns Promise<ITick[]>

getTradesStream

getTradesStream(__namedParameters: ISymbolIds, __namedParameters?: { signal?: AbortSignal }): Promise<JSONStream>

- Defined in src/rest.ts:881
Get the trades stream for the specified financial instrument

Parameters
- __namedParameters: ISymbolIds
- __namedParameters: { signal?: AbortSignal } = {}
  - Optional signal?: AbortSignal
Returns Promise<JSONStream>

getTransactions

getTransactions(__namedParameters?: ITransactionsOptions): Promise<ITransactions>

- Defined in src/rest.ts:951
Get the list of transactions

Parameters
- __namedParameters: ITransactionsOptions = {}
Returns Promise<ITransactions>

getTypeSymbols

getTypeSymbols(__namedParameters: ISymbolIdType): Promise<IIntruments>

- Defined in src/rest.ts:860
Get financial instruments of the requested type

Parameters
- __namedParameters: ISymbolIdType
Returns Promise<IIntruments>

getTypes

getTypes(__namedParameters?: IVersion): Promise<IInstrumentType[]>

- Defined in src/rest.ts:852
Get list of known instrument types

Parameters
- __namedParameters: IVersion = {}
Returns Promise<IInstrumentType[]>

modifyOrder

modifyOrder(__namedParameters: IModifyOrderOptions): Promise<IOrder>

- Defined in src/rest.ts:998
Replace or cancel trading order

Parameters
- __namedParameters: IModifyOrderOptions
Returns Promise<IOrder>

orderUpdatesHttp

orderUpdatesHttp(__namedParameters?: IVersion, __namedParameters?: { signal?: AbortSignal }): Promise<JSONStream>

- Defined in src/rest.ts:1018
Get order updates stream via HTTP

Parameters
- __namedParameters: IVersion = {}
- __namedParameters: { signal?: AbortSignal } = {}
  - Optional signal?: AbortSignal
Returns Promise<JSONStream>

placeOrder

placeOrder(options: IPlaceOrderOptionsV2): Promise<IOrderV2[]>
placeOrder(options: IPlaceOrderOptionsV3): Promise<IOrderV3[]>

- Defined in src/rest.ts:965
Place new trading order

Parameters
- options: IPlaceOrderOptionsV2
Returns Promise<IOrderV2[]>
- Defined in src/rest.ts:966
Parameters
- options: IPlaceOrderOptionsV3
Returns Promise<IOrderV3[]>

tradesHttp

tradesHttp(__namedParameters?: IVersion, __namedParameters?: { signal?: AbortSignal }): Promise<JSONStream>

- Defined in src/rest.ts:1027
Get trades updates stream via HTTP

Parameters
- __namedParameters: IVersion = {}
- __namedParameters: { signal?: AbortSignal } = {}
  - Optional signal?: AbortSignal
Returns Promise<JSONStream>

Static JWT

JWT(secret: string, payload: string | Buffer | Record<string, unknown>, header?: string | Buffer | Record<string, unknown>): string

- Defined in src/rest.ts:1105
Get a JSON Web Token (HMAC + SHA256)

Parameters
- secret: string
- payload: string | Buffer | Record<string, unknown>
- header: string | Buffer | Record<string, unknown> = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
Returns string

Static base64URL

base64URL(input: string | Buffer | Record<string, unknown>): string

- Defined in src/rest.ts:1078
Convert to Base64URL

Parameters
- input: string | Buffer | Record<string, unknown>
Returns string

Static fetch

fetch<T>(url: string | URL, options?: RequestInit): Promise<T>

- Defined in src/rest.ts:1142
Make a request and parse the body as JSON

Type parameters
- T = unknown
Parameters
- url: string | URL
- options: RequestInit = {}
Returns Promise<T>

Static fetchStream

fetchStream(url: string | URL, options?: RequestInit): Promise<JSONStream>

- Defined in src/rest.ts:1123
Make a request and return a stream

Parameters
- url: string | URL
- options: RequestInit = {}
Returns Promise<JSONStream>

Static setQuery

setQuery(url: URL, query: Record<string, undefined | string | number | boolean>): void

- Defined in src/rest.ts:1092
Add query to URL

Parameters
- url: URL
- query: Record<string, undefined | string | number | boolean>
Returns void