v3

OpenAPI 3.0.02026-07-31103181312.8 KB

communications

Propose Block Trade

Endpoint for creating a block trade proposal.

post/communications/block-trade-proposals

buyer_user_idstring required

User ID of the buyer

buyer_subtrader_idstring

Subtrader ID of the buyer. Provide either this or buyer_subaccount, not both.

buyer_subaccountinteger

User-managed subaccount number of the buyer (0 for primary, 1-63 for numbered subaccounts). Provide either this or buyer_subtrader_id, not both.

seller_user_idstring required

User ID of the seller

seller_subtrader_idstring

Subtrader ID of the seller. Provide either this or seller_subaccount, not both.

seller_subaccountinteger

User-managed subaccount number of the seller (0 for primary, 1-63 for numbered subaccounts). Provide either this or seller_subtrader_id, not both.

market_tickerstring required

The ticker of the market for this block trade

price_centi_centsinteger required

Price in centi-cents

centicountinteger required

Number of contracts in centicounts

maker_side'yes' | 'no' required

The maker side of the trade

expiration_tsstring date-time required

Expiration time of the proposal

Block trade proposal created successfully

block_trade_proposal_idstring required

The ID of the newly created block trade proposal