Skip to main content
POST
/
v1beta1
/
create_instrument_state_change_subscription
Create Instrument State Change Subscription
curl --request POST \
  --url https://traderapi.us-east-1.privatelink.preprod.polymarketexchange.com/api/v1beta1/create_instrument_state_change_subscription \
  --header 'Content-Type: application/json' \
  --data '
{
  "symbols": [
    "aec-nfl-buf-nyj-2025-01-15"
  ]
}
'
{
  "instruments": [
    {}
  ],
  "resume_token": "aSDinaTvuI8gbWludGxpZnk="
}

Body

application/json

Request to start an instrument state change subscription.

​
symbols
string[]

A list of symbols to filter upon. Optional.

Example:
["aec-nfl-buf-nyj-2025-01-15"]
​
resume_token
string<byte>

Bookmark to resume the subscription if the stream must be restarted.

​
resume_time
string<date-time>

Timestamp from which to resume the subscription if the stream must be restarted.

Response

A successful response (streaming).

Subscription response containing instrument state changes.

​
instruments
object[]

Instrument state changes.

​
resume_token
string<byte>

A resume token that can be used to resume the stream upon a new connection.