Get Block Trades

Retrieves all block trades where user owns the reporting firm/entity.

GET /rest/block-trade

Get Block Trades

cURL

curl --request GET \
  --url https://api.exchange.fairx.net/rest/block-trade

200

[
  {
    "trade_id": 12345,
    "buyer_trader": "buyerTrader1",
    "seller_trader": "sellerTrader1",
    "reporting_trader": "reportingTrader1",
    "buyer_itm_code": "itmCode1",
    "buyer_ncp_code": "ncpCode1",
    "buyer_fcm_code": "fcmCode1",
    "buyer_firm_code": "firmCode1",
    "seller_itm_code": "itmCode2",
    "seller_ncp_code": "ncpCode2",
    "seller_fcm_code": "fcmCode2",
    "seller_firm_code": "firmCode2",
    "reporting_firm_code": "firmCode1",
    "buyer_entity": "buyerEntity1",
    "seller_entity": "sellerEntity1",
    "buyer_entity_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "seller_entity_uuid": "abcdef12-3456-7890-abcd-ef1234567890",
    "buyer_account": "buyerAccount1",
    "seller_account": "sellerAccount1",
    "reporting_entity": "reportingEntity1",
    "reporting_entity_uuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "broker_code": "brokerCode1",
    "executing_trader": "execTrader1",
    "symbol": "BIPZ30",
    "buyer_client_order_id": "clientOrderBuy1",
    "seller_client_order_id": "clientOrderSell1",
    "transact_timestamp": "2025-01-13T14:30:00Z",
    "sending_timestamp": "2025-01-13T14:29:59Z",
    "trading_session_date": "2025-01-13",
    "handling_inst": "ELECTRONIC",
    "quantity": 100,
    "price": 45000.5,
    "event_type": "FILLED",
    "buyer_fill_id": 98765,
    "seller_fill_id": 98766,
    "buyer_cust_order_capacity": "CTI4",
    "seller_cust_order_capacity": "CTI4",
    "buyer_participant_type": "customer",
    "seller_participant_type": "customer",
    "reported_by_broker": false,
    "placed_by_admin": false,
    "reject_reason": "ERROR",
    "reject_details": "<string>",
    "status": "ACTIVE",
    "last_updated_trading_session_date": "2025-01-13",
    "last_updated_timestamp": "2025-01-13T14:30:05Z",
    "clearing_timestamp": "2025-01-13T14:31:00Z",
    "is_tas_order": true,
    "tick_differential": 5,
    "price_differential": "2.50",
    "effective_price": "45003.00"
  }
]

Response

200

application/json

Successfully retrieved block trades

trade_id · integer<int64>

Example:

12345

buyer_trader · string

Example:

"buyerTrader1"

seller_trader · string

Example:

"sellerTrader1"

reporting_trader · string

Example:

"reportingTrader1"

buyer_itm_code · string

Example:

"itmCode1"

buyer_ncp_code · string

Example:

"ncpCode1"

buyer_fcm_code · string

Example:

"fcmCode1"

buyer_firm_code · string

Example:

"firmCode1"

seller_itm_code · string

Example:

"itmCode2"

seller_ncp_code · string

Example:

"ncpCode2"

seller_fcm_code · string

Example:

"fcmCode2"

seller_firm_code · string

Example:

"firmCode2"

reporting_firm_code · string

Example:

"firmCode1"

buyer_entity · string

Example:

"buyerEntity1"

seller_entity · string

Example:

"sellerEntity1"

buyer_entity_uuid · string

Example:

"123e4567-e89b-12d3-a456-426614174000"

seller_entity_uuid · string

Example:

"abcdef12-3456-7890-abcd-ef1234567890"

buyer_account · string

Example:

"buyerAccount1"

seller_account · string

Example:

"sellerAccount1"

reporting_entity · string

Example:

"reportingEntity1"

reporting_entity_uuid · string

Example:

"f81d4fae-7dec-11d0-a765-00a0c91e6bf6"

broker_code · string

Example:

"brokerCode1"

executing_trader · string

Example:

"execTrader1"

symbol · string

Example:

"BIPZ30"

buyer_client_order_id · string

Example:

"clientOrderBuy1"

seller_client_order_id · string

Example:

"clientOrderSell1"

transact_timestamp · string

Example:

"2025-01-13T14:30:00Z"

sending_timestamp · string

Example:

"2025-01-13T14:29:59Z"

trading_session_date · string<date>

Example:

"2025-01-13"

handling_inst · enum<string>

Available options: DESK, ELECTRONIC, VENDOR_PROVIDED, SPONSORED_ACCESS, PREMIUM_ALGO_TRADING, OTHER, PHONE, DESK_PIT

Example:

"ELECTRONIC"

quantity · integer<int32>

Example:

100

price · string

Example:

45000.5

event_type · enum<string>

Available options: SUBMITTED, REJECTED, CANCELED, REPLACED, FILLED, STOP_TRIGGERED, FILL_CANCELED, FILL_AMENDED, UNKNOWN

Example:

"FILLED"

buyer_fill_id · integer<int64>

Example:

98765

seller_fill_id · integer<int64>

Example:

98766

buyer_cust_order_capacity · enum<string>

Available options: CTI1, CTI2, CTI3, CTI4

Example:

"CTI4"

seller_cust_order_capacity · enum<string>

Available options: CTI1, CTI2, CTI3, CTI4

Example:

"CTI4"

buyer_participant_type · string

Example:

"customer"

seller_participant_type · string

Example:

"customer"

reported_by_broker · boolean

Example:

false

placed_by_admin · boolean

Example:

false

reject_reason · enum<string>

Available options: ERROR, UNKNOWN_INSTRUMENT, UNKNOWN_ACCOUNT, UNKNOWN_TRADER, CL_ORD_ID_IN_USE, QTY_TOO_SMALL, QTY_TOO_LARGE, INVALID_FIELD_VALUE, NOT_ALLOWED_BY_TRADING_STATE, POSITION_LIMIT, PRICE_BAND_OUT_OF_RANGE, PRICE_LIMIT, TRADER_NOT_PERMITTED, POSITION_LIMIT_NOT_SET, UNKNOWN_FIRM, POSITION_DAILY_LIMIT, FIRM_NOT_ALLOW_TRADE_PRODUCT, TAS_INVALID_DIFFERENTIAL, TAS_INVALID_TRADE_TIME, TAS_NO_UNDERLYING_MAPPING, TAS_SETTLEMENT_NOT_AVAILABLE, TAS_TRADE_AFTER_SETTLEMENT

reject_details · string

status · enum<string>

Available options: ACTIVE, CANCELED

Example:

"ACTIVE"

last_updated_trading_session_date · string<date>

Example:

"2025-01-13"

last_updated_timestamp · string

Example:

"2025-01-13T14:30:05Z"

clearing_timestamp · string

Example:

"2025-01-13T14:31:00Z"

is_tas_order · boolean

Indicates whether this is a Trade at Settlement (TAS) order

Example:

true

tick_differential · integer<int64> | null

The price differential in ticks for TAS orders. Only present when is_tas_order is true.

Example:

5

price_differential · string | null

The price differential as a decimal value for TAS orders. This represents the actual price impact of the tick differential. Only present when is_tas_order is true.

Example:

"2.50"

effective_price · string

The effective price of the block trade. For TAS orders, this is calculated from the settlement price plus the price differential.

Example:

"45003.00"