Orders

Create a new order

post/v0/orders

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

Changed in 4 of the 44 revisions of this API.26112

  • b819ba3108b3186See the full diff
    • removed the required property details from the response with the 400 status

      response-required-property-removed

    • 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 426 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 400 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 426 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 400 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 426 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 400 status

      response-required-property-added

    • 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 426 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

  • 73ad90aa5d1911See the full diff
    • changed the pattern of the request property colocate_with/items/ from "cont"_[0-9a-zA-Z]+ to cont_[0-9a-zA-Z_-]{1,21}

      request-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 201

      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

  • 60bc3e1c43c074See the full diff
    • added the new required request property end_at

      new-required-request-property

    • added the new required request property price

      new-required-request-property

    • added the new required request property quantity

      new-required-request-property

    • added the new required request property side

      new-required-request-property

    • added the new required request property start_at

      new-required-request-property

    • removed subschema #1: Buy Order subschema #2: Sell Order from the request body oneOf list

      request-body-one-of-removed

    • the request's body type/format changed from / to object/

      request-body-type-changed

    • added the new optional request property cluster

      new-optional-request-property

    • added the new optional request property colocate_with

      new-optional-request-property

    • added the new optional request property flags

      new-optional-request-property

    • added the new optional request property instance_type

      new-optional-request-property

    • removed market-api_ClusterName from the oneOf[subschema #1: Buy Order]/cluster request property oneOf list

      request-property-one-of-removed

    • added market-api_ZoneName to the oneOf[subschema #1: Buy Order]/cluster request property oneOf list

      request-property-one-of-added

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