Get orders

curl --request GET \
  --url https://api.orderly.org/v1/admin/orders \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'

import requests

url = "https://api.orderly.org/v1/admin/orders"

headers = {
    "orderly-timestamp": "<orderly-timestamp>",
    "orderly-account-id": "<orderly-account-id>",
    "orderly-key": "<orderly-key>",
    "orderly-signature": "<orderly-signature>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'orderly-timestamp': '<orderly-timestamp>',
    'orderly-account-id': '<orderly-account-id>',
    'orderly-key': '<orderly-key>',
    'orderly-signature': '<orderly-signature>'
  }
};

fetch('https://api.orderly.org/v1/admin/orders', 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://api.orderly.org/v1/admin/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "orderly-account-id: <orderly-account-id>",
    "orderly-key: <orderly-key>",
    "orderly-signature: <orderly-signature>",
    "orderly-timestamp: <orderly-timestamp>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.orderly.org/v1/admin/orders"

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

	req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
	req.Header.Add("orderly-account-id", "<orderly-account-id>")
	req.Header.Add("orderly-key", "<orderly-key>")
	req.Header.Add("orderly-signature", "<orderly-signature>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.orderly.org/v1/admin/orders")
  .header("orderly-timestamp", "<orderly-timestamp>")
  .header("orderly-account-id", "<orderly-account-id>")
  .header("orderly-key", "<orderly-key>")
  .header("orderly-signature", "<orderly-signature>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/admin/orders")

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

request = Net::HTTP::Get.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

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

{
  "success": true,
  "data": {
    "meta": {
      "total": 9,
      "records_per_page": 25,
      "current_page": 1
    },
    "rows": [
      {
        "order_id": 78151,
        "user_id": 12345,
        "price": 0.67772,
        "type": "LIMIT",
        "quantity": 20,
        "amount": 10,
        "total_executed_quantity": 20,
        "visible_quantity": 1,
        "symbol": "PERP_WOO_USDC",
        "side": "BUY",
        "status": "FILLED",
        "total_fee": 0.5,
        "fee_asset": "WOO",
        "client_order_id": 1,
        "average_executed_price": 0.67772,
        "created_time": 1653563963000,
        "updated_time": 1653564213000,
        "realized_pnl": 0,
        "executed_quantity": 20,
        "visible": 1,
        "executed": 20,
        "reduce_only": null,
        "order_tag": null,
        "margin_mode": "CROSS"
      }
    ]
  },
  "timestamp": 1702989203989
}

GET

admin

orders

Get orders

curl --request GET \
  --url https://api.orderly.org/v1/admin/orders \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'

import requests

url = "https://api.orderly.org/v1/admin/orders"

headers = {
    "orderly-timestamp": "<orderly-timestamp>",
    "orderly-account-id": "<orderly-account-id>",
    "orderly-key": "<orderly-key>",
    "orderly-signature": "<orderly-signature>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'orderly-timestamp': '<orderly-timestamp>',
    'orderly-account-id': '<orderly-account-id>',
    'orderly-key': '<orderly-key>',
    'orderly-signature': '<orderly-signature>'
  }
};

fetch('https://api.orderly.org/v1/admin/orders', 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://api.orderly.org/v1/admin/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "orderly-account-id: <orderly-account-id>",
    "orderly-key: <orderly-key>",
    "orderly-signature: <orderly-signature>",
    "orderly-timestamp: <orderly-timestamp>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.orderly.org/v1/admin/orders"

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

	req.Header.Add("orderly-timestamp", "<orderly-timestamp>")
	req.Header.Add("orderly-account-id", "<orderly-account-id>")
	req.Header.Add("orderly-key", "<orderly-key>")
	req.Header.Add("orderly-signature", "<orderly-signature>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.orderly.org/v1/admin/orders")
  .header("orderly-timestamp", "<orderly-timestamp>")
  .header("orderly-account-id", "<orderly-account-id>")
  .header("orderly-key", "<orderly-key>")
  .header("orderly-signature", "<orderly-signature>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orderly.org/v1/admin/orders")

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

request = Net::HTTP::Get.new(url)
request["orderly-timestamp"] = '<orderly-timestamp>'
request["orderly-account-id"] = '<orderly-account-id>'
request["orderly-key"] = '<orderly-key>'
request["orderly-signature"] = '<orderly-signature>'

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

{
  "success": true,
  "data": {
    "meta": {
      "total": 9,
      "records_per_page": 25,
      "current_page": 1
    },
    "rows": [
      {
        "order_id": 78151,
        "user_id": 12345,
        "price": 0.67772,
        "type": "LIMIT",
        "quantity": 20,
        "amount": 10,
        "total_executed_quantity": 20,
        "visible_quantity": 1,
        "symbol": "PERP_WOO_USDC",
        "side": "BUY",
        "status": "FILLED",
        "total_fee": 0.5,
        "fee_asset": "WOO",
        "client_order_id": 1,
        "average_executed_price": 0.67772,
        "created_time": 1653563963000,
        "updated_time": 1653564213000,
        "realized_pnl": 0,
        "executed_quantity": 20,
        "visible": 1,
        "executed": 20,
        "reduce_only": null,
        "order_tag": null,
        "margin_mode": "CROSS"
      }
    ]
  },
  "timestamp": 1702989203989
}

Headers

orderly-timestamp

string

required

Timestamp of the signed request in milliseconds.

orderly-account-id

string

required

Account ID of the authenticated account.

orderly-key

string

required

Public orderly key used to sign the request.

orderly-signature

string

required

Signature of the request payload generated with the orderly key.

Query Parameters

symbol

string

Filter results to a specific trading symbol, for example PERP_ETH_USDC.

side

string

BUY/SELL

order_type

string

LIMIT/MARKET

status

string

NEW/CANCELLED/PARTIAL_FILLED/FILLED/REJECTED/INCOMPLETE/COMPLETED

order_tag

string

Filter by a custom tag assigned to the order.

start_t

number

start time range that wish to query, noted the time stamp is 13-digits timestamp.

end_t

number

end time range that wish to query, noted the time stamp is 13-digits timestamp.

page

number

the page you wish to query. start from 1

size

number

the page size you wish to query (max: 500)

sort_by

string

If empty:

Descending order by updated_time if user passed update_start_t or update_end_t; descending order by order_id if updated_time are the same;

Otherwise descending order by created_time; descending order by order_id if created_time are the same;

If not empty:

If sort_by == CREATED_TIME_DESC, descending order by created_time. Descending order by order_id if created_time are same;

If sort_by == CREATED_TIME_ASC, ascending order by created_time. Ascending order by order_id if created_time are same;

If sort_by == UPDATED_TIME_DESC, descending order by updated_time. Descending order by order_id if updated_time are same;

If sort_by == UPDATED_TIME_ASC, ascending order by updated_time. Ascending order by order_id if updated_time are same;

user_account

string

Target user account to query for admin usage, required for either user_account or user_address

user_address

string

Target user address to query for admin usage, required for either user_account or user_address

Response

200 - application/json

success

boolean

required

Indicates whether the request was successful.

Example:

true

data

object

required

Show child attributes

timestamp

integer

Server timestamp in milliseconds.

Example:

1702989203989

Get leverage setting Get one position info

⌘I