Whitebit

Whitebit

Whitebit API Information

Whitebit Api Link: https://docs.whitebit.com/private/http-main-v4/#main-balance

API Overview

Base URL: https://whitebit.com

Introduction

WhiteBIT API provides comprehensive access to our trading platform through both public and private endpoints. By using any WhiteBIT API endpoints, you confirm your agreement to the Terms of Use.

Public API Endpoints

Public endpoints provide access to market data and other non-account-specific information:

  • Cache Policy: All public endpoints return cached data with specific refresh intervals documented for each endpoint
  • HTTP Method: Use GET for all public requests
  • Parameters: Pass parameters via query string

Private API Endpoints

Private endpoints provide secure access to account-specific functions like trading and balance management:

  • Authentication: Required for all private endpoints – see Authentication Guide
  • IP Restrictions: Up to 5 trusted IPs can be configured for security
  • HTTP Method: Use POST with appropriate body data and headers

RCXT Whitebit API Information

There is 1 Base Endpoint for the Whitebit exchange:

  • apiUrl: whitebit.com

Rate Limits

The rate limit set for each endpoint on the Bingx exchange is as follows:

Limit (1 minute) Spot Usd Futures TransferIn TransferOut Ticker
Fetch Balances 1 Request Weight
Fetch Orders 1 Request Weight 1 Request Weight
Fetch Trades 1 Request Weight
Fetch DepositWithdrawals 1 Request Weight 1 Request Weight
Ticker 1 Request Weight

Fetch Balances

Spot Balance
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/main-account/balance.
  • The RCXT Endpoint is api/v1/whitebit/balances.

The user sends a GET request to query the Whitebit wallet balances. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Spot Balance is 1.

Response Example:

{
  "spot": [
    {
      "coin": "SHIB", #asset
      "total": "41634.28"
    }
  ],
  "margin": null,
  "isolatedMargin": null,
  "futures": null,
  "earnings": null
}

Fetch Trades

Spot Trades
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/trade-account/executed-history.
  • The RCXT Endpoint is api/v1/whitebit/trades.

The user sends a GET request to query the Whitebit Spot trades. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • The following query parameters are required:

    • orderId: Used to filter by a specific order ID.
    • offset: A parameter specifying how many records to skip in the transaction list. This is used for pagination.
    • type: The type is set to spot for Spot Trades.
  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Spot Trades is 1.

Response Example:

{
  "trades": [
    {
      "orderId": "226664511", #orderId
      "tradeId": "27082209",
      "isBuyer": false,
      "isMaker": false,
      "price": "0.07610000", #price
      "quantity": "199.90000000", #origQty
      "symbol": "ACAUSDT", #symbol
      "time": 1737552748284, #time
      "commission": "0.01521239", #fee
      "commissionCurrency": "USDT" #side
    }
  ],
  "cursor": ""
}

Fetch Orders

Spot Orders
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/trade-account/order/history.
  • The RCXT Endpoint is api/v1/whitebit/orders.

The user sends a GET request to query Whitebit Spot orders. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • The following query parameters are required:

    • startTime: The date from which we want to fetch data.
    • offset: A parameter specifying how many records to skip in the transaction list. This is used for pagination.
    • type: Options include spot, cfutures, ufutures. spot should be selected for Spot Orders.
    • orderStatus: If orderStatus is “open”, it fetches Open Orders; if “closed”, it fetches Closed Orders.
  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Spot Orders is 1.
Spot Open Orders
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/orders.
  • The RCXT Endpoint is api/v1/whitebit/orders.

The user sends a GET request to query Whitebit Spot Open orders. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • The following query parameters are required:

    • startTime: The date from which we want to fetch data.
    • offset: A parameter specifying how many records to skip in the transaction list. This is used for pagination.
    • type: Options include spot, cfutures, ufutures. spot should be selected for Spot Open Orders.
    • orderStatus: If orderStatus is “open”, it fetches Open Orders; if “closed”, it fetches Closed Orders.
  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Spot Open Orders is 1.
