Interface AccountApiInterface

AccountApi - interface

AccountApi

interface AccountApiInterface {
    accountCommission(
        requestParameters: SpotWebsocketAPI.AccountCommissionRequest,
    ): Promise<
        WebsocketApiResponse<SpotWebsocketAPI.AccountCommissionResponse>,
    >;
    accountRateLimitsOrders(
        requestParameters?: AccountRateLimitsOrdersRequest,
    ): Promise<WebsocketApiResponse<AccountRateLimitsOrdersResponse>>;
    accountStatus(
        requestParameters?: SpotWebsocketAPI.AccountStatusRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.AccountStatusResponse>>;
    allOrderLists(
        requestParameters?: AllOrderListsRequest,
    ): Promise<WebsocketApiResponse<AllOrderListsResponse>>;
    allOrders(
        requestParameters: SpotWebsocketAPI.AllOrdersRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.AllOrdersResponse>>;
    myAllocations(
        requestParameters: SpotWebsocketAPI.MyAllocationsRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.MyAllocationsResponse>>;
    myPreventedMatches(
        requestParameters: SpotWebsocketAPI.MyPreventedMatchesRequest,
    ): Promise<
        WebsocketApiResponse<SpotWebsocketAPI.MyPreventedMatchesResponse>,
    >;
    myTrades(
        requestParameters: SpotWebsocketAPI.MyTradesRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.MyTradesResponse>>;
    openOrderListsStatus(
        requestParameters?: OpenOrderListsStatusRequest,
    ): Promise<WebsocketApiResponse<OpenOrderListsStatusResponse>>;
    openOrdersStatus(
        requestParameters?: OpenOrdersStatusRequest,
    ): Promise<WebsocketApiResponse<OpenOrdersStatusResponse>>;
    orderAmendments(
        requestParameters: SpotWebsocketAPI.OrderAmendmentsRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderAmendmentsResponse>>;
    orderListStatus(
        requestParameters?: OrderListStatusRequest,
    ): Promise<WebsocketApiResponse<OrderListStatusResponse>>;
    orderStatus(
        requestParameters: SpotWebsocketAPI.OrderStatusRequest,
    ): Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderStatusResponse>>;
}

Implemented by

SpotWebsocketAPI.AccountApi

Index

Methods

accountCommission accountRateLimitsOrders accountStatus allOrderLists allOrders myAllocations myPreventedMatches myTrades openOrderListsStatus openOrdersStatus orderAmendments orderListStatus orderStatus

Methods

accountCommission

accountCommission(
requestParameters: SpotWebsocketAPI.AccountCommissionRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.AccountCommissionResponse>>
Get current account commission rates. Weight: 20
Parameters
- requestParameters: SpotWebsocketAPI.AccountCommissionRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.AccountCommissionResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:52

accountRateLimitsOrders

accountRateLimitsOrders(
requestParameters?: AccountRateLimitsOrdersRequest,
): Promise<WebsocketApiResponse<AccountRateLimitsOrdersResponse>>
Query your current unfilled order count for all intervals. Weight: 40
Parameters
- OptionalrequestParameters: AccountRateLimitsOrdersRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<AccountRateLimitsOrdersResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:66

accountStatus

accountStatus(
requestParameters?: SpotWebsocketAPI.AccountStatusRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.AccountStatusResponse>>
Query information about your account. Weight: 20
Parameters
- OptionalrequestParameters: SpotWebsocketAPI.AccountStatusRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.AccountStatusResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:80

allOrderLists

allOrderLists(
requestParameters?: AllOrderListsRequest,
): Promise<WebsocketApiResponse<AllOrderListsResponse>>
Query information about all your order lists, filtered by time range. Weight: 20
Parameters
- OptionalrequestParameters: AllOrderListsRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<AllOrderListsResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:94

allOrders

allOrders(
requestParameters: SpotWebsocketAPI.AllOrdersRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.AllOrdersResponse>>
Query information about all your orders – active, canceled, filled – filtered by time range. Weight: 20
Parameters
- requestParameters: SpotWebsocketAPI.AllOrdersRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.AllOrdersResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:108

myAllocations

myAllocations(
requestParameters: SpotWebsocketAPI.MyAllocationsRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.MyAllocationsResponse>>
Retrieves allocations resulting from SOR order placement. Weight: 20
Parameters
- requestParameters: SpotWebsocketAPI.MyAllocationsRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyAllocationsResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:122

myPreventedMatches

myPreventedMatches(
requestParameters: SpotWebsocketAPI.MyPreventedMatchesRequest,
): Promise<
WebsocketApiResponse<SpotWebsocketAPI.MyPreventedMatchesResponse>,
>
Displays the list of orders that were expired due to STP.

These are the combinations supported:

symbol + preventedMatchId symbol + orderId symbol + orderId + fromPreventedMatchId (limit will default to 500) symbol + orderId + fromPreventedMatchId + limit

Weight: Case Weight

If symbol is invalid 2

Querying by preventedMatchId 2

Querying by orderId 20
Parameters
- requestParameters: SpotWebsocketAPI.MyPreventedMatchesRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyPreventedMatchesResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:147

Weight: Case	Weight
If `symbol` is invalid	2
Querying by `preventedMatchId`	2
Querying by `orderId`	20

myTrades

myTrades(
requestParameters: SpotWebsocketAPI.MyTradesRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.MyTradesResponse>>
Query information about all your trades, filtered by time range.

Weight: Condition Weight

Without orderId 20

With orderId 5
Parameters
- requestParameters: SpotWebsocketAPI.MyTradesRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyTradesResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:164

Weight: Condition	Weight
Without orderId	20
With orderId	5

openOrderListsStatus

openOrderListsStatus(
requestParameters?: OpenOrderListsStatusRequest,
): Promise<WebsocketApiResponse<OpenOrderListsStatusResponse>>
Query execution status of all open order lists.

If you need to continuously monitor order status updates, please consider using WebSocket Streams:

userDataStream.start request executionReport user data stream event Weight: 6
Parameters
- OptionalrequestParameters: OpenOrderListsStatusRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<OpenOrderListsStatusResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:181

openOrdersStatus

openOrdersStatus(
requestParameters?: OpenOrdersStatusRequest,
): Promise<WebsocketApiResponse<OpenOrdersStatusResponse>>
Query execution status of all open orders.

If you need to continuously monitor order status updates, please consider using WebSocket Streams:

userDataStream.start request executionReport user data stream event Weight: Adjusted based on the number of requested symbols:

Parameter Weight

symbol 6

none 80
Parameters
- OptionalrequestParameters: OpenOrdersStatusRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<OpenOrdersStatusResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:205

Parameter	Weight
`symbol`	6
none	80

orderAmendments

orderAmendments(
requestParameters: SpotWebsocketAPI.OrderAmendmentsRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderAmendmentsResponse>>
Queries all amendments of a single order. Weight: 4
Parameters
- requestParameters: SpotWebsocketAPI.OrderAmendmentsRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderAmendmentsResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:219

orderListStatus

orderListStatus(
requestParameters?: OrderListStatusRequest,
): Promise<WebsocketApiResponse<OrderListStatusResponse>>
Check execution status of an Order list.

For execution status of individual orders, use order.status. Weight: 4
Parameters
- OptionalrequestParameters: OrderListStatusRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<OrderListStatusResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:235

orderStatus

orderStatus(
requestParameters: SpotWebsocketAPI.OrderStatusRequest,
): Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderStatusResponse>>
Check execution status of an order. Weight: 4
Parameters
- requestParameters: SpotWebsocketAPI.OrderStatusRequest
  Request parameters.
Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderStatusResponse>>
Memberof
AccountApiInterface
- Defined in clients/spot/src/websocket-api/modules/account-api.ts:249

Interface AccountApiInterface

Implemented by

Index

Methods

Methods

accountCommission

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.AccountCommissionResponse>>

Memberof

accountRateLimitsOrders

Parameters

Returns Promise<WebsocketApiResponse<AccountRateLimitsOrdersResponse>>

Memberof

accountStatus

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.AccountStatusResponse>>

Memberof

allOrderLists

Parameters

Returns Promise<WebsocketApiResponse<AllOrderListsResponse>>

Memberof

allOrders

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.AllOrdersResponse>>

Memberof

myAllocations

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyAllocationsResponse>>

Memberof

myPreventedMatches

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyPreventedMatchesResponse>>

Memberof

myTrades

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyTradesResponse>>

Memberof

openOrderListsStatus

Parameters

Returns Promise<WebsocketApiResponse<OpenOrderListsStatusResponse>>

Memberof

openOrdersStatus

Parameters

Returns Promise<WebsocketApiResponse<OpenOrdersStatusResponse>>

Memberof

orderAmendments

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderAmendmentsResponse>>

Memberof

orderListStatus

Parameters

Returns Promise<WebsocketApiResponse<OrderListStatusResponse>>

Memberof

orderStatus

Parameters

Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.OrderStatusResponse>>

Memberof

Settings

On This Page