Class Api

OEX HTTP

Hierarchy

Api
- ApiWithSocket

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Api(options?: ApiOptionsArguments): Api

- Defined in src/Api/api.ts:33
Parameters
- Optional options: ApiOptionsArguments
Returns Api

Properties

Protected _authAddress

_authAddress: string | null = null

Protected Readonly _endpoint

_endpoint: string

Private Readonly _options

_options: ApiOptions

Protected _signature

_signature: string | null = null

Accessors

authAddress

set authAddress(authAddress: string): void

- Defined in src/Api/api.ts:109
Parameters
- authAddress: string
Returns void

signature

set signature(signature: string): void

- Defined in src/Api/api.ts:113
Parameters
- signature: string
Returns void

Methods

getAuthLoginData

getAuthLoginData(): Promise<EIP712Message>

- Defined in src/Api/api.ts:51
Returns Promise<EIP712Message>

getOrderPreSubmit

getOrderPreSubmit(query: RequestQuery, authAddress?: string, signature?: string): Promise<ResponseBody>

- Defined in src/Api/api.ts:95
Parameters
- query: RequestQuery
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

metaConfig

metaConfig(): Promise<ResponseBody>

- Defined in src/Api/api.ts:118
Returns Promise<ResponseBody>

metaTickersSearch

metaTickersSearch(query: Partial<RequestQuery>): Promise<ResponseBody>

- Defined in src/Api/api.ts:122
Parameters
- query: Partial<RequestQuery>
Returns Promise<ResponseBody>

ordersGetAllOrdersByAddress

ordersGetAllOrdersByAddress(authAddress?: string, signature?: string): Promise<ResponseBody>

- Defined in src/Api/api.ts:164
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

postOrderForm

postOrderForm(order: RequestBody, authAddress?: string, signature?: string): Promise<ResponseBody>

- Defined in src/Api/api.ts:56
Parameters
- order: RequestBody
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

postOrderSign

postOrderSign(order: RequestBody, authAddress?: string, signature?: string): Promise<unknown>

- Defined in src/Api/api.ts:69
Parameters
- order: RequestBody
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<unknown>

putOrdersCancel

putOrdersCancel(query: RequestQuery, authAddress?: string, signature?: string): Promise<unknown>

- Defined in src/Api/api.ts:82
Parameters
- query: RequestQuery
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<unknown>

tickersGetAll

tickersGetAll(query: Partial<RequestQuery>): Promise<ResponseBody>

- Defined in src/Api/api.ts:137
Parameters
- query: Partial<RequestQuery>
Returns Promise<ResponseBody>

tickersGetData

tickersGetData(hash: string): Promise<ResponseBody>

- Defined in src/Api/api.ts:143
Parameters
- hash: string
Returns Promise<ResponseBody>

tickersGetDerivatives

tickersGetDerivatives(query: Partial<RequestQuery>): Promise<unknown>

- Defined in src/Api/api.ts:149
Parameters
- query: Partial<RequestQuery>
Returns Promise<unknown>

tradesGetAllTradesByAddress

tradesGetAllTradesByAddress(authAddress?: string, signature?: string): Promise<ResponseBody>

- Defined in src/Api/api.ts:156
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

walletTokenBalance

walletTokenBalance(authAddress?: string, signature?: string): Promise<ResponseBody>

- Defined in src/Api/api.ts:129
Parameters
- Default value authAddress: string = this._authAddress!
- Default value signature: string = this._signature!
Returns Promise<ResponseBody>

Generated using TypeDoc