Observe orders

Subscribe to a stream of orders

Query Parameters

marketIds string[]

Market ID to filter for. If empty, no markets will be filtered.

partyIds string[]

Party ID to filter for. If empty, no parties will be filtered.

excludeLiquidity boolean

Indicates whether liquidity orders should be excluded from the stream.

Responses

• 200
• 500
• default

---

A successful response.(streaming responses)

application/json

Schema

Example (from schema)

---

Schema

error object
code int32
details object[]
@type string
message string
result object
snapshot object
An 'initial image' snapshot containing current live orders.
lastPage boolean
orders object[]
List of order data parts.
batchId uint64
createdAt int64
expiresAt int64
id string
liquidityProvisionId string
marketId string
partyId string
peggedOrder object
Pegged order details, used only if the order represents a pegged order.
offset string
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
postOnly boolean
price string
reason OrderError codes are returned in the Order.reason field - If there is an issue with an order during its life-cycle, it will be marked with `status.ORDER_STATUS_REJECTED`
Possible values: [ORDER_ERROR_UNSPECIFIED, ORDER_ERROR_INVALID_MARKET_ID, ORDER_ERROR_INVALID_ORDER_ID, ORDER_ERROR_OUT_OF_SEQUENCE, ORDER_ERROR_INVALID_REMAINING_SIZE, ORDER_ERROR_TIME_FAILURE, ORDER_ERROR_REMOVAL_FAILURE, ORDER_ERROR_INVALID_EXPIRATION_DATETIME, ORDER_ERROR_INVALID_ORDER_REFERENCE, ORDER_ERROR_EDIT_NOT_ALLOWED, ORDER_ERROR_AMEND_FAILURE, ORDER_ERROR_NOT_FOUND, ORDER_ERROR_INVALID_PARTY_ID, ORDER_ERROR_MARKET_CLOSED, ORDER_ERROR_MARGIN_CHECK_FAILED, ORDER_ERROR_MISSING_GENERAL_ACCOUNT, ORDER_ERROR_INTERNAL_ERROR, ORDER_ERROR_INVALID_SIZE, ORDER_ERROR_INVALID_PERSISTENCE, ORDER_ERROR_INVALID_TYPE, ORDER_ERROR_SELF_TRADING, ORDER_ERROR_INSUFFICIENT_FUNDS_TO_PAY_FEES, ORDER_ERROR_INCORRECT_MARKET_TYPE, ORDER_ERROR_INVALID_TIME_IN_FORCE, ORDER_ERROR_CANNOT_SEND_GFN_ORDER_DURING_AN_AUCTION, ORDER_ERROR_CANNOT_SEND_GFA_ORDER_DURING_CONTINUOUS_TRADING, ORDER_ERROR_CANNOT_AMEND_TO_GTT_WITHOUT_EXPIRYAT, ORDER_ERROR_EXPIRYAT_BEFORE_CREATEDAT, ORDER_ERROR_CANNOT_HAVE_GTC_AND_EXPIRYAT, ORDER_ERROR_CANNOT_AMEND_TO_FOK_OR_IOC, ORDER_ERROR_CANNOT_AMEND_TO_GFA_OR_GFN, ORDER_ERROR_CANNOT_AMEND_FROM_GFA_OR_GFN, ORDER_ERROR_CANNOT_SEND_IOC_ORDER_DURING_AUCTION, ORDER_ERROR_CANNOT_SEND_FOK_ORDER_DURING_AUCTION, ORDER_ERROR_MUST_BE_LIMIT_ORDER, ORDER_ERROR_MUST_BE_GTT_OR_GTC, ORDER_ERROR_WITHOUT_REFERENCE_PRICE, ORDER_ERROR_BUY_CANNOT_REFERENCE_BEST_ASK_PRICE, ORDER_ERROR_OFFSET_MUST_BE_GREATER_OR_EQUAL_TO_ZERO, ORDER_ERROR_SELL_CANNOT_REFERENCE_BEST_BID_PRICE, ORDER_ERROR_OFFSET_MUST_BE_GREATER_THAN_ZERO, ORDER_ERROR_INSUFFICIENT_ASSET_BALANCE, ORDER_ERROR_CANNOT_AMEND_PEGGED_ORDER_DETAILS_ON_NON_PEGGED_ORDER, ORDER_ERROR_UNABLE_TO_REPRICE_PEGGED_ORDER, ORDER_ERROR_UNABLE_TO_AMEND_PRICE_ON_PEGGED_ORDER, ORDER_ERROR_NON_PERSISTENT_ORDER_OUT_OF_PRICE_BOUNDS, ORDER_ERROR_TOO_MANY_PEGGED_ORDERS, ORDER_ERROR_POST_ONLY_ORDER_WOULD_TRADE, ORDER_ERROR_REDUCE_ONLY_ORDER_WOULD_NOT_REDUCE_POSITION]
reduceOnly boolean
reference string
remaining uint64
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
size uint64
status Status values for an order
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_EXPIRED, STATUS_CANCELLED, STATUS_STOPPED, STATUS_FILLED, STATUS_REJECTED, STATUS_PARTIALLY_FILLED, STATUS_PARKED]
timeInForce Time in force indicates how long an order will remain active before it is executed or expires. - See OrderTimeInForce
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
updatedAt int64
version uint64
updates object
List of order updates in the last block.
orders object[]
List of orders data.
batchId uint64
createdAt int64
expiresAt int64
id string
liquidityProvisionId string
marketId string
partyId string
peggedOrder object
Pegged order details, used only if the order represents a pegged order.
offset string
reference Pegged reference defines which price point a pegged order is linked to - meaning the price for a pegged order is calculated from the value of the reference price point
Possible values: [PEGGED_REFERENCE_UNSPECIFIED, PEGGED_REFERENCE_MID, PEGGED_REFERENCE_BEST_BID, PEGGED_REFERENCE_BEST_ASK]
postOnly boolean
price string
reason OrderError codes are returned in the Order.reason field - If there is an issue with an order during its life-cycle, it will be marked with `status.ORDER_STATUS_REJECTED`
Possible values: [ORDER_ERROR_UNSPECIFIED, ORDER_ERROR_INVALID_MARKET_ID, ORDER_ERROR_INVALID_ORDER_ID, ORDER_ERROR_OUT_OF_SEQUENCE, ORDER_ERROR_INVALID_REMAINING_SIZE, ORDER_ERROR_TIME_FAILURE, ORDER_ERROR_REMOVAL_FAILURE, ORDER_ERROR_INVALID_EXPIRATION_DATETIME, ORDER_ERROR_INVALID_ORDER_REFERENCE, ORDER_ERROR_EDIT_NOT_ALLOWED, ORDER_ERROR_AMEND_FAILURE, ORDER_ERROR_NOT_FOUND, ORDER_ERROR_INVALID_PARTY_ID, ORDER_ERROR_MARKET_CLOSED, ORDER_ERROR_MARGIN_CHECK_FAILED, ORDER_ERROR_MISSING_GENERAL_ACCOUNT, ORDER_ERROR_INTERNAL_ERROR, ORDER_ERROR_INVALID_SIZE, ORDER_ERROR_INVALID_PERSISTENCE, ORDER_ERROR_INVALID_TYPE, ORDER_ERROR_SELF_TRADING, ORDER_ERROR_INSUFFICIENT_FUNDS_TO_PAY_FEES, ORDER_ERROR_INCORRECT_MARKET_TYPE, ORDER_ERROR_INVALID_TIME_IN_FORCE, ORDER_ERROR_CANNOT_SEND_GFN_ORDER_DURING_AN_AUCTION, ORDER_ERROR_CANNOT_SEND_GFA_ORDER_DURING_CONTINUOUS_TRADING, ORDER_ERROR_CANNOT_AMEND_TO_GTT_WITHOUT_EXPIRYAT, ORDER_ERROR_EXPIRYAT_BEFORE_CREATEDAT, ORDER_ERROR_CANNOT_HAVE_GTC_AND_EXPIRYAT, ORDER_ERROR_CANNOT_AMEND_TO_FOK_OR_IOC, ORDER_ERROR_CANNOT_AMEND_TO_GFA_OR_GFN, ORDER_ERROR_CANNOT_AMEND_FROM_GFA_OR_GFN, ORDER_ERROR_CANNOT_SEND_IOC_ORDER_DURING_AUCTION, ORDER_ERROR_CANNOT_SEND_FOK_ORDER_DURING_AUCTION, ORDER_ERROR_MUST_BE_LIMIT_ORDER, ORDER_ERROR_MUST_BE_GTT_OR_GTC, ORDER_ERROR_WITHOUT_REFERENCE_PRICE, ORDER_ERROR_BUY_CANNOT_REFERENCE_BEST_ASK_PRICE, ORDER_ERROR_OFFSET_MUST_BE_GREATER_OR_EQUAL_TO_ZERO, ORDER_ERROR_SELL_CANNOT_REFERENCE_BEST_BID_PRICE, ORDER_ERROR_OFFSET_MUST_BE_GREATER_THAN_ZERO, ORDER_ERROR_INSUFFICIENT_ASSET_BALANCE, ORDER_ERROR_CANNOT_AMEND_PEGGED_ORDER_DETAILS_ON_NON_PEGGED_ORDER, ORDER_ERROR_UNABLE_TO_REPRICE_PEGGED_ORDER, ORDER_ERROR_UNABLE_TO_AMEND_PRICE_ON_PEGGED_ORDER, ORDER_ERROR_NON_PERSISTENT_ORDER_OUT_OF_PRICE_BOUNDS, ORDER_ERROR_TOO_MANY_PEGGED_ORDERS, ORDER_ERROR_POST_ONLY_ORDER_WOULD_TRADE, ORDER_ERROR_REDUCE_ONLY_ORDER_WOULD_NOT_REDUCE_POSITION]
reduceOnly boolean
reference string
remaining uint64
side Side relates to the direction of an order, to Buy, or Sell
Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]
size uint64
status Status values for an order
Possible values: [STATUS_UNSPECIFIED, STATUS_ACTIVE, STATUS_EXPIRED, STATUS_CANCELLED, STATUS_STOPPED, STATUS_FILLED, STATUS_REJECTED, STATUS_PARTIALLY_FILLED, STATUS_PARKED]
timeInForce Time in force indicates how long an order will remain active before it is executed or expires. - See OrderTimeInForce
Possible values: [TIME_IN_FORCE_UNSPECIFIED, TIME_IN_FORCE_GTC, TIME_IN_FORCE_GTT, TIME_IN_FORCE_IOC, TIME_IN_FORCE_FOK, TIME_IN_FORCE_GFA, TIME_IN_FORCE_GFN]
type Type values for an order
Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]
updatedAt int64
version uint64

