Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Block Trade
Private

Returns a list of the user's block trades. If currency is not provided, returns block trades for all currencies. block_rfq_id can be provided to receive block trades related to that particular Block RFQ.

📖 Related Article: Block Trading

Scope: block_trade:read

Try in API console

get/private/get_block_trades

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR'

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

countinteger

Count of Block Trades returned, maximum - 101

start_idstring

Block trade id

Example:154

Response will contain block trades older than the one provided in this field

end_idstring

Block trade id

Example:154

The id of the oldest block trade to be returned, start_id is required with end_id

block_rfq_idinteger

ID of the Block RFQ

broker_codestring
Example:2krM7sJsx

Broker code to filter block trades. Only broker clients can use broker_code to filter broker block trades. Use any for all block trades.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "id": "154",
      "timestamp": 1536569522277,
      "trades": [
        {
          "instrument_name": "BTC-PERPETUAL",
          "timestamp": 1517329113791,
          "block_trade_id": "154"
        }
      ],
      "app_name": "Example Application",
      "broker_code": "2krM7sJsx",
      "broker_name": "Test Broker"
    }
  ]
}