Skip to main content
POST
/
v1beta1
/
create_order_subscription
Create Order Subscription
curl --request POST \
  --url https://traderapi.us-east-1.privatelink.preprod.polymarketexchange.com/api/v1beta1/create_order_subscription \
  --header 'Content-Type: application/json' \
  --data '
{
  "accounts": [
    "<string>"
  ],
  "snapshot_only": true,
  "symbols": [
    "<string>"
  ]
}
'
{
  "error": {
    "code": 123,
    "details": [
      {
        "@type": "<string>"
      }
    ],
    "message": "<string>"
  },
  "result": {
    "heartbeat": {},
    "processed_sent_time": "2023-11-07T05:31:56Z",
    "session_id": "<string>",
    "snapshot": {
      "orders": [
        {
          "account": "trading-account-456",
          "all_or_none": true,
          "avg_px": "<string>",
          "best_limit": true,
          "block_trade_indicator": true,
          "cash_order_qty": "<string>",
          "client_account_id": "<string>",
          "client_participant_id": "<string>",
          "clord_id": "<string>",
          "collateral_memo": "<string>",
          "commission_notional_total_collected": "<string>",
          "commissions_basis_points": "<string>",
          "context": {
            "any_context": {
              "@type": "<string>"
            },
            "fix_context": {
              "begin_string": "<string>",
              "on_behalf_of_comp_id": "<string>",
              "on_behalf_of_sub_id": "<string>",
              "orig_clord_id": "<string>",
              "security_type": "<string>",
              "sender_comp_id": "<string>",
              "sender_location_id": "<string>",
              "sender_sub_id": "<string>",
              "target_comp_id": "<string>",
              "target_location_id": "<string>",
              "target_sub_id": "<string>"
            },
            "service_name": "<string>",
            "validation_contexts": [
              {
                "@type": "<string>"
              }
            ]
          },
          "create_time": "2023-11-07T05:31:56Z",
          "cross_id": "<string>",
          "cum_qty": "<string>",
          "fractional_quantity_scale": "<string>",
          "good_till_time": "2023-11-07T05:31:56Z",
          "host_cross_id": "<string>",
          "id": "<string>",
          "ignore_price_validity_checks": true,
          "immediately_executable_limit": true,
          "insert_time": "2023-11-07T05:31:56Z",
          "last_trade_id": "<string>",
          "last_transact_time": "2023-11-07T05:31:56Z",
          "leaves_qty": "<string>",
          "maker_commissions_basis_points": "<string>",
          "manual_order_indicator": "MANUAL_ORDER_INDICATOR_UNDEFINED",
          "min_qty": "<string>",
          "order_capacity": "ORDER_CAPACITY_UNDEFINED",
          "order_qty": "<string>",
          "parent_order_id": "<string>",
          "participant": "<string>",
          "participate_dont_initiate": true,
          "price": "5500",
          "price_scale": "10000",
          "price_to_quantity_filled": {},
          "priority_weight": "<string>",
          "risk_check_time": "2023-11-07T05:31:56Z",
          "self_match_prevention_instruction": "SELF_MATCH_PREVENTION_INSTRUCTION_UNDEFINED",
          "side": "SIDE_UNDEFINED",
          "state": "ORDER_STATE_NEW",
          "stop_price": "<string>",
          "strict_limit": true,
          "submitting_participant": "<string>",
          "symbol": "aec-nfl-buf-nyj-2025-01-15",
          "symbol_sub_type": "<string>",
          "time_in_force": "TIME_IN_FORCE_UNDEFINED",
          "transaction_booked_time": "2023-11-07T05:31:56Z",
          "trigger_method": "CONDITION_TRIGGER_METHOD_UNDEFINED",
          "type": "ORDER_TYPE_UNDEFINED"
        }
      ]
    },
    "update": {
      "cancel_reject": {
        "clord_id": "<string>",
        "is_replace": true,
        "order_id": "<string>",
        "reject_reason": "CXL_REJ_REASON_EXCHANGE_OPTION",
        "text": "<string>",
        "transact_time": "2023-11-07T05:31:56Z"
      },
      "executions": [
        {
          "aggressor": true,
          "commission_notional_collected": "<string>",
          "commission_spread_px": "<string>",
          "id": "<string>",
          "last_px": "<string>",
          "last_shares": "<string>",
          "leg_prices": [
            {
              "anchor": true,
              "px": "<string>",
              "qty": "<string>",
              "reference_px": "<string>",
              "side": "SIDE_UNDEFINED",
              "symbol": "<string>"
            }
          ],
          "order": {
            "account": "trading-account-456",
            "all_or_none": true,
            "avg_px": "<string>",
            "best_limit": true,
            "block_trade_indicator": true,
            "cash_order_qty": "<string>",
            "client_account_id": "<string>",
            "client_participant_id": "<string>",
            "clord_id": "<string>",
            "collateral_memo": "<string>",
            "commission_notional_total_collected": "<string>",
            "commissions_basis_points": "<string>",
            "context": {
              "any_context": {
                "@type": "<string>"
              },
              "fix_context": {
                "begin_string": "<string>",
                "on_behalf_of_comp_id": "<string>",
                "on_behalf_of_sub_id": "<string>",
                "orig_clord_id": "<string>",
                "security_type": "<string>",
                "sender_comp_id": "<string>",
                "sender_location_id": "<string>",
                "sender_sub_id": "<string>",
                "target_comp_id": "<string>",
                "target_location_id": "<string>",
                "target_sub_id": "<string>"
              },
              "service_name": "<string>",
              "validation_contexts": [
                {
                  "@type": "<string>"
                }
              ]
            },
            "create_time": "2023-11-07T05:31:56Z",
            "cross_id": "<string>",
            "cum_qty": "<string>",
            "fractional_quantity_scale": "<string>",
            "good_till_time": "2023-11-07T05:31:56Z",
            "host_cross_id": "<string>",
            "id": "<string>",
            "ignore_price_validity_checks": true,
            "immediately_executable_limit": true,
            "insert_time": "2023-11-07T05:31:56Z",
            "last_trade_id": "<string>",
            "last_transact_time": "2023-11-07T05:31:56Z",
            "leaves_qty": "<string>",
            "maker_commissions_basis_points": "<string>",
            "manual_order_indicator": "MANUAL_ORDER_INDICATOR_UNDEFINED",
            "min_qty": "<string>",
            "order_capacity": "ORDER_CAPACITY_UNDEFINED",
            "order_qty": "<string>",
            "parent_order_id": "<string>",
            "participant": "<string>",
            "participate_dont_initiate": true,
            "price": "5500",
            "price_scale": "10000",
            "price_to_quantity_filled": {},
            "priority_weight": "<string>",
            "risk_check_time": "2023-11-07T05:31:56Z",
            "self_match_prevention_instruction": "SELF_MATCH_PREVENTION_INSTRUCTION_UNDEFINED",
            "side": "SIDE_UNDEFINED",
            "state": "ORDER_STATE_NEW",
            "stop_price": "<string>",
            "strict_limit": true,
            "submitting_participant": "<string>",
            "symbol": "aec-nfl-buf-nyj-2025-01-15",
            "symbol_sub_type": "<string>",
            "time_in_force": "TIME_IN_FORCE_UNDEFINED",
            "transaction_booked_time": "2023-11-07T05:31:56Z",
            "trigger_method": "CONDITION_TRIGGER_METHOD_UNDEFINED",
            "type": "ORDER_TYPE_UNDEFINED"
          },
          "order_reject_reason": "ORD_REJECT_REASON_EXCHANGE_OPTION",
          "text": "<string>",
          "trace_id": "<string>",
          "trade_id": "<string>",
          "transact_time": "2023-11-07T05:31:56Z",
          "transact_trade_date": {
            "day": 123,
            "month": 123,
            "year": 123
          },
          "type": "EXECUTION_TYPE_NEW",
          "unsolicited_cancel_reason": "UNSOLICITED_CXL_REASON_UNDEFINED"
        }
      ]
    }
  }
}

Body

application/json

Request to start an order subscription to get snapshots and updates for this session.

accounts
string[]

A list of accounts to filter upon and return in streamed responses. This field is optional.

snapshot_only
boolean

If true, only return the current set of snapshots for working orders and do not keep an open subscription.

symbols
string[]

A list of symbols to filter upon and return in streamed responses. This field is optional.

Response

A successful response.(streaming responses)

error
object
result
object