{
  "error": {
    "code": 0,
    "details": [
      {
        "@type": "string"
      }
    ],
    "message": "string"
  },
  "result": {
    "snapshot": {
      "lastPage": true,
      "orders": [
        {
          "batchId": "string",
          "createdAt": "string",
          "expiresAt": "string",
          "id": "string",
          "liquidityProvisionId": "string",
          "marketId": "string",
          "partyId": "string",
          "peggedOrder": {
            "offset": "string",
            "reference": "PEGGED_REFERENCE_UNSPECIFIED"
          },
          "postOnly": true,
          "price": "string",
          "reason": "ORDER_ERROR_UNSPECIFIED",
          "reduceOnly": true,
          "reference": "string",
          "remaining": "string",
          "side": "SIDE_UNSPECIFIED",
          "size": "string",
          "status": "STATUS_UNSPECIFIED",
          "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
          "type": "TYPE_UNSPECIFIED",
          "updatedAt": "string",
          "version": "string"
        }
      ]
    },
    "updates": {
      "orders": [
        {
          "batchId": "string",
          "createdAt": "string",
          "expiresAt": "string",
          "id": "string",
          "liquidityProvisionId": "string",
          "marketId": "string",
          "partyId": "string",
          "peggedOrder": {
            "offset": "string",
            "reference": "PEGGED_REFERENCE_UNSPECIFIED"
          },
          "postOnly": true,
          "price": "string",
          "reason": "ORDER_ERROR_UNSPECIFIED",
          "reduceOnly": true,
          "reference": "string",
          "remaining": "string",
          "side": "SIDE_UNSPECIFIED",
          "size": "string",
          "status": "STATUS_UNSPECIFIED",
          "timeInForce": "TIME_IN_FORCE_UNSPECIFIED",
          "type": "TYPE_UNSPECIFIED",
          "updatedAt": "string",
          "version": "string"
        }
      ]
    }
  }
}

An internal server error

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
details object[]
@type string
message string

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

GET /api/v2/stream/orders

Request

Base URL

https://vega-mainnet-data.commodum.io

marketIds — query

partyIds — query

excludeLiquidity — query

---truefalse

curl / cURL

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/orders' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/orders' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/orders' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'https://vega-mainnet-data.commodum.io/api/v2/stream/orders' \
-H 'Accept: application/json'