Binance Connector JS
    Preparing search index...

    CapitalApi - interface CapitalApi

    interface CapitalApiInterface {
        allCoinsInformation(
            requestParameters?: AllCoinsInformationRequest,
        ): Promise<RestApiResponse<AllCoinsInformationResponse>>;
        depositAddress(
            requestParameters: DepositAddressRequest,
        ): Promise<RestApiResponse<DepositAddressResponse>>;
        depositHistory(
            requestParameters?: DepositHistoryRequest,
        ): Promise<RestApiResponse<DepositHistoryResponse>>;
        fetchDepositAddressListWithNetwork(
            requestParameters: FetchDepositAddressListWithNetworkRequest,
        ): Promise<RestApiResponse<FetchDepositAddressListWithNetworkResponse>>;
        fetchWithdrawAddressList(): Promise<
            RestApiResponse<FetchWithdrawAddressListResponse>,
        >;
        fetchWithdrawQuota(): Promise<RestApiResponse<FetchWithdrawQuotaResponse>>;
        oneClickArrivalDepositApply(
            requestParameters?: OneClickArrivalDepositApplyRequest,
        ): Promise<RestApiResponse<OneClickArrivalDepositApplyResponse>>;
        withdraw(
            requestParameters: WithdrawRequest,
        ): Promise<RestApiResponse<WithdrawResponse>>;
        withdrawHistory(
            requestParameters?: WithdrawHistoryRequest,
        ): Promise<RestApiResponse<WithdrawHistoryResponse>>;
    }

    Implemented by

    Index

    Methods

    • Submit a withdraw request

      Weight(UID): 900

      Security Type: USER_DATA

      Notes:

      • If network not send, return with default network of the coin.
      • You can get network and isDefault in networkList of a coin in the response of Get /sapi/v1/capital/config/getall (HMAC SHA256).
      • To check if travel rule is required, by using GET /sapi/v1/localentity/questionnaire-requirements and if it returns anything other than NIL you will need update SAPI to POST /sapi/v1/localentity/withdraw/apply else you can continue POST /sapi/v1/capital/withdraw/apply. Please note that if you are required to comply to travel rule please refer to the Travel Rule SAPI.
      • "For networks that do not support memo/tag, submitting a withdrawal request with a non-empty addressTag will return error -4106 TAG_NOT_SUPPORTED_FOR_NETWORK. Please omit the addressTag field for such networks. You can check whether a network requires a tag via GET /sapi/v1/capital/config/getall: If withdrawTag = true → memo/tag is required. If withdrawTag = false → memo/tag is not supported; omit addressTag."

      Parameters

      Returns Promise<RestApiResponse<WithdrawResponse>>

      CapitalApiInterface

    • Fetch withdraw history

      Weight(UID): 18000 (10 requests per second)

      Security Type: USER_DATA

      Notes:

      • network may not be in the response for old withdraw.
      • Please notice the default startTime and endTime to make sure that time interval is within 0-90 days.
      • If both startTime and endTimeare sent, time between startTimeand endTimemust be less than 90 days.
      • If withdrawOrderId is sent, time between startTime and endTime must be less than 7 days.
      • If withdrawOrderId is sent, startTime and endTime are not sent, will return last 7 days records by default.
      • Maximum support idList number is 45.

      Parameters

      Returns Promise<RestApiResponse<WithdrawHistoryResponse>>

      CapitalApiInterface