Usd Futures Orders
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/trade-account/order/history.
  • The RCXT Endpoint is api/v1/whitebit/orders.

The user sends a GET request to query Whitebit Usd Futures orders. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • The following query parameters are required:

    • startTime: The date from which we want to fetch data.
    • offset: A parameter specifying how many records to skip in the transaction list. This is used for pagination.
    • type: Options include spot, cfutures, ufutures. spot should be selected for Usd Futures Orders.
    • orderStatus: If orderStatus is “open”, it fetches Open Orders; if “closed”, it fetches Closed Orders.
  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Usd Futures Orders is 1.
Usd Futures Open Orders
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/orders.
  • The RCXT Endpoint is api/v1/whitebit/orders.

The user sends a GET request to query Whitebit Usd Futures Open orders. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • The following query parameters are required:

    • startTime: The date from which we want to fetch data.
    • offset: A parameter specifying how many records to skip in the transaction list. This is used for pagination.
    • type: Options include spot, cfutures, ufutures. spot should be selected for Usd Futures Open Orders.
    • orderStatus: If orderStatus is “open”, it fetches Open Orders; if “closed”, it fetches Closed Orders.
  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Usd Futures Open Orders is 1.

Response Example:

{
  "orders": [
    {
      "orderId": "1881364520706670592", #orderId
      "symbol": "XRPUSDT", #symbol
      "type": "MARKET", #type
      "price": "3.335", #price
      "side": "SELL", #side
      "time": 1737387230537, #time
      "status": "CLOSED", #status
      "executedQuantity": "2.7", #executedQty
      "quantity": "2.7" #origiQty
    }
  ],
  "cursor": ""
}

Fetch DepositWithdrawals

Transfer In
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/main-account/history.
  • The RCXT Endpoint is api/v1/whitebit/deposit-withdraw-history.

The user sends a GET request to query Whitebit transfer-in data. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • The following query parameters are required:

    • offset: A parameter specifying how many records to skip in the transaction list. This is used for pagination.
    • type: Options include transferIn and transferOut. transferIn should be selected for Transfer In.
  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Transfer In is 1.
Transfer Out
  • The Base Endpoint is apiUrl (whitebit.com).
  • The Endpoint used is /api/v4/main-account/history.
  • The RCXT Endpoint is api/v1/whitebit/deposit-withdraw-history.

The user sends a GET request to query Whitebit transfer-out data. This request must include the required header parameters:

  • The apiKey and secretKey values are taken from the header.

  • The following query parameters are required:

    • offset: A parameter specifying how many records to skip in the transaction list. This is used for pagination.
    • type: Options include transferIn and transferOut. transferOut should be selected for Transfer Out.
  • Limiter:

    • Each API endpoint is assigned a specific Request Weight value. The Request Weight value for Transfer Out is 1.

Response Example:

{
  "depositWithdrawals": [
    {
      "fiatCurrency": "",
      "cryptoCurrency": "USDT", #coin
      "fiatAmount": "",
      "cryptoAmount": "10", #amount
      "price": "",
      "address": "TNZcfzLhPXVUVe1NLyjdGrjKkPLbHbncJk", #address
      "orderId": "",
      "transactionId": "e4e406a067ff5ce1c05abc6056e6041478153fc03ba996b565f4727b01a708d8", #txId
      "fee": "",
      "network": "TRC20", #network
      "status": "1", #status
      "time": 1726576711847 #insertTime
    }
  ],
  "cursor": ""
}

Fetch Ticker

Ticker
  • The Base Endpoint is apiUrl (whitebit.com).

  • The Endpoint used is /api/v4/public/ticker.

  • The RCXT Endpoint is api/v1/whitebit/ticker.

  • https://whitebit.com/api/v4/public/ticker: Provides the symbol and current price for cryptocurrency pairs traded only with USDT.

  • The only query parameter required is symbol (e.g. BTCUSDT):

    • symbol: Specifies the symbol of the cryptocurrency pair.

Response Example:

{
  "symbol": "BTCUSDT", #symbol
  "price": "104562.53000000" #price
}