Skip to main content
GET
/
communications
/
block-trade-proposals
Get Block Trade Proposals
curl --request GET \
  --url https://external-api.kalshi.com/trade-api/v2/communications/block-trade-proposals \
  --header 'KALSHI-ACCESS-KEY: <api-key>' \
  --header 'KALSHI-ACCESS-SIGNATURE: <api-key>' \
  --header 'KALSHI-ACCESS-TIMESTAMP: <api-key>'
{
  "block_trade_proposals": [
    {
      "id": "<string>",
      "proposer_user_id": "<string>",
      "buyer_user_id": "<string>",
      "seller_user_id": "<string>",
      "market_ticker": "<string>",
      "price_centi_cents": 123,
      "centicount": 123,
      "expiration_ts": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "created_ts": "2023-11-07T05:31:56Z",
      "updated_ts": "2023-11-07T05:31:56Z",
      "buyer_accepted": true,
      "seller_accepted": true,
      "buyer_subtrader_id": "<string>",
      "seller_subtrader_id": "<string>",
      "buyer_accepted_ts": "2023-11-07T05:31:56Z",
      "seller_accepted_ts": "2023-11-07T05:31:56Z",
      "executed_ts": "2023-11-07T05:31:56Z",
      "buyer_order_id": "<string>",
      "seller_order_id": "<string>"
    }
  ],
  "cursor": "<string>"
}

Authorizations

KALSHI-ACCESS-KEY
string
header
required

Your API key ID

KALSHI-ACCESS-SIGNATURE
string
header
required

RSA-PSS signature of the request

KALSHI-ACCESS-TIMESTAMP
string
header
required

Request timestamp in milliseconds

Query Parameters

cursor
string

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.

market_ticker
string

Filter by market ticker

limit
integer<int32>
default:100

Parameter to specify the number of results per page. Defaults to 100.

Required range: 1 <= x <= 100
status
string

Filter block trade proposals by status

Response

Block trade proposals retrieved successfully

block_trade_proposals
object[]
required

List of block trade proposals

cursor
string

Cursor for pagination to get the next page of results