Private methods require authentication. All requests must include a valid OAuth2 token.
A token can be requested using the /public/auth method.
When using the websockets protocol, the token must be included as a
parameter access_token in the message. When using REST (HTTP
GET), the token may also be passed in the Authorization
header.
The order price in base currency.
When editing an option order with advanced=usd, the field price should be the option price value in USD.
When editing an option order with advanced=implv, the field price should be a value of implied volatility in percentages. For example, price=100, means implied volatility of 100%
in: query name: price required: false schema: type: number - description: >-If true, the order is considered post-only. If the new price would cause the order to be filled immediately (as taker), the price will be changed to be just below or above the spread (accordingly to the original order type).
Only valid in combination with time_in_force=`"good_til_cancelled"`
in: query name: post_only required: false schema: default: true type: boolean - description: >- If `true`, the order is considered reduce-only which is intended to only reduce a current position in: query name: reduce_only required: false schema: default: false type: boolean - description: >-If an order is considered post-only and this field is set to true then the order is put to the order book unmodified or the request is rejected.
Only valid in combination with `"post_only"` set to true
in: query name: reject_post_only required: false schema: default: false type: boolean - description: >- Advanced option order type. If you have posted an advanced option order, it is necessary to re-supply this parameter when editing it (Only for options) in: query name: advanced required: false schema: $ref: '#/components/schemas/advanced' - description: >- Trigger price, required for trigger orders only (Stop-loss or Take-profit orders) in: query name: trigger_price required: false schema: type: number - description: >- The maximum deviation from the price peak beyond which the order will be triggered in: query name: trigger_offset required: false schema: type: number - description: Order MMP flag, only for order_type 'limit' in: query name: mmp required: false schema: default: false type: boolean - description: >- Timestamp, when provided server will start processing request in Matching Engine only before given timestamp, in other cases `timed_out` error will be responded. Remember that the given timestamp should be consistent with the server's time, use /public/time method to obtain current server time. in: query name: valid_until required: false schema: type: integer - description: >- Initial display amount for iceberg order. Has to be at least 100 times minimum amount for instrument and ratio of hidden part vs visible part has to be less than 100 as well. in: query name: display_amount required: false schema: default: 1 type: number requestBody: content: application/json: examples: request: description: JSON-RPC Request Example value: id: 3725 jsonrpc: '2.0' method: private/edit params: advanced: implv amount: 4 order_id: '438994' price: 222 description: JSON-RPC request body responses: '200': $ref: '#/components/responses/PrivateEditResponse' components: schemas: order_id: description: Unique order identifier example: ETH-100234 type: string advanced: description: > advanced type: `"usd"` or `"implv"` (Only for options; field is omitted if not applicable). enum: - usd - implv type: string PrivateEditResponse: properties: id: description: The id that was sent in the request type: integer jsonrpc: description: The JSON-RPC version (2.0) enum: - '2.0' type: string result: properties: order: $ref: '#/components/schemas/order' trades: items: $ref: '#/components/schemas/user_trade' type: array required: - order - trades type: object required: - jsonrpc - result type: object order: properties: advanced: $ref: '#/components/schemas/advanced' amount: $ref: '#/components/schemas/amount' api: $ref: '#/components/schemas/api' app_name: description: >- The name of the application that placed the order on behalf of the user (optional). example: Example Application type: string auto_replaced: description: >- Options, advanced orders only - `true` if last modification of the order was performed by the pricing engine, otherwise `false`. type: boolean average_price: $ref: '#/components/schemas/average_price' block_trade: $ref: '#/components/schemas/block_trade_order' cancel_reason: $ref: '#/components/schemas/cancel_reason' contracts: $ref: '#/components/schemas/contracts' creation_timestamp: $ref: '#/components/schemas/timestamp' direction: $ref: '#/components/schemas/direction' display_amount: $ref: '#/components/schemas/display_amount' filled_amount: $ref: '#/components/schemas/filled_amount' implv: $ref: '#/components/schemas/implv' instrument_name: $ref: '#/components/schemas/instrument_name' is_liquidation: description: >- Optional (not added for spot). `true` if order was automatically created during liquidation type: boolean is_primary_otoco: description: >- `true` if the order is an order that can trigger an OCO pair, otherwise not present. type: boolean is_rebalance: description: >- Optional (only for spot). `true` if order was automatically created during cross-collateral balance restoration type: boolean is_secondary_oto: $ref: '#/components/schemas/is_secondary_oto' label: $ref: '#/components/schemas/label' last_update_timestamp: $ref: '#/components/schemas/timestamp' mmp: description: '`true` if the order is a MMP order, otherwise `false`.' type: boolean mmp_cancelled: description: '`true` if order was cancelled by mmp trigger (optional)' example: true type: boolean mmp_group: description: >- Name of the MMP group supplied in the `private/mass_quote` request. Only present for quote orders. type: string mobile: $ref: '#/components/schemas/mobile' oco_ref: $ref: '#/components/schemas/oco_ref' order_id: $ref: '#/components/schemas/order_id' order_state: $ref: '#/components/schemas/order_state' order_type: $ref: '#/components/schemas/order_type' original_order_type: $ref: '#/components/schemas/original_order_type' oto_order_ids: description: The Ids of the orders that will be triggered if the order is filled items: $ref: '#/components/schemas/order_id' description: Order Id type: array post_only: $ref: '#/components/schemas/post_only' price: $ref: '#/components/schemas/open_order_price' primary_order_id: $ref: '#/components/schemas/order_id' description: ID of the order that triggered this order. quote: description: If order is a quote. Present only if true. type: boolean quote_id: description: >- The same QuoteID as supplied in the `private/mass_quote` request. Only present for quote orders. type: string quote_set_id: description: >- Identifier of the QuoteSet supplied in the `private/mass_quote` request. Only present for quote orders. type: string reduce_only: $ref: '#/components/schemas/reduce_only' refresh_amount: $ref: '#/components/schemas/refresh_amount' reject_post_only: $ref: '#/components/schemas/reject_post_only' replaced: description: >- `true` if the order was edited (by user or - in case of advanced options orders - by pricing engine), otherwise `false`. type: boolean risk_reducing: 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`. type: boolean time_in_force: $ref: '#/components/schemas/time_in_force' trigger: $ref: '#/components/schemas/trigger' trigger_fill_condition: $ref: '#/components/schemas/trigger_fill_condition' trigger_offset: $ref: '#/components/schemas/trigger_offset' trigger_order_id: description: >- Id of the trigger order that created the order (Only for orders that were created by triggered orders). example: SLIB-370 type: string trigger_price: $ref: '#/components/schemas/trigger_price' trigger_reference_price: $ref: '#/components/schemas/trigger_reference_price' triggered: $ref: '#/components/schemas/triggered' usd: $ref: '#/components/schemas/usd' web: $ref: '#/components/schemas/web' required: - order_id - order_state - order_type - time_in_force - instrument_name - creation_timestamp - last_update_timestamp - direction - price - label - post_only - api type: object user_trade: properties: advanced: description: >- Advanced type of user order: `"usd"` or `"implv"` (only for options; omitted if not applicable) enum: - usd - implv type: string amount: description: >- Trade amount. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. type: number api: description: '`true` if user order was created with API' type: boolean block_rfq_id: description: ID of the Block RFQ - when trade was part of the Block RFQ type: integer block_rfq_quote_id: description: ID of the Block RFQ quote - when trade was part of the Block RFQ type: integer block_trade_id: $ref: '#/components/schemas/block_trade_id_in_result' combo_id: description: >- Optional field containing combo instrument name if the trade is a combo trade type: string combo_trade_id: description: >- Optional field containing combo trade identifier if the trade is a combo trade type: number contracts: description: >- Trade size in contract units (optional, may be absent in historical trades) type: number direction: $ref: '#/components/schemas/direction' description: Trade direction of the taker fee: description: User's fee in units of the specified `fee_currency` type: number fee_currency: $ref: '#/components/schemas/currency' index_price: description: Index Price at the moment of trade type: number instrument_name: $ref: '#/components/schemas/instrument_name' iv: description: Option implied volatility for the price (Option only) type: number label: $ref: '#/components/schemas/label_presentation' legs: description: >- Optional field containing leg trades if trade is a combo trade (present when querying for **only** combo trades and in `combo_trades` events) type: array liquidation: description: >- Optional field (only for trades caused by liquidation): `"M"` when maker side of trade was under liquidation, `"T"` when taker side was under liquidation, `"MT"` when both sides of trade were under liquidation enum: - M - T - MT type: string liquidity: description: >- Describes what was role of users order: `"M"` when it was maker order, `"T"` when it was taker order enum: - M - T type: string mark_price: description: Mark Price at the moment of trade type: number matching_id: description: Always `null` type: string mmp: description: '`true` if user order is MMP' type: boolean order_id: description: >- Id of the user order (maker or taker), i.e. subscriber's order id that took part in the trade type: string order_type: description: 'Order type: `"limit`, `"market"`, or `"liquidation"`' enum: - limit - market - liquidation type: string post_only: description: '`true` if user order is post-only' type: string price: $ref: '#/components/schemas/price' description: The price of the trade profit_loss: $ref: '#/components/schemas/profit_loss' quote_id: description: >- QuoteID of the user order (optional, present only for orders placed with `private/mass_quote`) type: string quote_set_id: description: >- QuoteSet of the user order (optional, present only for orders placed with `private/mass_quote`) type: string reduce_only: description: '`true` if user order is reduce-only' type: string risk_reducing: description: >- `true` if user order is marked by the platform as a risk reducing order (can apply only to orders placed by PM users) type: boolean state: $ref: '#/components/schemas/order_state_in_user_trade' tick_direction: $ref: '#/components/schemas/tick_direction' timestamp: $ref: '#/components/schemas/trade_timestamp' trade_allocations: description: >- List of allocations for Block RFQ pre-allocation. Each allocation specifies `user_id`, `amount`, and `fee` for the allocated part of the trade. For broker client allocations, a `client_info` object will be included. items: properties: amount: description: Amount allocated to this user. type: number client_info: description: Optional client allocation info for brokers. properties: client_id: description: >- ID of a client; available to broker. Represents a group of users under a common name. type: integer client_link_id: description: >- ID assigned to a single user in a client; available to broker. type: integer name: description: >- Name of the linked user within the client; available to broker. type: string type: object fee: description: Fee for the allocated part of the trade. type: number user_id: description: >- User ID to which part of the trade is allocated. For brokers the User ID is obstructed. type: integer required: - amount - fee type: object type: array trade_id: $ref: '#/components/schemas/trade_id' trade_seq: $ref: '#/components/schemas/trade_seq' underlying_price: description: Underlying price for implied volatility calculations (Options only) type: number required: - trade_id - trade_seq - instrument_name - timestamp - order_id - matching_id - direction - tick_direction - index_price - price - amount - fee - fee_currency - state - mark_price type: object amount: 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. type: number api: description: '`true` if created with API' type: boolean average_price: description: Average fill price of the order type: number block_trade_order: description: '`true` if order made from block_trade trade, added only in that case.' example: true type: boolean cancel_reason: 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 type: string contracts: description: >- It represents the order size in contract units. (Optional, may be absent in historical data). type: number timestamp: description: The timestamp (milliseconds since the Unix epoch) example: 1536569522277 type: integer direction: description: 'Direction: `buy`, or `sell`' enum: - buy - sell type: string display_amount: description: >- The actual display amount of iceberg order. Absent for other types of orders. type: number filled_amount: 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. type: number implv: description: Implied volatility in percent. (Only if `advanced="implv"`) type: number instrument_name: description: Unique instrument identifier example: BTC-PERPETUAL type: string is_secondary_oto: description: >- `true` if the order is an order that can be triggered by another order, otherwise not present. type: boolean label: description: User defined label (up to 64 characters) type: string mobile: description: >- Optional field with value `true` added only when created with Mobile Application type: boolean oco_ref: description: Unique reference that identifies a one_cancels_others (OCO) pair. type: string order_state: description: >- Order state: `"open"`, `"filled"`, `"rejected"`, `"cancelled"`, `"untriggered"` enum: - open - filled - rejected - cancelled - untriggered - triggered type: string order_type: 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 type: string original_order_type: description: Original order type. Optional field enum: - market - market_limit type: string post_only: description: '`true` for post-only orders only' type: boolean open_order_price: description: >- Price in base currency or "market_price" in case of open trigger market orders oneOf: - type: number - enum: - market_price type: string reduce_only: description: Optional (not added for spot). '`true` for reduce-only orders only' type: boolean refresh_amount: 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 type: number reject_post_only: description: >- `true` if order has `reject_post_only` flag (field is present only when `post_only` is `true`) type: boolean time_in_force: 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 type: string trigger: description: >- Trigger type (only for trigger orders). Allowed values: `"index_price"`, `"mark_price"`, `"last_price"`. enum: - index_price - mark_price - last_price type: string trigger_fill_condition: description: >-The fill condition of the linked order (Only for linked order types), default: `first_hit`.