Orders

Get order details

Changed on
get/v0/orders/{id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

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

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • warning

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

    • info

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

    • info

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