Class Api

SwapRate HTTP and Socket.io API

Hierarchy

Api

Index

Constructors

constructor

Properties

Accessors

accessToken

Constructors

constructor

new Api(options?: ApiOptionsArguments): Api

- Defined in Api/index.ts:45
Parameters
- Optional options: ApiOptionsArguments
Returns Api

Properties

Private _accessToken

_accessToken: string | null = null

Private _endpoint

_endpoint: string

Private _options

_options: ApiOptions

Private _socket

_socket: SocketClient

Accessors

accessToken

set accessToken(accessToken: string): void

- Defined in Api/index.ts:215
Parameters
- accessToken: string
Returns void

Methods

Private _parseAccessToken

_parseAccessToken(accessToken: string): AccessToken

- Defined in Api/index.ts:219
Parameters
- accessToken: string
Returns AccessToken

Private _validAccessToken

_validAccessToken(accessToken: string | null): string

- Defined in Api/index.ts:227
Parameters
- accessToken: string | null
Returns string

Private _validTTL

_validTTL(accessToken: string): boolean

- Defined in Api/index.ts:239
Parameters
- accessToken: string
Returns boolean

closeSocket

closeSocket(): void

- Defined in Api/index.ts:210
Returns void

getAuthLoginData

getAuthLoginData(): Promise<AuthLoginDataResponse>

- Defined in Api/index.ts:80
Returns Promise<AuthLoginDataResponse>

getFixedRateDepositQuote

getFixedRateDepositQuote(productId: string, maturity: number, nominal: number): Promise<ProductQuoteResponse>

- Defined in Api/index.ts:75
Parameters
- productId: string
- maturity: number
- nominal: number
Returns Promise<ProductQuoteResponse>

getMetaConfig

getMetaConfig(): Promise<MetaConfigResponse>

- Defined in Api/index.ts:66
Returns Promise<MetaConfigResponse>

getProducts

getProducts(): Promise<ProductsResponse>

- Defined in Api/index.ts:71
Returns Promise<ProductsResponse>

getWalletBalance

getWalletBalance(accessToken?: null | string): Promise<WalletBalanceResponse>

- Defined in Api/index.ts:85
Parameters
- Default value accessToken: null | string = this._accessToken
Returns Promise<WalletBalanceResponse>

offCharts

offCharts(fn: (response: socket.DataChannelResponse<Charts>) => unknown): void

