Skip to main content
Version: testnet (v0.73)


An order update in Vega, if active it will be on the order book for the market

type OrderUpdate {
id: ID!
price: String!
timeInForce: OrderTimeInForce!
side: Side!
marketId: ID!
size: String!
remaining: String!
partyId: ID!
createdAt: Timestamp!
expiresAt: Timestamp
status: OrderStatus!
reference: String!
type: OrderType
rejectionReason: OrderRejectionReason
version: String!
updatedAt: Timestamp
peggedOrder: PeggedOrder
liquidityProvisionId: ID
icebergOrder: IcebergOrder

Fields ● ID! non-null scalar

Hash of the order data

OrderUpdate.price ● String! non-null scalar

The worst price the order will trade at (e.g. buy for price or less, sell for price or more) (uint64)

OrderUpdate.timeInForce ● OrderTimeInForce! non-null enum

The timeInForce of order (determines how and if it executes, and whether it persists on the book)

OrderUpdate.side ● Side! non-null enum

Whether the order is to buy or sell

OrderUpdate.marketId ● ID! non-null scalar

The market the order is trading on (probably stored internally as a hash of the market details)

OrderUpdate.size ● String! non-null scalar

Total number of units that may be bought or sold (immutable) (uint64)

OrderUpdate.remaining ● String! non-null scalar

Number of units remaining of the total that have not yet been bought or sold (uint64)

OrderUpdate.partyId ● ID! non-null scalar

The party that placed the order (probably stored internally as the party's public key)

OrderUpdate.createdAt ● Timestamp! non-null scalar

RFC3339Nano formatted date and time for when the order was created (timestamp)

OrderUpdate.expiresAt ● Timestamp scalar

RFC3339Nano expiration time of this order

OrderUpdate.status ● OrderStatus! non-null enum

The status of an order, for example 'Active'

OrderUpdate.reference ● String! non-null scalar

The external reference (if available) for the order

OrderUpdate.type ● OrderType enum

The order type

OrderUpdate.rejectionReason ● OrderRejectionReason enum

Why the order was rejected

OrderUpdate.version ● String! non-null scalar

Version of this order, counts the number of amends

OrderUpdate.updatedAt ● Timestamp scalar

RFC3339Nano time the order was altered

OrderUpdate.peggedOrder ● PeggedOrder object

PeggedOrder contains the details about a pegged order

OrderUpdate.liquidityProvisionId ● ID scalar

The liquidity provision this order was created from

OrderUpdate.icebergOrder ● IcebergOrder object

Details of an iceberg order

Returned by

orders subscription