Observe orders
Subscribe to a stream of orders
Query Parameters
marketIds string[]
Restrict orders to those placed on the given markets.
partyIds string[]
Restrict orders to those placed on the by the given parties.
excludeLiquidity boolean
Whether liquidity orders should be excluded from the stream. If not set, liquidity orders will be included.
Responses
- 200
- 500
- default
A successful response.(streaming responses)
application/json
Schema
Example (from schema)
Schema
error object
result object
{
"error": {
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
},
"result": {
"snapshot": {
"lastPage": true,
"orders": [
{
"batchId": "string",
"createdAt": "string",
"expiresAt": "string",
"icebergOrder": {
"minimumVisibleSize": "string",
"peakSize": "string",
"reservedRemaining": "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",
"icebergOrder": {
"minimumVisibleSize": "string",
"peakSize": "string",
"reservedRemaining": "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[]
message string
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
An unexpected error response.
application/json
Schema
Example (from schema)
Schema
code int32
details object[]
message string
{
"code": 0,
"details": [
{
"@type": "string"
}
],
"message": "string"
}
GET /api/v2/stream/orders
Request
Request
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'