> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deribit.com/llms.txt
> Use this file to discover all available pages before exploring further.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.deribit.com/feedback
```json
{
"path": "/subscriptions/user/userorderskindcurrencyinterval",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# user.orders.(kind).(currency).(interval)
> User order updates across all instruments for a given kind and currency (aggregated).
Use this channel to receive private order updates across all matching instruments, aggregated according to `interval`.
## AsyncAPI
````yaml specifications/deribit_asyncapi.json user.orders.(kind).(currency).(interval)
id: user.orders.(kind).(currency).(interval)
title: 'user.orders.(kind).(currency).(interval) '
description: >
User order updates across all instruments for a given kind and currency
(aggregated).
Use this channel to receive private order updates across all matching
instruments, aggregated according to `interval`.
servers:
- id: production
protocol: wss
host: deribit.com/ws/api/v2
bindings: []
variables: []
- id: testnet
protocol: wss
host: test.deribit.com/ws/api/v2
bindings: []
variables: []
address: user.orders.(kind).(currency).(interval)
parameters:
- id: kind
jsonSchema:
type: string
description: >-
Instrument kind
**Allowed values:** `future`, `option`, `spot`, `future_combo`,
`option_combo`
enum:
- future
- option
- spot
- future_combo
- option_combo
description: >-
Instrument kind
**Allowed values:** `future`, `option`, `spot`, `future_combo`,
`option_combo`
type: string
required: true
deprecated: false
- id: currency
jsonSchema:
type: string
description: |-
Currency code or `any` for all
**Allowed values:** `BTC`, `ETH`, `USDC`, `USDT`, `EURR`, `any`
enum:
- BTC
- ETH
- USDC
- USDT
- EURR
- any
description: |-
Currency code or `any` for all
**Allowed values:** `BTC`, `ETH`, `USDC`, `USDT`, `EURR`, `any`
type: string
required: true
deprecated: false
- id: interval
jsonSchema:
type: string
description: >-
Frequency of notifications. Events will be aggregated over this
interval. The value `raw` means no aggregation will be applied **(Please
note that `raw` interval is only available to authorized users)**
**Allowed values:** `raw`, `100ms`, `agg2`
enum:
- raw
- 100ms
- agg2
description: >-
Frequency of notifications. Events will be aggregated over this interval.
The value `raw` means no aggregation will be applied **(Please note that
`raw` interval is only available to authorized users)**
**Allowed values:** `raw`, `100ms`, `agg2`
type: string
required: true
deprecated: false
bindings: []
operations:
- &ref_2
id: send_subscribe_user_orders_kind_currency_interval
title: Send subscribe request for user
description: Client sends subscription request for user updates
type: send
messages:
- &ref_4
id: subscription_message
contentType: application/json
payload:
- name: Subscription Notification Data
description: Server sends subscription notification data
type: object
properties:
- name: data
type: object
required: true
properties:
- name: order_id
type: string
description: Unique order identifier
required: false
- name: order_state
type: string
description: >-
Order state: `"open"`, `"filled"`, `"rejected"`,
`"cancelled"`, `"untriggered"`
enumValues:
- open
- filled
- rejected
- cancelled
- untriggered
- triggered
required: false
- name: order_type
type: string
description: >-
Order type: `"limit"`, `"market"`, `"stop_limit"`,
`"stop_market"`, `"take_limit"`, `"take_market"`,
`"trailing_stop"`
enumValues:
- market
- limit
- stop_market
- stop_limit
- take_market
- take_limit
- trailing_stop
required: false
- name: original_order_type
type: string
description: Original order type. Optional field
enumValues:
- market
- market_limit
required: false
- name: time_in_force
type: string
description: >-
Order time in force: `"good_til_cancelled"`,
`"good_til_day"`, `"fill_or_kill"` or
`"immediate_or_cancel"`
enumValues:
- good_til_cancelled
- good_til_day
- fill_or_kill
- immediate_or_cancel
required: false
- name: is_rebalance
type: boolean
description: >-
Optional (only for spot). `true` if order was
automatically created during cross-collateral balance
restoration
required: false
- name: is_liquidation
type: boolean
description: >-
Optional (not added for spot). `true` if order was
automatically created during liquidation
required: false
- name: instrument_name
type: string
description: Unique instrument identifier
required: false
- name: creation_timestamp
type: integer
description: The timestamp (milliseconds since the Unix epoch)
required: false
- name: last_update_timestamp
type: integer
description: The timestamp (milliseconds since the Unix epoch)
required: false
- name: direction
type: string
description: 'Direction: `buy`, or `sell`'
enumValues:
- buy
- sell
required: false
- name: description
type: string
description: >-
Price in base currency or "market_price" in case of open
trigger market orders
required: false
- name: label
type: string
description: User defined label (up to 64 characters)
required: false
- name: post_only
type: boolean
description: '`true` for post-only orders only'
required: false
- name: reject_post_only
type: boolean
description: >-
`true` if order has `reject_post_only` flag (field is
present only when `post_only` is `true`)
required: false
- name: reduce_only
type: boolean
description: >-
Optional (not added for spot). '`true` for reduce-only
orders only'
required: false
- name: api
type: boolean
description: '`true` if created with API'
required: false
- name: web
type: boolean
description: '`true` if created via Deribit frontend (optional)'
required: false
- name: mobile
type: boolean
description: >-
Optional field with value `true` added only when created
with Mobile Application
required: false
- name: refresh_amount
type: number
description: >-
The initial display amount of iceberg order. Iceberg order
display amount will be refreshed to that value after match
consuming actual display amount. Absent for other types of
orders
required: false
- name: display_amount
type: number
description: >-
The actual display amount of iceberg order. Absent for
other types of orders.
required: false
- name: amount
type: number
description: >-
It represents the requested order size. For perpetual and
inverse futures the amount is in USD units. For options
and linear futures it is the underlying base currency
coin.
required: false
- name: contracts
type: number
description: >-
It represents the order size in contract units. (Optional,
may be absent in historical data).
required: false
- name: filled_amount
type: number
description: >-
Filled amount of the order. For perpetual and futures the
filled_amount is in USD units, for options - in units or
corresponding cryptocurrency contracts, e.g., BTC or ETH.
required: false
- name: average_price
type: number
description: Average fill price of the order
required: false
- name: advanced
type: string
description: >
advanced type: `"usd"` or `"implv"` (Only for options;
field is omitted if not applicable).
enumValues:
- usd
- implv
required: false
- name: implv
type: number
description: >-
Implied volatility in percent. (Only if
`advanced="implv"`)
required: false
- name: usd
type: number
description: Option price in USD (Only if `advanced="usd"`)
required: false
- name: triggered
type: boolean
description: Whether the trigger order has been triggered
required: false
- name: trigger
type: string
description: >-
Trigger type (only for trigger orders). Allowed values:
`"index_price"`, `"mark_price"`, `"last_price"`.
enumValues:
- index_price
- mark_price
- last_price
required: false
- name: trigger_price
type: number
description: Trigger price (Only for future trigger orders)
required: false
- name: trigger_offset
type: number
description: >-
The maximum deviation from the price peak beyond which the
order will be triggered (Only for trailing trigger orders)
required: false
- name: trigger_reference_price
type: number
description: >-
The price of the given trigger at the time when the order
was placed (Only for trailing trigger orders)
required: false
- name: block_trade
type: boolean
description: >-
`true` if order made from block_trade trade, added only in
that case.
required: false
- name: mmp
type: boolean
description: '`true` if the order is a MMP order, otherwise `false`.'
required: false
- name: risk_reducing
type: boolean
description: >-
`true` if the order is marked by the platform as a risk
reducing order (can apply only to orders placed by PM
users), otherwise `false`.
required: false
- name: replaced
type: boolean
description: >-
`true` if the order was edited (by user or - in case of
advanced options orders - by pricing engine), otherwise
`false`.
required: false
- name: auto_replaced
type: boolean
description: >-
Options, advanced orders only - `true` if last
modification of the order was performed by the pricing
engine, otherwise `false`.
required: false
- name: quote
type: boolean
description: If order is a quote. Present only if true.
required: false
- name: mmp_group
type: string
description: >-
Name of the MMP group supplied in the `private/mass_quote`
request. Only present for quote orders.
required: false
- name: quote_set_id
type: string
description: >-
Identifier of the QuoteSet supplied in the
`private/mass_quote` request. Only present for quote
orders.
required: false
- name: quote_id
type: string
description: >-
The same QuoteID as supplied in the `private/mass_quote`
request. Only present for quote orders.
required: false
- name: trigger_order_id
type: string
description: >-
Id of the trigger order that created the order (Only for
orders that were created by triggered orders).
required: false
- name: app_name
type: string
description: >-
The name of the application that placed the order on
behalf of the user (optional).
required: false
- name: mmp_cancelled
type: boolean
description: '`true` if order was cancelled by mmp trigger (optional)'
required: false
- name: cancel_reason
type: string
description: >-
Enumerated reason behind cancel `"user_request"`,
`"autoliquidation"`, `"cancel_on_disconnect"`,
`"risk_mitigation"`, `"pme_risk_reduction"` (portfolio
margining risk reduction), `"pme_account_locked"`
(portfolio margining account locked per currency),
`"position_locked"`, `"mmp_trigger"` (market maker
protection), `"mmp_config_curtailment"` (market maker
configured quantity decreased), `"edit_post_only_reject"`
(cancelled on edit because of `reject_post_only` setting),
`"oco_other_closed"` (the oco order linked to this order
was closed), `"oto_primary_closed"` (the oto primary order
that was going to trigger this order was cancelled),
`"settlement"` (closed because of a settlement)
enumValues:
- user_request
- autoliquidation
- cancel_on_disconnect
- risk_mitigation
- pme_risk_reduction
- pme_account_locked
- position_locked
- mmp_trigger
- mmp_config_curtailment
- edit_post_only_reject
- oco_other_closed
- oto_primary_closed
- settlement
required: false
- name: oto_order_ids
type: object
description: >-
The Ids of the orders that will be triggered if the order
is filled
required: false
properties: []
- name: trigger_fill_condition
type: string
description: >-
The fill condition of the linked order (Only for linked
order types), default: `first_hit`.
- `"first_hit"` - any execution of the primary order
will fully cancel/place all secondary orders.
- `"complete_fill"` - a complete execution (meaning the
primary order no longer exists) will cancel/place the
secondary orders.
- `"incremental"` - any fill of
the primary order will cause proportional partial
cancellation/placement of the secondary order. The amount
that will be subtracted/added to the secondary order will
be rounded down to the contract size.
enumValues:
- first_hit
- complete_fill
- incremental
required: false
- name: oco_ref
type: string
description: >-
Unique reference that identifies a one_cancels_others
(OCO) pair.
required: false
- name: primary_order_id
type: string
description: Unique order identifier
required: false
- name: is_secondary_oto
type: boolean
description: >-
`true` if the order is an order that can be triggered by
another order, otherwise not present.
required: false
- name: is_primary_otoco
type: boolean
description: >-
`true` if the order is an order that can trigger an OCO
pair, otherwise not present.
required: false
headers: []
jsonPayloadSchema:
type: object
description: Response containing notification data
properties:
data:
type: object
description: ''
properties:
order_id:
description: Unique order identifier
type: string
example: ETH-100234
x-parser-schema-id:
order_state:
type: string
description: >-
Order state: `"open"`, `"filled"`, `"rejected"`,
`"cancelled"`, `"untriggered"`
enum:
- open
- filled
- rejected
- cancelled
- untriggered
- triggered
x-parser-schema-id:
order_type:
type: string
description: >-
Order type: `"limit"`, `"market"`, `"stop_limit"`,
`"stop_market"`, `"take_limit"`, `"take_market"`,
`"trailing_stop"`
enum:
- market
- limit
- stop_market
- stop_limit
- take_market
- take_limit
- trailing_stop
x-parser-schema-id:
original_order_type:
type: string
description: Original order type. Optional field
enum:
- market
- market_limit
x-parser-schema-id:
time_in_force:
type: string
description: >-
Order time in force: `"good_til_cancelled"`,
`"good_til_day"`, `"fill_or_kill"` or
`"immediate_or_cancel"`
enum:
- good_til_cancelled
- good_til_day
- fill_or_kill
- immediate_or_cancel
x-parser-schema-id:
is_rebalance:
type: boolean
description: >-
Optional (only for spot). `true` if order was automatically
created during cross-collateral balance restoration
x-parser-schema-id:
is_liquidation:
type: boolean
description: >-
Optional (not added for spot). `true` if order was
automatically created during liquidation
x-parser-schema-id:
instrument_name:
type: string
description: Unique instrument identifier
example: BTC-PERPETUAL
x-parser-schema-id:
creation_timestamp:
type: integer
example: 1536569522277
description: The timestamp (milliseconds since the Unix epoch)
x-parser-schema-id:
last_update_timestamp:
type: integer
example: 1536569522277
description: The timestamp (milliseconds since the Unix epoch)
x-parser-schema-id:
direction:
type: string
description: 'Direction: `buy`, or `sell`'
enum:
- buy
- sell
x-parser-schema-id:
price:
description: >-
Price in base currency or "market_price" in case of open
trigger market orders
x-parser-schema-id:
label:
type: string
description: User defined label (up to 64 characters)
x-parser-schema-id:
post_only:
type: boolean
description: '`true` for post-only orders only'
x-parser-schema-id:
reject_post_only:
description: >-
`true` if order has `reject_post_only` flag (field is
present only when `post_only` is `true`)
type: boolean
x-parser-schema-id:
reduce_only:
type: boolean
description: >-
Optional (not added for spot). '`true` for reduce-only
orders only'
x-parser-schema-id:
api:
type: boolean
description: '`true` if created with API'
x-parser-schema-id:
web:
type: boolean
description: '`true` if created via Deribit frontend (optional)'
x-parser-schema-id:
mobile:
type: boolean
description: >-
Optional field with value `true` added only when created
with Mobile Application
x-parser-schema-id:
refresh_amount:
type: number
description: >-
The initial display amount of iceberg order. Iceberg order
display amount will be refreshed to that value after match
consuming actual display amount. Absent for other types of
orders
x-parser-schema-id:
display_amount:
type: number
description: >-
The actual display amount of iceberg order. Absent for other
types of orders.
x-parser-schema-id:
amount:
type: number
description: >-
It represents the requested order size. For perpetual and
inverse futures the amount is in USD units. For options and
linear futures it is the underlying base currency coin.
x-parser-schema-id:
contracts:
type: number
description: >-
It represents the order size in contract units. (Optional,
may be absent in historical data).
x-parser-schema-id:
filled_amount:
type: number
description: >-
Filled amount of the order. For perpetual and futures the
filled_amount is in USD units, for options - in units or
corresponding cryptocurrency contracts, e.g., BTC or ETH.
x-parser-schema-id:
average_price:
type: number
description: Average fill price of the order
x-parser-schema-id:
advanced:
type: string
description: >
advanced type: `"usd"` or `"implv"` (Only for options; field
is omitted if not applicable).
enum:
- usd
- implv
x-parser-schema-id:
implv:
type: number
description: Implied volatility in percent. (Only if `advanced="implv"`)
x-parser-schema-id:
usd:
type: number
description: Option price in USD (Only if `advanced="usd"`)
x-parser-schema-id:
triggered:
type: boolean
description: Whether the trigger order has been triggered
x-parser-schema-id:
trigger:
type: string
description: >-
Trigger type (only for trigger orders). Allowed values:
`"index_price"`, `"mark_price"`, `"last_price"`.
enum:
- index_price
- mark_price
- last_price
x-parser-schema-id:
trigger_price:
type: number
description: Trigger price (Only for future trigger orders)
x-parser-schema-id:
trigger_offset:
type: number
description: >-
The maximum deviation from the price peak beyond which the
order will be triggered (Only for trailing trigger orders)
x-parser-schema-id:
trigger_reference_price:
type: number
description: >-
The price of the given trigger at the time when the order
was placed (Only for trailing trigger orders)
x-parser-schema-id:
block_trade:
description: >-
`true` if order made from block_trade trade, added only in
that case.
type: boolean
example: true
x-parser-schema-id:
mmp:
type: boolean
description: '`true` if the order is a MMP order, otherwise `false`.'
x-parser-schema-id:
risk_reducing:
type: boolean
description: >-
`true` if the order is marked by the platform as a risk
reducing order (can apply only to orders placed by PM
users), otherwise `false`.
x-parser-schema-id:
replaced:
type: boolean
description: >-
`true` if the order was edited (by user or - in case of
advanced options orders - by pricing engine), otherwise
`false`.
x-parser-schema-id:
auto_replaced:
type: boolean
description: >-
Options, advanced orders only - `true` if last modification
of the order was performed by the pricing engine, otherwise
`false`.
x-parser-schema-id:
quote:
type: boolean
description: If order is a quote. Present only if true.
x-parser-schema-id:
mmp_group:
type: string
description: >-
Name of the MMP group supplied in the `private/mass_quote`
request. Only present for quote orders.
x-parser-schema-id:
quote_set_id:
type: string
description: >-
Identifier of the QuoteSet supplied in the
`private/mass_quote` request. Only present for quote orders.
x-parser-schema-id:
quote_id:
type: string
description: >-
The same QuoteID as supplied in the `private/mass_quote`
request. Only present for quote orders.
x-parser-schema-id:
trigger_order_id:
type: string
description: >-
Id of the trigger order that created the order (Only for
orders that were created by triggered orders).
example: SLIB-370
x-parser-schema-id:
app_name:
type: string
description: >-
The name of the application that placed the order on behalf
of the user (optional).
example: Example Application
x-parser-schema-id:
mmp_cancelled:
type: boolean
description: '`true` if order was cancelled by mmp trigger (optional)'
example: true
x-parser-schema-id:
cancel_reason:
type: string
description: >-
Enumerated reason behind cancel `"user_request"`,
`"autoliquidation"`, `"cancel_on_disconnect"`,
`"risk_mitigation"`, `"pme_risk_reduction"` (portfolio
margining risk reduction), `"pme_account_locked"` (portfolio
margining account locked per currency), `"position_locked"`,
`"mmp_trigger"` (market maker protection),
`"mmp_config_curtailment"` (market maker configured quantity
decreased), `"edit_post_only_reject"` (cancelled on edit
because of `reject_post_only` setting), `"oco_other_closed"`
(the oco order linked to this order was closed),
`"oto_primary_closed"` (the oto primary order that was going
to trigger this order was cancelled), `"settlement"` (closed
because of a settlement)
enum:
- user_request
- autoliquidation
- cancel_on_disconnect
- risk_mitigation
- pme_risk_reduction
- pme_account_locked
- position_locked
- mmp_trigger
- mmp_config_curtailment
- edit_post_only_reject
- oco_other_closed
- oto_primary_closed
- settlement
x-parser-schema-id:
oto_order_ids:
type: object
description: >-
The Ids of the orders that will be triggered if the order is
filled
properties: {}
additionalProperties: true
x-parser-schema-id:
trigger_fill_condition:
description: >-
The fill condition of the linked order (Only for linked
order types), default: `first_hit`.
- `"first_hit"` - any execution of the primary order will
fully cancel/place all secondary orders.
- `"complete_fill"` - a complete execution (meaning the
primary order no longer exists) will cancel/place the
secondary orders.
- `"incremental"` - any fill of the
primary order will cause proportional partial
cancellation/placement of the secondary order. The amount
that will be subtracted/added to the secondary order will be
rounded down to the contract size.
type: string
enum:
- first_hit
- complete_fill
- incremental
x-parser-schema-id:
oco_ref:
type: string
description: >-
Unique reference that identifies a one_cancels_others (OCO)
pair.
x-parser-schema-id:
primary_order_id:
description: Unique order identifier
type: string
example: ETH-100234
x-parser-schema-id:
is_secondary_oto:
type: boolean
description: >-
`true` if the order is an order that can be triggered by
another order, otherwise not present.
x-parser-schema-id:
is_primary_otoco:
type: boolean
description: >-
`true` if the order is an order that can trigger an OCO
pair, otherwise not present.
x-parser-schema-id:
required:
- order_id
- order_state
- order_type
- time_in_force
- instrument_name
- creation_timestamp
- last_update_timestamp
- direction
- price
- label
- post_only
- api
additionalProperties: false
x-parser-schema-id:
required:
- data
additionalProperties: false
x-parser-schema-id:
title: Subscription Notification Data
description: Server sends subscription notification data
example: |-
{
"data": [
{
"time_in_force": "good_til_cancelled",
"reduce_only": false,
"price": 3928.5,
"post_only": false,
"order_type": "limit",
"order_state": "open",
"order_id": "476137",
"max_show": 120,
"last_update_timestamp": 1550826337209,
"label": "",
"is_rebalance": false,
"is_liquidation": false,
"instrument_name": "BTC-PERPETUAL",
"filled_amount": 0,
"direction": "buy",
"creation_timestamp": 1550826337209,
"average_price": 0,
"api": false,
"amount": 120
}
]
}
bindings: []
extensions:
- id: x-parser-unique-object-id
value: subscription_message
bindings: []
extensions: &ref_0
- id: x-parser-unique-object-id
value: user.orders.(kind).(currency).(interval)
- &ref_1
id: receive_user_orders_kind_currency_interval_updates
title: Receive user updates
description: Client receives user update notifications
type: receive
messages:
- &ref_3
id: subscribe_request
contentType: application/json
payload:
- name: Subscription Request
description: >-
Client sends subscription request to subscribe to notification
channel. Please refer to [Notification
page](https://deribit.mintlify.app/articles/notifications) for
more information.
type: object
properties: []
headers: []
jsonPayloadSchema:
properties: {}
additionalProperties: false
x-parser-schema-id:
title: Subscription Request
description: >-
Client sends subscription request to subscribe to notification
channel. Please refer to [Notification
page](https://deribit.mintlify.app/articles/notifications) for more
information.
example: |-
{
"jsonrpc": "2.0",
"method": "public/subscribe",
"id": 42,
"params": {
"channels": [
"user.orders.(kind).(currency).100ms"
]
}
}
bindings: []
extensions:
- id: x-parser-unique-object-id
value: subscribe_request
bindings: []
extensions: *ref_0
sendOperations:
- *ref_1
receiveOperations:
- *ref_2
sendMessages:
- *ref_3
receiveMessages:
- *ref_4
extensions:
- id: x-parser-unique-object-id
value: user.orders.(kind).(currency).(interval)
securitySchemes: []
````