Block Trades

The block trades API contains private endpoints for querying block trades. It requires a Base64-encoded SHA256 HMAC signature as defined in Authentication.

The endpoint supports the following query parameters:

The endpoint returns a pagination response of the type Pagination<BlockTrade, CursorInfo>. More details on paginated APIs can be found in Pagination. BlockTrade is defined as follows:

For more information on block trades, see Block Trades. For specifics on the status of a block trade, see Block Trade Statuses.

export interface BlockTrade {
  account_id: string;
  block_trade_id: number;
  counterparty_id: string;
  counterparty_email: string | null;
  symbol: string;
  side: Side;
  price: number;
  product_id: number;
  quantity: number;
  exec_time: string;
  report_time: string;
  status: BlockTradeStatus;
  status_reason: string | null;
  status_time: string | null;
}

export type BlockTradeStatus = 'Pending' | 'Canceled' | 'Rejected' | 'Confirmed' | 'Accepted';