private/get_order_state_by_label

Retrieves the state of recent orders that have a specific label. This is useful for tracking orders that share the same label, which is helpful for managing related orders.

Results are filtered by currency and label. The response includes order details such as status, filled amount, remaining amount, and other order properties for all orders with the specified label.

Scope: trade:read

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/get_order_state_by_label \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 4316,
  "method": "private/get_order_state_by_label",
  "params": {
    "currency": "ETH",
    "label": "fooBar"
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/get_order_state_by_label"

payload = {
    "jsonrpc": "2.0",
    "id": 4316,
    "method": "private/get_order_state_by_label",
    "params": {
        "currency": "ETH",
        "label": "fooBar"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 4316,
    method: 'private/get_order_state_by_label',
    params: {currency: 'ETH', label: 'fooBar'}
  })
};

fetch('https://test.deribit.com/api/v2/private/get_order_state_by_label', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/get_order_state_by_label",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 4316,
    'method' => 'private/get_order_state_by_label',
    'params' => [
        'currency' => 'ETH',
        'label' => 'fooBar'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/get_order_state_by_label"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4316,\n  \"method\": \"private/get_order_state_by_label\",\n  \"params\": {\n    \"currency\": \"ETH\",\n    \"label\": \"fooBar\"\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/get_order_state_by_label")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4316,\n  \"method\": \"private/get_order_state_by_label\",\n  \"params\": {\n    \"currency\": \"ETH\",\n    \"label\": \"fooBar\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/get_order_state_by_label")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 4316,\n  \"method\": \"private/get_order_state_by_label\",\n  \"params\": {\n    \"currency\": \"ETH\",\n    \"label\": \"fooBar\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "jsonrpc": "2.0",
  "id": 4316,
  "result": [
    {
      "time_in_force": "good_til_cancelled",
      "reduce_only": false,
      "price": 118.94,
      "post_only": false,
      "order_type": "limit",
      "order_state": "filled",
      "order_id": "ETH-331562",
      "max_show": 37,
      "last_update_timestamp": 1550219810944,
      "label": "fooBar",
      "is_rebalance": false,
      "is_liquidation": false,
      "instrument_name": "ETH-PERPETUAL",
      "filled_amount": 37,
      "direction": "sell",
      "creation_timestamp": 1550219749176,
      "average_price": 118.94,
      "api": false,
      "amount": 37
    }
  ]
}

{
  "jsonrpc": "2.0",
  "message": "<string>",
  "error": 123,
  "id": 123
}

Query Parameters

currency · enum<string> · required

The currency symbol Currency, i.e "BTC", "ETH", "USDC"

Available options: BTC, ETH, USDC, USDT, EURR

label · string · required

user defined label for the order (maximum 64 characters)

Response

200

application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · object[] · required

Hide child attributes

result. order_id · string · required

Unique order identifier

Example:

"ETH-100234"

result. order_state · enum<string> · required

Order state: "open", "filled", "rejected", "cancelled", "untriggered"

Available options: open, filled, rejected, cancelled, untriggered, triggered

result. order_type · enum<string> · required

Order type: "limit", "market", "stop_limit", "stop_market", "take_limit", "take_market", "trailing_stop"

Available options: market, limit, stop_market, stop_limit, take_market, take_limit, trailing_stop

result. time_in_force · enum<string> · required

Order time in force: "good_til_cancelled", "good_til_day", "fill_or_kill" or "immediate_or_cancel"

Available options: good_til_cancelled, good_til_day, fill_or_kill, immediate_or_cancel

result. instrument_name · string · required

Unique instrument identifier

Example:

"BTC-PERPETUAL"

result. creation_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. last_update_timestamp · integer · required

The timestamp (milliseconds since the Unix epoch)

Example:

1536569522277

result. direction · enum<string> · required

Direction: buy, or sell

Available options: buy, sell

result. price · number enum<string> · required

