v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Block Trade
Private

Provides a list of block trade requests including pending approvals, declined trades, and expired trades. timestamp and nonce received in response can be used with private/approve_block_trade or private/reject_block_trade to approve or reject the pending block trade.

To use the block trade approval feature, an additional API key setting feature called enabled_features: block_trade_approval is required. This key has to be given to the broker/registered partner who performs the trades on behalf of the user for the feature to be active. If the user wants to approve the trade, they must approve it from a different API key that doesn't have this feature enabled.

Only broker clients can use broker_code to query for their broker block trade requests.

📖 Related Article: Block Trading

Scope: block_trade:read

Try in API console

get/private/get_block_trade_requests

Query parameters

broker_codestring
Example:jpqYKgg1

Broker code to filter block trade requests. Only broker clients can use broker_code to query for their executed broker block trades.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request