Sign in

v2

OpenAPI 3.0.02026-07-311824171.4 MB
Block Trade
Private

Broker Method Returns list of broker block trades. If currency is not provided, returns broker block trades for all currencies.

Scope: block_trade:read

Try in API console

get/private/get_broker_trades

Query parameters

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

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

The currency symbol

countinteger

Number of requested items, default - 20, maximum - 1000

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

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": {
    "history": [
      {
        "trades": [
          {
            "id": "154",
            "timestamp": 1536569522277,
            "trades": [
              {
                "instrument_name": "BTC-PERPETUAL",
                "timestamp": 1517329113791,
                "starbase_timestamp": 1536569522277000000,
                "starbase_order_id": 103148386170,
                "block_trade_id": "154",
                "block_trade_leg_count": 3
              }
            ],
            "app_name": "Example Application",
            "broker_code": "2krM7sJsx",
            "broker_name": "Test Broker"
          }
        ]
      }
    ]
  }
}