Get order details

  -X GET
  --header 'Accept: application/json'
  --header 'Authorization: Bearer {token here}'
  'https://api.lime.co/orders/{id}'

Single order response example

{
  "account_number": "12345678@vision",
  "client_id": "20171003209384646",
  "client_order_id": "01HWYX297HG2J9V607VSY4GQ3S",
  "exchange": "Zero Commission",
  "quantity": 1,
  "executed_quantity": 0,
  "order_status": "new",
  "price": 20,
  "time_in_force": "day",
  "order_type": "limit",
  "order_side": "buy",
  "symbol": "BAC",
  "executed_timestamp": 1728924983,
  "tag": "order #12"
}

Multi-leg order request example

{
  "account_number": "ppr00001@demo",
  "client_id": "27577352616",
  "client_order_id": "01JA8H7SQ6HYCPYQPNSGWB8NWH",
  "exchange": "Auto",
  "quantity": 2,
  "executed_quantity": 0,
  "order_status": "new",
  "price": 20,
  "time_in_force": "day",
  "order_type": "limit",
  "order_side": "buy",
  "symbol": "BAC",
  "executed_timestamp": 1729011400,
  "legs": [
    {
      "symbol": "BAC   250117C00032000",
      "quantity": 1,
      "side": "buy"
    },
    {
      "symbol": "BAC   250117C00035000",
      "quantity": 1,
      "side": "sell"
    }
  ],
  "tag": "BAC debit call spread #1"
}

Get the order details by the specified order id.

Request

parameter	description
id	Required. The order id

Response

name	type	description
account_number	string	The account number in the format of 123456578@vision
client_id	string	The order id
client_order_id	string	The client order id
exchange	string	The routing instructions
quantity	number	Positive integer, number of shares, options contracts or multi-leg orders
executed_quantity	number	Positive number of shares or contracts executed by this time
order_status	string	The order status. Possible values are pending_new, new, partially_filled, filled, replaced, done_for_day, pending_cancel, canceled, rejected, suspended
price	number	Limit price if applicable
time_in_force	string	Order duration instructions. Possible values are day - regular hours, ext - extended hours, on-open - opening auction, on-close - closing auction, ioc - immediate or cancel, fok - fill or kill
order_type	string	The order type. Possible values are limit, market
order_side	string	Side of the order. Possible values are buy, sell
symbol	string	The security symbol
executed_timestamp	number	Unix time stamp of the last execution, only populated when an order has been executed, partially or fully
tag	string	Order tag if specified
legs	array	Array of legs in a multi-leg order

Legs array element:

name	type	description
symbol	string	Leg security symbol
quantity	number	Positive integer, leg ratio quantity
side	string	Side of the leg. Available values are buy and sell