v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Block Trade
Matching Engine
Private

Verifies and creates a block trade signature. This is the first step in the block trade workflow - the first party calls this method to generate a signature that must be shared with the second party.

Note: In the API, the direction field is always expressed from the maker's perspective. This means that when you accept a block trade as a taker, the direction shown in the API represents the opposite side of your trade. For example, if you are buying puts as a taker, the API will show the operation as a "sell put" (maker's perspective), and you will be verifying and accepting a "sell put" block trade.

📖 Related Article: Block Trading

Scope: block_trade:read

Try in API console

get/private/verify_block_trade

Query parameters

timestampinteger required

The timestamp (milliseconds since the Unix epoch)

Example:1536569522277

Timestamp, shared with other party (milliseconds since the UNIX epoch)

noncestring required

Nonce

Example:bF1_gfgcsd

Nonce, shared with other party

role'maker' | 'taker' required

Trade role of the user: maker or taker

Describes if user wants to be maker or taker of trades

instrument_namestring

Unique instrument identifier

pricenumber

Price for trade

amountnumber

It represents the requested order size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin.

direction'buy' | 'sell'

Direction: buy, or sell

List of trades for block trade

[
  {
    "instrument_name": "BTC-PERPETUAL"
  }
]

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": {
    "signature": "1565173369982.1M9tO0Q-.z9n9WyZUU5op9pEz6Jtd2CI71QxQMMsCZAexnIfK9HQRT1pKH3clxeIbY7Bqm-yMcWIoE3IfCDPW5VEdiN-6oS0YkKUyXPD500MUf3ULKhfkmH81EZs"
  }
}