Binance Connector JS
    Preparing search index...

    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>>;
        myFilters(
            requestParameters: SpotWebsocketAPI.MyFiltersRequest,
        ): Promise<WebsocketApiResponse<SpotWebsocketAPI.MyFiltersResponse>>;
        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

    Index

    Methods

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

    Methods

    • Query information about all your order lists, filtered by time range.

      Weight(IP): 20

      Security Type: USER_DATA

      Notes: Data Source:* Database

      Notes: If startTime and/or endTime are specified, fromId is ignored. Order lists are filtered by transactionTime of the last order list execution status update. If fromId is specified, return order lists with order list ID >= fromId. If no condition is specified, the most recent order lists are returned. The time between startTime and endTime can't be longer than 24 hours.

      Parameters

      Returns Promise<WebsocketApiResponse<AllOrderListsResponse>>

      AccountApiInterface

    • Query information about all your orders – active, canceled, filled – filtered by time range.

      Weight(IP): 20

      Security Type: USER_DATA

      Notes: Data Source:* Database

      Notes:

      If startTime and/or endTime are specified, orderId is ignored.

      Orders are filtered by time of the last execution status update.

      If orderId is specified, return orders with order ID >= orderId.

      If no condition is specified, the most recent orders are returned.

      For some historical orders the cummulativeQuoteQty response field may be negative, meaning the data is not available at this time.

      The time between startTime and endTime can't be longer than 24 hours.

      Parameters

      Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.AllOrdersResponse>>

      AccountApiInterface

    • Retrieves allocations resulting from SOR order placement.

      Weight(IP): 20

      Security Type: USER_DATA

      Notes: Data Source:* Database

      Supported parameter combinations:

      Parameters Response
      symbol allocations from oldest to newest
      symbol + startTime oldest allocations since startTime
      symbol + endTime newest allocations until endTime
      symbol + startTime + endTime allocations within the time range
      symbol + fromAllocationId allocations by allocation ID
      symbol + orderId allocations related to an order starting with oldest
      symbol + orderId + fromAllocationId allocations related to an order by allocation ID

      Note:* The time between startTime and endTime can't be longer than 24 hours.

      Parameters

      Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyAllocationsResponse>>

      AccountApiInterface

    • Query information about all your trades, filtered by time range.

      Weight: Condition Weight
      Without orderId 20
      With orderId 5

      Security Type: USER_DATA

      Notes: Data Source: Memory => Database

      Notes:

      • If fromId is specified, return trades with trade ID >= fromId.
      • If startTime and/or endTime are specified, trades are filtered by execution time (time).
      • fromId cannot be used together with startTime and endTime.
      • If orderId is specified, only trades related to that order are returned.
      • startTime and endTime cannot be used together with orderId.
      • If no condition is specified, the most recent trades are returned.
      • The time between startTime and endTime can't be longer than 24 hours.

      Parameters

      Returns Promise<WebsocketApiResponse<SpotWebsocketAPI.MyTradesResponse>>

      AccountApiInterface

    • Query execution status of all open orders.

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

      userDataStream.subscribe if on an authenticated session userDataStream.subscribe.signature if subscribing through signature subscription

      Weight: | Parameter | Weight | | --------- | ------ | | symbol | 6 | | none | 80 |

      Security Type: USER_DATA

      Notes: Data Source: Memory => Database

      Parameters

      Returns Promise<WebsocketApiResponse<OpenOrdersStatusResponse>>

      AccountApiInterface

    • Check execution status of an Order list.

      For execution status of individual orders, use order.status.

      Weight(IP): 4

      Security Type: USER_DATA

      Notes: Data Source:* Database

      Notes:

      origClientOrderId refers to listClientOrderId of the order list itself.

      If both origClientOrderId and orderListId parameters are specified, only origClientOrderId is used and orderListId is ignored.

      Parameters

      Returns Promise<WebsocketApiResponse<OrderListStatusResponse>>

      AccountApiInterface

    Settings

    Member Visibility

    On This Page

    Methods