Disconnected

Message Log

0 messages

No messages yet

Connect to a WebSocket server to see messages

Private HTTP API V1

Those endpoints are deprecated. Use V4 alternatives instead

Base URL is https://whitebit.com

Endpoint example: https://whitebit.com/api/v1/{endpoint}

All endpoints return time in Unix-time format.

All endpoints return either a JSON object or array.

For receiving responses from API calls please use http method POST

Error messages V1 format

{
  "code": 0,
  "message": "MESSAGE",
  "errors": {
    "PARAM1": ["MESSAGE"],
    "PARAM2": ["MESSAGE"]
  }
}

Trading balance by currency

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/account/balance

This endpoint retrieves the trade balance by currency ticker.

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
currencyStringYesCurrency’s ticker. Example: BTC

Request BODY raw:

{
  "currency": "BTC",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

{
  "available": "0.2", // Available balance of currency for trading
  "freeze": "1.02" // Balance of currency on orders
}
Errors:
{
  "message": "Currency not found"
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "ticker": ["The ticker must be a string."]
  }
}

Trading balances

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/account/balances

This endpoint retrieves all available balances for trading.

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters: NONE

Request BODY raw:

{
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

{
  "success": true,
  "message": "",
  "result": {
    "BAT": {
      "available": "0",
      "freeze": "0"
    },
    "BCH": {
      "available": "0.00096586",
      "freeze": "0"
    },
    "BNB": {
      "available": "0",
      "freeze": "0"
    },
    "BSV": {
      "available": "0",
      "freeze": "0"
    },
    "BTC": {
      "available": "0.2",
      "freeze": "1.02"
    },
    "BTG": {
      "available": "0",
      "freeze": "0"
    },
    "BTT": {
      "available": "0",
      "freeze": "0"
    },
    "DASH": {
      "available": "0",
      "freeze": "0"
    },
    "DBTC": {
      "available": "0.47",
      "freeze": "0"
    },
    "ETH": {
      "available": "0.0000059",
      "freeze": "0"
    },
    "EUR": {
      "available": "0.00155901",
      "freeze": "0"
    }
  }
}

Create limit order

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/order/new

This endpoint creates limit trading order.

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
marketStringYesAvailable market. Example: BTC_USDT
sideStringYesOrder type. Variables: ‘buy’ / ‘sell’ Example: ‘buy’
amountStringYesAmount of stock currency to buy or sell. Example: ‘0.001’
priceStringYesPrice in money currency. Example: ‘9800’
clientOrderIdStringNoIdentifier should be unique and contain letters, dashes, numbers, dots or underscores. The identifier must be unique.

Request BODY raw:

{
  "market": "BTC_USDT",
  "side": "buy",
  "amount": "0.001",
  "price": "40000",
  "clientOrderId": "order1987111",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

{
  "orderId": 4180284841, // order id
  "clientOrderId": "order1987111", // custom client order id; "clientOrderId": "" - if not specified.
  "market": "BTC_USDT", // deal market
  "side": "buy", // order side
  "type": "limit", // order type
  "timestamp": 1595792396.165973, // timestamp of order creation
  "dealMoney": "0", // if order finished - amount in money currency that finished
  "dealStock": "0", // if order finished - amount in stock currency that finished
  "amount": "0.001", // amount
  "makerFee": "0.001", // maker fee ratio. If the number less than 0.0001 - its rounded to zero
  "takerFee": "0.001", // maker fee ratio. If the number less than 0.0001 - its rounded to zero
  "left": "0.001", // if order not finished - rest of amount that must be finished
  "dealFee": "0", // fee in money that you pay if order is finished
  "price": "40000" // price
}
Errors:
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "amount": ["The amount field is required."],
    "market": ["The market field is required."],
    "price": ["The price field is required."],
    "side": ["The side field is required."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "side": ["The selected side is invalid."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "amount": ["The amount must be a number."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "price": ["The price must be a number."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "market": ["Unknown market."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "amount": ["Not enough balance"]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "amount": ["Given amount is less than min amount 0.0001"],
    "total": ["Total is less than 5.05"]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "clientOrderId": ["The field should be a string."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "clientOrderId": ["The field format should be: «0-9a-z»"]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "clientOrderId": [
      "This client order id is already used by the current account. It will become available in 24 hours (86400 seconds). "
    ]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "amount": [
      "Min amount step = 0.01" //money/stock precision is not taken into consideration when order was submitted
    ]
  }
}

Cancel order

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/order/cancel

This endpoint cancels the existing order.

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
marketStringYesAvailable market. Example: BTC_USDT
orderIdIntYesOrder Id. Example: 4180284841

Request BODY raw:

{
  "market": "BTC_USDT",
  "orderId": 4180284841,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

{
  "amount": "0.001", // amount
  "dealFee": "0", // fee in money that you pay if order is finished
  "dealMoney": "0", // if order finished - amount in money currency that finished
  "dealStock": "0", // if order finished - amount in stock currency that finished
  "left": "0.001", // if order not finished - rest of amount that must be finished
  "makerFee": "0.001", // maker fee ratio. If the number less than 0.0001 - its rounded to zero
  "market": "BTC_USDT", // deal market
  "orderId": 4180284841, // order id
  "clientOrderId": "order1987111", // custom client order id; "clientOrderId": "" - if not specified.
  "price": "9800", // price
  "side": "buy", // order side
  "takerFee": "0.001", // maker fee ratio. If the number less than 0.0001 - its rounded to zero
  "timestamp": 1595792396.165973, // timestamp of order creation
  "type": "limit" // order type
}
Errors:
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "market": ["The market field is required."],
    "orderId": ["The order id field is required."]
  }
}
{
  "code": 2,
  "message": "Inner validation failed",
  "errors": {
    "order_id": ["Unexecuted order was not found."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "market": ["Market is not available"]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "orderId": ["The order id must be an integer."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "market": [
      "The market must be a string.",
      "The market format is invalid.",
      "Market is not available"
    ]
  }
}

Query unexecuted(active) orders

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/orders

This endpoint retrieves unexecuted orders only.

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
marketStringYesAvailable market. Example: BTC_USDT
limitIntNoLIMIT is a special clause used to limit records a particular query can return. Default: 50, Min: 1, Max: 100
offsetIntNoIf you want the request to return entries starting from a particular line, you can use OFFSET clause to tell it where it should start. Default: 0, Min: 0, Max: 10000

Request BODY raw:

{
  "market": "BTC_USDT",
  "offset": 0,
  "limit": 100,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

[
  {
    "orderId": 3686033640, // unexecuted order ID
    "clientOrderId": "order1987111", // custom client order id; "clientOrderId": "" - if not specified.
    "market": "BTC_USDT", // currency market
    "side": "buy", // order side
    "type": "limit", // unexecuted order type
    "timestamp": 1594605801.49815, // timestamp of order creation
    "dealMoney": "0", // executed amount in money
    "dealStock": "0", // executed amount in stock
    "amount": "2.241379", // active order amount
    "takerFee": "0.001", // taker fee ratio. If the number less than 0.0001 - its rounded to zero
    "makerFee": "0.001", // maker fee ratio. If the number less than 0.0001 - its rounded to zero
    "left": "2.241379", // unexecuted amount in stock
    "dealFee": "0", // executed fee by deal
    "price": "60000" // unexecuted order price
  }
]
Errors:
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "market": ["The market field is required."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "market": ["Market is not available"]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit must be an integer."],
    "offset": ["The offset must be an integer."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit may not be greater than 100."],
    "offset": ["The offset may not be greater than 10000."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit must be at least 1."],
    "offset": ["The offset must be at least 0."]
  }
}

Query order history

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/account/order_history

This endpoint retrieves orders history sorted by all markets

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
marketStringNoRequested available market. Example: BTC_USDT
limitIntNoLIMIT is a special clause used to limit records a particular query can return. Default: 50, Min: 1, Max: 100
offsetIntNoIf you want the request to return entries starting from a particular line, you can use OFFSET clause to tell it where it should start. Default: 0, Min: 0, Max: 10000

Request BODY raw:

{
  "offset": 0,
  "limit": 100,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

{
  "success": true,
  "message": "",
  "result": {
    "BTC_USDT": [
      {
        "amount": "0.70326019", // executed order amount
        "price": "0", // executed order price, if executed order type is market it is equal to 0
        "type": "market", // executed order type
        "id": 3711942768, // executed order ID
        "clientOrderId": "order11-23-3", // custom client order ID; "clientOrderId": "" - if not specified.
        "side": "sell", // executed order side
        "ctime": 1594667731.724387, // timestamp of order creation
        "takerFee": "0.001", // taker fee ratio. If the number less than 0.0001 - it is rounded to zero
        "ftime": 1594667731.724403, // executed order finish time
        "makerFee": "0.001", // maker fee ratio. If the number less than 0.0001 - its rounded to zero
        "dealFee": "0", // executed order fee that user pay
        "dealStock": "0.000076", // executed order amount in stock
        "dealMoney": "0.70407996", // executed order amount in money
        "marketName": "BTC_USDT", // market name
        "status": 1 // Order status: either 1 (finished) or 2 (canceled)
      }
    ]
  }
}
Errors:
{
  "success": false,
  "message": {
    "market": ["The market must be a string.", "The market format is invalid."]
  },
  "result": []
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit must be an integer."],
    "offset": ["The offset must be an integer."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit may not be greater than 100."],
    "offset": ["The offset may not be greater than 10000."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit must be at least 1."],
    "offset": ["The offset must be at least 0."]
  }
}

Query executed order history by single market

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/account/executed_history

This endpoint retrieves deals history sorted by single market

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
marketStringYesRequested available market. Example: BTC_USDT
limitIntNoLIMIT is a special clause used to limit records that a particular query can return. Default: 50, Min: 1, Max: 100
offsetIntNoIf you want the request to return entries starting from a particular line, you can use OFFSET clause to tell it where it should start. Default: 0, Min: 0, Max: 10000

Request BODY raw:

{
  "market": "BTC_USDT",
  "offset": 0,
  "limit": 100,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

{
  "success": true,
  "message": "",
  "result": [
    {
      "id": 160305483, // order id
      "clientOrderId": "order1987111", // custom client order id; "clientOrderId": "" - if not specified.
      "time": 1594667731.724403, // timestamp of order creation
      "side": "sell", // Order side "sell" / "buy"
      "role": 2, // Role - 1 - maker, 2 - taker
      "amount": "0.000076", // amount in stock
      "price": "9264.21", // price
      "deal": "0.70407996", // amount in money
      "fee": "0.00070407996" // fee that you pay
    }
  ]
}
Errors:
{
  "success": false,
  "message": {
    "market": ["The market must be a string.", "The market format is invalid."]
  },
  "result": []
}
{
  "success": false,
  "message": {
    "market": ["The market field is required."]
  },
  "result": []
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit may not be greater than 100."],
    "offset": ["The offset may not be greater than 10000."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit must be at least 1."],
    "offset": ["The offset must be at least 0."]
  }
}

Query executed order history by all markets

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/account/executed_history/all

This endpoint retrieves orders history sorted by all markets.

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
limitIntNoLIMIT is a special clause used to limit records a particular query can return. Default: 50, Min: 1, Max: 100
offsetIntNoIf you want the request to return entries starting from a particular line, you can use OFFSET clause to tell it where it should start. Default: 0, Min: 0, Max: 10000

Request BODY raw:

{
  "offset": 0,
  "limit": 100,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

{
  "success": true,
  "message": "",
  "result": {
    "BTC_USDT": [
      {
        "id": 160305483, // order id
        "clientOrderId": "order1987111", // custom client order id; "clientOrderId": "" - if not specified.
        "time": 1594667731.724403, // timestamp of order creation
        "side": "sell", // Order side "sell" / "buy"
        "role": 2, // Role - 1 - maker, 2 - taker
        "amount": "0.000076", // amount in stock
        "price": "9264.21", // price
        "deal": "0.70407996", // amount in money
        "fee": "0.00070407996" // paid fee
      }
    ]
  }
}
Errors:
{
  "success": false,
  "message": {
    "market": ["The market must be a string.", "The market format is invalid."]
  },
  "result": []
}
{
  "success": false,
  "message": {
    "market": ["The market field is required."]
  },
  "result": []
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit may not be greater than 100."],
    "offset": ["The offset may not be greater than 10000."]
  }
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit must be at least 1."],
    "offset": ["The offset must be at least 0."]
  }
}

Query executed order deals

This endpoint is deprecated. Use V4 endpoint instead

POST/api/v1/account/order

This endpoint retrieves more details on order deals history.

❗ Rate limit 1000 requests/10 sec.

Response is cached for: NONE

Parameters:

NameTypeMandatoryDescription
orderIdIntYesOrder ID. Example: 1234
limitIntNoLIMIT is a special clause used to limit records a particular query can return. Default: 50, Min: 1, Max: 100
offsetIntNoIf you want the request to return entries starting from a particular line, you can use OFFSET clause to tell it where it should start. Default: 0, Min: 0, Max: 10000

Request BODY raw:

{
  "orderId": 3135554375,
  "offset": 0,
  "limit": 100,
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}

Response:

Empty response if order is not yours

{
  "success": true,
  "message": "",
  "result": {
    "limit": 50,
    "offset": 0,
    "records": [
      {
        "id": 149156519, // deal id
        "clientOrderId": "order1987111", // custom client order id; "clientOrderId": "" - if not specified.
        "amount": "598", // amount in stock
        "time": 1593342324.613711, // timestamp of order creation
        "dealOrderId": 3134995325, // completed order ID
        "role": 2, // Role - 1 - maker, 2 - taker
        "deal": "0.00419198", // amount in money
        "price": "0.00000701", // price
        "fee": "0.00000419198" // paid fee
      }
    ]
  }
}
Errors:
{
  "success": false,
  "message": {
    "orderId": ["The order id field is required."]
  },
  "result": []
}
{
  "success": false,
  "message": {
    "orderId": ["The order id must be an integer."]
  },
  "result": []
}
{
  "success": false,
  "message": {
    "limit": ["The limit may not be greater than 100."],
    "offset": ["The offset may not be greater than 10000."]
  },
  "result": []
}
{
  "code": 0,
  "message": "Validation failed",
  "errors": {
    "limit": ["The limit must be at least 1."],
    "offset": ["The offset must be at least 0."]
  }
}