Orders

Get order details

get/v0/orders/{id}

Path parameters

idstring required
Example:ordr_k3R-nX9vLm7Qp2Yw5Jd8F

Order ID

Response

Order details

object'order' required
idstring required
side'buy' | 'sell' required
status'open' | 'filled' | 'cancelled' | 'rejected' required
instance_typestring required
quantityinteger required
start_atstring date-time required

An ISO 8601 datetime string

end_atstring date-time required

An ISO 8601 datetime string

priceinteger required

Price in cents

executedboolean required
executed_atstring date-time

An ISO 8601 datetime string

execution_priceinteger nullable
cancelledboolean required
cancelled_atstring date-time

An ISO 8601 datetime string

colocate_withMarketApiContractId[]
created_atstring date-time required

An ISO 8601 datetime string

rejectedboolean required
rejected_reasonstring nullable
clusterstring
durationinteger required

Unix timestamp.

Example response

{
  "object": "order",
  "id": "ordr_k3R-nX9vLm7Qp2Yw5Jd8F",
  "instance_type": "h100i",
  "quantity": 4,
  "start_at": "2025-07-11T20:41:37.423Z",
  "end_at": "2025-07-11T20:41:37.423Z",
  "price": 2850000,
  "executed_at": "2025-07-11T20:41:37.423Z",
  "cancelled_at": "2025-07-11T20:41:37.423Z",
  "colocate_with": [
    "cont_k3R-nX9vLm7Qp2Yw5Jd8F"
  ],
  "created_at": "2025-07-11T20:41:37.423Z",
  "cluster": "richmond",
  "duration": 1738972800
}

Changes

Changed in 3 of the 44 revisions of this API.1317

  • b819ba3108b3124See the full diff
    • removed the required property details from the response with the 401 status

      response-required-property-removed

    • removed the required property details from the response with the 403 status

      response-required-property-removed

    • removed the required property details from the response with the 404 status

      response-required-property-removed

    • removed the required property details from the response with the 500 status

      response-required-property-removed

    • removed the required property message from the response with the 401 status

      response-required-property-removed

    • removed the required property message from the response with the 403 status

      response-required-property-removed

    • removed the required property message from the response with the 404 status

      response-required-property-removed

    • removed the required property message from the response with the 500 status

      response-required-property-removed

    • removed the required property type from the response with the 401 status

      response-required-property-removed

    • removed the required property type from the response with the 403 status

      response-required-property-removed

    • removed the required property type from the response with the 404 status

      response-required-property-removed

    • removed the required property type from the response with the 500 status

      response-required-property-removed

    • added the required property error to the response with the 401 status

      response-required-property-added

    • added the required property error to the response with the 403 status

      response-required-property-added

    • added the required property error to the response with the 404 status

      response-required-property-added

    • added the required property error to the response with the 500 status

      response-required-property-added

    This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 73ad90aa5d1912See the full diff
    • changed the pattern of the path request parameter id from "ordr"_[0-9a-zA-Z]+ to ordr_[0-9a-zA-Z_-]{1,21}

      request-parameter-pattern-changed

    • the colocate_with/items/ response's property pattern was changed from "cont"_[0-9a-zA-Z]+ to cont_[0-9a-zA-Z_-]{1,21} for the status 200

      response-property-pattern-changed

    • the id response's property pattern was changed from "ordr"_[0-9a-zA-Z]+ to ordr_[0-9a-zA-Z_-]{1,21} for the status 200

      response-property-pattern-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added market-api_ZoneName to the cluster response property oneOf list for the response status 200

      response-property-one-of-added

    • removed market-api_ClusterName from the cluster response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog