Order

Get order book

This API provides the list of orders placed by the user. The orders placed by the user is transient for a day and is cleared by the end of the trading session. This API returns all states of the orders, namely, open, pending, and filled ones.

get/v2/order/retrieve-all

Request

  • Base URL: https://api-v2.upstox.com
  • URL: https://api-v2.upstox.com/v2/order/retrieve-all
  • Auth: OAuth 2 (authorization code, authorization URL https://api-v2.upstox.com/v2/login/authorization/dialog, token URL https://api-v2.upstox.com/v2/login/authorization/token)

Response

Successful

status'success' | 'error' | 'partial_success'

Example response

{
  "data": [
    {
      "exchange": "NSE",
      "product": "D",
      "price": 120.01,
      "quantity": 1,
      "status": "Complete",
      "tradingsymbol": "GMR",
      "trading_symbol": "GMR",
      "order_type": "MARKET",
      "validity": "DAY",
      "trigger_price": 120,
      "disclosed_quantity": 1,
      "transaction_type": "BUY",
      "average_price": 120.01,
      "pending_quantity": 1,
      "variety": "SIMPLE",
      "order_timestamp": "23-Apr-2021 14:22:06",
      "exchange_timestamp": "24-Apr-2021 14:22:06",
      "order_ref_id": "udapi-12345abcd"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.