Binance Connector JS
    Preparing search index...

    Interface AccountApiInterface

    AccountApi - interface AccountApi

    interface AccountApiInterface {
        accountCommission(
            requestParameters: SpotRestAPI.AccountCommissionRequest,
        ): Promise<RestApiResponse<SpotRestAPI.AccountCommissionResponse>>;
        allOrderList(
            requestParameters?: AllOrderListRequest,
        ): Promise<RestApiResponse<AllOrderListResponse>>;
        allOrders(
            requestParameters: SpotRestAPI.AllOrdersRequest,
        ): Promise<RestApiResponse<SpotRestAPI.AllOrdersResponse>>;
        getAccount(
            requestParameters?: GetAccountRequest,
        ): Promise<RestApiResponse<GetAccountResponse>>;
        getOpenOrders(
            requestParameters?: GetOpenOrdersRequest,
        ): Promise<RestApiResponse<GetOpenOrdersResponse>>;
        getOrder(
            requestParameters: GetOrderRequest,
        ): Promise<RestApiResponse<GetOrderResponse>>;
        getOrderList(
            requestParameters?: GetOrderListRequest,
        ): Promise<RestApiResponse<GetOrderListResponse>>;
        myAllocations(
            requestParameters: SpotRestAPI.MyAllocationsRequest,
        ): Promise<RestApiResponse<SpotRestAPI.MyAllocationsResponse>>;
        myFilters(
            requestParameters: SpotRestAPI.MyFiltersRequest,
        ): Promise<RestApiResponse<SpotRestAPI.MyFiltersResponse>>;
        myPreventedMatches(
            requestParameters: SpotRestAPI.MyPreventedMatchesRequest,
        ): Promise<RestApiResponse<SpotRestAPI.MyPreventedMatchesResponse>>;
        myTrades(
            requestParameters: SpotRestAPI.MyTradesRequest,
        ): Promise<RestApiResponse<SpotRestAPI.MyTradesResponse>>;
        openOrderList(
            requestParameters?: OpenOrderListRequest,
        ): Promise<RestApiResponse<OpenOrderListResponse>>;
        orderAmendments(
            requestParameters: SpotRestAPI.OrderAmendmentsRequest,
        ): Promise<RestApiResponse<SpotRestAPI.OrderAmendmentsResponse>>;
        rateLimitOrder(
            requestParameters?: RateLimitOrderRequest,
        ): Promise<RestApiResponse<RateLimitOrderResponse>>;
    }

    Implemented by

    Index

    Methods

    accountCommission allOrderList allOrders getAccount getOpenOrders getOrder getOrderList myAllocations myFilters myPreventedMatches myTrades openOrderList orderAmendments rateLimitOrder

    Methods

    • Get all account orders; active, canceled, or filled.

      Weight(IP): 20

      Security Type: USER_DATA

      Notes: Data Source:* Database

      • If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned.
      • For some historical orders cummulativeQuoteQty will be < 0, meaning the data is not available at this time.
      • If startTime and/or endTime provided, orderId is not required.
      • The time between startTime and endTime can't be longer than 24 hours.

      Parameters

      Returns Promise<RestApiResponse<SpotRestAPI.AllOrdersResponse>>

      AccountApiInterface

    • Check an order's status.

      Weight(IP): 4

      Security Type: USER_DATA

      Notes: Data Source:* Memory => Database

      • Either orderId or origClientOrderId must be sent.
      • If both orderId and origClientOrderId are provided, the orderId is searched first, then the origClientOrderId from that result is checked against that order. If both conditions are not met the request will be rejected.
      • For some historical orders cummulativeQuoteQty will be < 0, meaning the data is not available at this time.

      Parameters

      Returns Promise<RestApiResponse<GetOrderResponse>>

      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<RestApiResponse<SpotRestAPI.MyAllocationsResponse>>

      AccountApiInterface

    • Get trades for a specific account and symbol.

      Weight: Condition Weight
      Without orderId 20
      With orderId 5

      Security Type: USER_DATA

      Notes: Data Source:* Memory => Database

      *Notes:**:

      • If fromId is set, it will get trades >= that fromId. Otherwise most recent trades are returned.
      • The time between startTime and endTime can't be longer than 24 hours.
      • These are the supported combinations of all parameters:
      • symbol
      • symbol + orderId
      • symbol + startTime
      • symbol + endTime
      • symbol + fromId
      • symbol + startTime + endTime
      • symbol+ orderId + fromId

      Parameters

      Returns Promise<RestApiResponse<SpotRestAPI.MyTradesResponse>>

      AccountApiInterface

    Settings

    Member Visibility

    On This Page

    Methods