Skip to main content
POST
/
v1beta1
/
search_orders
Search Orders
curl --request POST \
  --url https://traderapi.us-east-1.privatelink.preprod.polymarketexchange.com/api/v1beta1/search_orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "accounts": [
    "<string>"
  ],
  "client_account_id": "<string>",
  "client_participant_id": "<string>",
  "clord_id": "<string>",
  "cross_id": "<string>",
  "end_time": "2023-11-07T05:31:56Z",
  "end_transact_trade_date": {
    "day": 123,
    "month": 123,
    "year": 123
  },
  "host_cross_id": "<string>",
  "order_id": "<string>",
  "order_state_filter": "ORDER_STATE_FILTER_UNDEFINED",
  "page_size": 123,
  "page_token": "<string>",
  "parent_order_id": "<string>",
  "side": "SIDE_UNDEFINED",
  "start_time": "2023-11-07T05:31:56Z",
  "start_transact_trade_date": {
    "day": 123,
    "month": 123,
    "year": 123
  },
  "symbol": "<string>",
  "symbol_sub_type": "<string>",
  "type": "ORDER_TYPE_UNDEFINED",
  "with_last_execution": true
}
'
{
  "order": [
    {
      "id": "1ABC2DEF3GHI4",
      "account": "trading-account-456",
      "symbol": "aec-nfl-buf-nyj-2025-01-15",
      "side": "SIDE_BUY",
      "type": "ORDER_TYPE_LIMIT",
      "order_qty": "100",
      "price": "5500",
      "price_scale": "10000",
      "leaves_qty": "50",
      "cum_qty": "50",
      "avg_px": "5500",
      "state": "ORDER_STATE_PARTIALLY_FILLED",
      "time_in_force": "TIME_IN_FORCE_GOOD_TILL_CANCEL",
      "create_time": "2025-01-15T18:30:00Z",
      "insert_time": "2025-01-15T18:30:00Z"
    }
  ],
  "next_page_token": ""
}

Body

application/json

Request to search for orders filtered using the given details.

​
accounts
string[]

Fully qualified resource account names to filter upon (ie: "firms/[firmid]/accounts/[accountid]").

​
client_account_id
string

Client account ID to filter upon.

​
client_participant_id
string

Client participant ID to filter upon.

​
clord_id
string

Client assigned order ID to filter upon.

​
cross_id
string

Client assigned Order Cross ID.

​
end_time
string<date-time>

End time for the orders to be fetched.

​
end_transact_trade_date
object

Date represents a whole or partial calendar date.

​
host_cross_id
string

Exchange generated Host Cross ID.

​
order_id
string

Exchange assigned order ID of the order to filter upon.

​
order_state_filter
enum<string>
default:ORDER_STATE_FILTER_UNDEFINED

OrderStateFilter describes a filter for searching orders that are open or closed.

Available options:
ORDER_STATE_FILTER_UNDEFINED,
ORDER_STATE_FILTER_OPEN,
ORDER_STATE_FILTER_CLOSED,
ORDER_STATE_FILTER_NEW,
ORDER_STATE_FILTER_PARTIALLY_FILLED,
ORDER_STATE_FILTER_FILLED,
ORDER_STATE_FILTER_CANCELED,
ORDER_STATE_FILTER_REPLACED,
ORDER_STATE_FILTER_REJECTED,
ORDER_STATE_FILTER_EXPIRED,
ORDER_STATE_FILTER_PENDING_RISK
​
page_size
integer<int32>

The maximum number of orders to return in a response. This field is optional.

​
page_token
string

A pagination token returned from a previous call to SearchOrdersRequest. that indicates where this listing should continue from. This field is optional.

​
parent_order_id
string

Parent order ID to filter upon.

​
side
enum<string>
default:SIDE_UNDEFINED

Side indicates the side of an Order.

Available options:
SIDE_UNDEFINED,
SIDE_BUY,
SIDE_SELL
​
start_time
string<date-time>

Start time for the orders to be fetched.

​
start_transact_trade_date
object

Date represents a whole or partial calendar date.

​
symbol
string

Instrument symbol to filter upon.

​
symbol_sub_type
string

Symbol sub type to filter upon.

​
type
enum<string>
default:ORDER_TYPE_UNDEFINED

OrderType indicates the type of an order.

  • ORDER_TYPE_MARKET_TO_LIMIT: An order that executes at the current best price. If only partially filled, the remainder is cancelled and reinserted as a LIMIT order with the price equal to the price at which the filled portion of the order executed
  • ORDER_TYPE_LIMIT: An order that will fill only at the specified price or better
  • ORDER_TYPE_STOP: An order that will become active as a MARKET_TO_LIMIT order once a trade has occured at the specified stop price
  • ORDER_TYPE_STOP_LIMIT: An order that will become active as a LIMIT order once a trade has occured at the specified stop price
Available options:
ORDER_TYPE_UNDEFINED,
ORDER_TYPE_MARKET_TO_LIMIT,
ORDER_TYPE_LIMIT,
ORDER_TYPE_STOP,
ORDER_TYPE_STOP_LIMIT
​
with_last_execution
boolean

When true indicates that the response should also return the last execution created that is associated with the matched orders.

Response

A successful response.

​
last_executions
object[]

The list of last executions associated with the returned orders. Will be empty unless with_last_execution is set to true in the request.

​
next_page_token
string

A pagination token returned from a previous call to SearchOrders. that indicates from where listing should continue. This field is optional.

​
order
object[]

List of orders found.