Price in base currency or "market_price" in case of open trigger market orders

result. label · string · required

User defined label (up to 64 characters)

result. post_only · boolean · required

true for post-only orders only

result. api · boolean · required

true if created with API

result. original_order_type · enum<string>

Original order type. Optional field

Available options: market, market_limit

result. is_rebalance · boolean

Optional (only for spot). true if order was automatically created during cross-collateral balance restoration

result. is_liquidation · boolean

Optional (not added for spot). true if order was automatically created during liquidation

result. reject_post_only · boolean

true if order has reject_post_only flag (field is present only when post_only is true)

result. reduce_only · boolean

Optional (not added for spot). 'true for reduce-only orders only'

result. web · boolean

true if created via Deribit frontend (optional)

result. mobile · boolean

Optional field with value true added only when created with Mobile Application

result. refresh_amount · number

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

result. display_amount · number

The actual display amount of iceberg order. Absent for other types of orders.

result. amount · number

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.

result. contracts · number

It represents the order size in contract units. (Optional, may be absent in historical data).

result. filled_amount · number

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.

result. average_price · number

Average fill price of the order

result. advanced · enum<string>

advanced type: "usd" or "implv" (Only for options; field is omitted if not applicable).

Available options: usd, implv

result. implv · number

Implied volatility in percent. (Only if advanced="implv")

result. usd · number

Option price in USD (Only if advanced="usd")

result. triggered · boolean

Whether the trigger order has been triggered

result. trigger · enum<string>

Trigger type (only for trigger orders). Allowed values: "index_price", "mark_price", "last_price".

Available options: index_price, mark_price, last_price

result. trigger_price · number

Trigger price (Only for future trigger orders)

result. trigger_offset · number

The maximum deviation from the price peak beyond which the order will be triggered (Only for trailing trigger orders)

result. trigger_reference_price · number

The price of the given trigger at the time when the order was placed (Only for trailing trigger orders)

result. block_trade · boolean

true if order made from block_trade trade, added only in that case.

Example:

true

result. mmp · boolean

true if the order is a MMP order, otherwise false.

result. risk_reducing · boolean

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.

result. replaced · boolean

true if the order was edited (by user or - in case of advanced options orders - by pricing engine), otherwise false.

result. auto_replaced · boolean

Options, advanced orders only - true if last modification of the order was performed by the pricing engine, otherwise false.

result. quote · boolean

If order is a quote. Present only if true.

result. mmp_group · string

Name of the MMP group supplied in the private/mass_quote request. Only present for quote orders.

result. quote_set_id · string

Identifier of the QuoteSet supplied in the private/mass_quote request. Only present for quote orders.

result. quote_id · string

The same QuoteID as supplied in the private/mass_quote request. Only present for quote orders.

result. trigger_order_id · string

Id of the trigger order that created the order (Only for orders that were created by triggered orders).

Example:

"SLIB-370"

result. combo_order_id · string

Id of the combo order that created this order (only present for orders that were created as legs of a combo order).

Example:

"103148386169"

result. app_name · string

The name of the application that placed the order on behalf of the user (optional).

Example:

"Example Application"

result. mmp_cancelled · boolean

true if order was cancelled by mmp trigger (optional)

Example:

true

result. cancel_reason · enum<string>

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)

Available options: 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

result. oto_order_ids · string[]

The Ids of the orders that will be triggered if the order is filled

Order Id

result. trigger_fill_condition · enum<string>

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.

Available options: first_hit, complete_fill, incremental

result. oco_ref · string

Unique reference that identifies a one_cancels_others (OCO) pair.

result. primary_order_id · string

ID of the order that triggered this order.

Example:

"ETH-100234"

result. is_secondary_oto · boolean

true if the order is an order that can be triggered by another order, otherwise not present.

result. is_primary_otoco · boolean

true if the order is an order that can trigger an OCO pair, otherwise not present.

id · integer

The id that was sent in the request