Orders

Create a new order

Changed on
post/v0/orders

Request

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

Headers

Idempotency-Keystring nullable

Optional key to ensure idempotent order creation

Request body

side'sell' | 'buy' required
instance_typestring
quantityinteger required
start_atstring required

A date/time value that can be either "NOW" or an ISO 8601 datetime string

end_atstring required

A date/time value that can be either "NOW" or an ISO 8601 datetime string

priceinteger required

Price in cents

colocate_withMarketApiContractId[]

A contract to colocate with. This overrides the instance_type if specified.

clusterstring

Example request

{
  "instance_type": "h100i",
  "quantity": 10,
  "start_at": "NOW",
  "end_at": "NOW",
  "price": 1600,
  "colocate_with": [
    "cont_k3R-nX9vLm7Qp2Yw5Jd8F"
  ],
  "cluster": "richmond"
}

Response

Order created successfully

object'order' required
status'pending' | 'filled' | 'cancelled' required
idstring required
idempotency_keystring nullable

Example response

{
  "object": "order",
  "status": "pending",
  "id": "order_xyz789",
  "idempotency_key": "key_123"
}

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

    • 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

    • 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 request property / from "cont"_[0-9a-zA-Z]+ to cont_[0-9a-zA-Z_-]{1,21}

    • 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