Orders

Order management including creation, cancellation, and updates

List trader's orders

get

Returns the authenticated trader's orders using Ed25519 signature authentication.

Authorizations
x-thegrid-signaturestringRequired

Ed25519 signature authentication. All three headers are required for every request:

Header Description
x-thegrid-signature Base64-encoded Ed25519 signature of {timestamp}{METHOD}{path}{body}
x-thegrid-timestamp Unix timestamp in seconds (must be within 30 seconds of server time)
x-thegrid-fingerprint SHA256 hash of your public key (Base64-encoded, padding stripped)

See full authentication docs

Query parameters
market_idstringOptional

Filter by market ID

trader_idstringOptional

Filter by trader ID

instrument_idstringOptional

Filter by instrument ID

sidestring · enumOptional

Filter by order side

Possible values:
statusstring · enumOptional

Filter by order status

Possible values:
start_datetimestring · date-timeOptional

Filter orders submitted at or after this time (ISO8601 or Unix timestamp)

end_datetimestring · date-timeOptional

Filter orders submitted at or before this time (ISO8601 or Unix timestamp)

order_bystring · enumOptional

Field to sort by

Possible values:
order_directionstring · enumOptional

Sort direction

Default: ascPossible values:
nextstringOptional

Cursor for forward pagination. Pass the next_cursor value from a previous response to fetch the next page. Mutually exclusive with prev.

prevstringOptional

Cursor for backward pagination. Pass the prev_cursor value from a previous response to fetch the previous page. Mutually exclusive with next.

limitinteger · max: 100Optional

Number of items to return per page (max: 100)

Default: 50
Responses
chevron-right
200

List of orders

application/json
get
/trading/orders

Place order

post

Create a new order using Ed25519 signature authentication.

Authorizations
x-thegrid-signaturestringRequired

Ed25519 signature authentication. All three headers are required for every request:

Header Description
x-thegrid-signature Base64-encoded Ed25519 signature of {timestamp}{METHOD}{path}{body}
x-thegrid-timestamp Unix timestamp in seconds (must be within 30 seconds of server time)
x-thegrid-fingerprint SHA256 hash of your public key (Base64-encoded, padding stripped)

See full authentication docs

Body
market_idstringRequired

Market identifier where the order will be placed

Example: market_CHAT-PRIME_USD
client_order_idstring · nullableOptional

Optional client-provided order ID for idempotency. Must be unique per account. Duplicate IDs will return a 422 error with message "client_order_id already exists".

Example: my-order-123
sidestring · enumRequired

Order side: "buy" to purchase the instrument, "sell" to sell. Value is normalized to lowercase.

Example: buyPossible values:
typestring · enumRequired

Order type: "limit" executes at specified price or better, "market" executes immediately at best available price. Value is normalized to lowercase.

Example: limitPossible values:
pricestringOptional

Price per unit in quote currency (USD). Required for limit orders, must be omitted for market orders. Must be a positive number >= 0.0001 with at most 4 decimal places (tick size).

Example: 45.50
quantityinteger · min: 1 · max: 100Required

Number of units to buy or sell. Must be a positive integer, maximum 100 per order.

Example: 100
time_in_forcestring · enumOptional

Order duration policy. Value is normalized to lowercase.

  • gtc (Good Till Cancelled): Order remains active until completely filled or manually cancelled
  • ioc (Immediate Or Cancel): Order executes immediately for available quantity, remainder is cancelled
  • fok (Fill Or Kill): Order must be completely filled immediately or entirely cancelled
  • day: Order expires at the end of the trading day if not filled
Default: gtcExample: gtcPossible values:
Responses
post
/trading/orders

Get order details

get

Returns details of a specific order.

Authorizations
x-thegrid-signaturestringRequired

Ed25519 signature authentication. All three headers are required for every request:

Header Description
x-thegrid-signature Base64-encoded Ed25519 signature of {timestamp}{METHOD}{path}{body}
x-thegrid-timestamp Unix timestamp in seconds (must be within 30 seconds of server time)
x-thegrid-fingerprint SHA256 hash of your public key (Base64-encoded, padding stripped)

See full authentication docs

Path parameters
order_idstringRequired

Unique identifier for the order (e.g., "order_TT64AI5BZNLKUFTL")

Responses
chevron-right
200

Order details

application/json
get
/trading/orders/{order_id}

Cancel order

delete

Cancel an order using Ed25519 signature authentication.

Authorizations
x-thegrid-signaturestringRequired

Ed25519 signature authentication. All three headers are required for every request:

Header Description
x-thegrid-signature Base64-encoded Ed25519 signature of {timestamp}{METHOD}{path}{body}
x-thegrid-timestamp Unix timestamp in seconds (must be within 30 seconds of server time)
x-thegrid-fingerprint SHA256 hash of your public key (Base64-encoded, padding stripped)

See full authentication docs

Path parameters
order_idstringRequired

Unique identifier for the order (e.g., "order_TT64AI5BZNLKUFTL")

Responses
delete
/trading/orders/{order_id}

No content

Last updated

Was this helpful?