- Defined in Api/index.ts:188
Parameters
- fn: (response: socket.DataChannelResponse<Charts>) => unknown
  - - (response: socket.DataChannelResponse<Charts>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Charts>
      Returns unknown
Returns void

offError

offError(fn: Function): void

- Defined in Api/index.ts:206
Parameters
- fn: Function
Returns void

offErrorMessage

offErrorMessage(fn: (response: socket.ErrorChannelResponse) => unknown): void

- Defined in Api/index.ts:197
Parameters
- fn: (response: socket.ErrorChannelResponse) => unknown
  - - (response: socket.ErrorChannelResponse): unknown
    - Parameters
      - response: socket.ErrorChannelResponse
      Returns unknown
Returns void

offOrders

offOrders(fn: (response: socket.DataChannelResponse<Order[]>) => unknown): void

- Defined in Api/index.ts:150
Parameters
- fn: (response: socket.DataChannelResponse<Order[]>) => unknown
  - - (response: socket.DataChannelResponse<Order[]>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Order[]>
      Returns unknown
Returns void

offPositions

offPositions(fn: (response: socket.DataChannelResponse<Position[]>) => unknown): void

- Defined in Api/index.ts:171
Parameters
- fn: (response: socket.DataChannelResponse<Position[]>) => unknown
  - - (response: socket.DataChannelResponse<Position[]>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Position[]>
      Returns unknown
Returns void

offSwaps

offSwaps(fn: (response: socket.DataChannelResponse<Swap[]>) => unknown): void

- Defined in Api/index.ts:129
Parameters
- fn: (response: socket.DataChannelResponse<Swap[]>) => unknown
  - - (response: socket.DataChannelResponse<Swap[]>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Swap[]>
      Returns unknown
Returns void

onCharts

onCharts(fn: (response: socket.DataChannelResponse<Charts>) => unknown): void

- Defined in Api/index.ts:184
Parameters
- fn: (response: socket.DataChannelResponse<Charts>) => unknown
  - - (response: socket.DataChannelResponse<Charts>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Charts>
      Returns unknown
Returns void

onError

onError(fn: Function): void

- Defined in Api/index.ts:202
Parameters
- fn: Function
Returns void

onErrorMessage

onErrorMessage(fn: (response: socket.ErrorChannelResponse) => unknown): void

- Defined in Api/index.ts:193
Parameters
- fn: (response: socket.ErrorChannelResponse) => unknown
  - - (response: socket.ErrorChannelResponse): unknown
    - Parameters
      - response: socket.ErrorChannelResponse
      Returns unknown
Returns void

onOrders

onOrders(fn: (response: socket.DataChannelResponse<Order[]>) => unknown): void

- Defined in Api/index.ts:146
Parameters
- fn: (response: socket.DataChannelResponse<Order[]>) => unknown
  - - (response: socket.DataChannelResponse<Order[]>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Order[]>
      Returns unknown
Returns void

onPositions

onPositions(fn: (response: socket.DataChannelResponse<Position[]>) => unknown): void

- Defined in Api/index.ts:167
Parameters
- fn: (response: socket.DataChannelResponse<Position[]>) => unknown
  - - (response: socket.DataChannelResponse<Position[]>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Position[]>
      Returns unknown
Returns void

onSwaps

onSwaps(fn: (response: socket.DataChannelResponse<Swap[]>) => unknown): void

- Defined in Api/index.ts:125
Parameters
- fn: (response: socket.DataChannelResponse<Swap[]>) => unknown
  - - (response: socket.DataChannelResponse<Swap[]>): unknown
    - Parameters
      - response: socket.DataChannelResponse<Swap[]>
      Returns unknown
Returns void

postOrderForm

postOrderForm(order: PostOrdersFormRequestBody, accessToken?: null | string): Promise<PostOrdersFormResponse>

- Defined in Api/index.ts:92
Parameters
- order: PostOrdersFormRequestBody
- Default value accessToken: null | string = this._accessToken
Returns Promise<PostOrdersFormResponse>

postOrderSign

postOrderSign(order: PostOrdersSignRequestBody, accessToken?: null | string): Promise<PostOrdersSignResponse>

- Defined in Api/index.ts:98
Parameters
- order: PostOrdersSignRequestBody
- Default value accessToken: null | string = this._accessToken
Returns Promise<PostOrdersSignResponse>

putOrdersCancel

putOrdersCancel(orderIds: string[], accessToken?: null | string): Promise<void>

- Defined in Api/index.ts:104
Parameters
- orderIds: string[]
- Default value accessToken: null | string = this._accessToken
Returns Promise<void>

subscribeCharts

subscribeCharts(productId: string): void

- Defined in Api/index.ts:176
Parameters
- productId: string
Returns void

subscribeOrders

subscribeOrders(accessToken?: null | string): void

- Defined in Api/index.ts:134
Parameters
- Default value accessToken: null | string = this._accessToken
Returns void

subscribePositions

subscribePositions(accessToken?: null | string): void

- Defined in Api/index.ts:155
Parameters
- Default value accessToken: null | string = this._accessToken
Returns void

subscribeSwaps

subscribeSwaps(accessToken?: null | string): void

- Defined in Api/index.ts:113
Parameters
- Default value accessToken: null | string = this._accessToken
Returns void

unsubscribeCharts

unsubscribeCharts(productId: string): void

- Defined in Api/index.ts:180
Parameters
- productId: string
Returns void

unsubscribeOrders

unsubscribeOrders(accessToken?: null | string): void

- Defined in Api/index.ts:140
Parameters
- Default value accessToken: null | string = this._accessToken
Returns void

unsubscribePositions

unsubscribePositions(accessToken?: null | string): void

- Defined in Api/index.ts:161
Parameters
- Default value accessToken: null | string = this._accessToken
Returns void

unsubscribeSwaps

unsubscribeSwaps(accessToken?: null | string): void

- Defined in Api/index.ts:119
Parameters
- Default value accessToken: null | string = this._accessToken
Returns void

Generated using TypeDoc