Get an order's current state

GET

/orders/{id}

curl --request GET \
  --url http://localhost:3001/orders/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost:3001/orders/00000000-0000-0000-0000-000000000000"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "http://localhost:3001/orders/00000000-0000-0000-0000-000000000000";

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .headers(headers)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

Authorizations

basic_auth
bearer_token

Parameters

Path Parameters

required

string format: uuid

Order ID

Responses

200

application/json

object

account_id

required

string

avg_px

number format: double

nullable

client_order_id

required

string

cum_qty

required

number format: double

instrument_id

required

string

leaves_qty

required

number format: double

limit_price

number format: double

nullable

order_id

required

string

order_type

required

string

Allowed values: market limit

original_qty

required

number format: double

portfolio_id

required

string

resume_to_status

string

Allowed values: submitted routed partially_filled filled rejected canceled expired suspended

side

required

string

Allowed values: buy sell

status

required

string

Allowed values: submitted routed partially_filled filled rejected canceled expired suspended

time_in_force

required

string

Allowed values: day gtc ioc fok

version

required

integer format: int64

Example

{
  "order_type": "market",
  "resume_to_status": "submitted",
  "side": "buy",
  "status": "submitted",
  "time_in_force": "day"
}

400

Invalid UUID

404

Order not found