PLACE ORDER API
This API allows you to place a fresh buy or sell order for a given client.
🔑 Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Content-Type | string | Specifies the media type of the request | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize the request | {{x-api-key}} |
📑 Request Body Parameters
| Field | Type | Required | Description | Example / Enum |
|---|---|---|---|---|
| client_id | string | No | Client ID for placing order. If empty, order is placed for logged-in user | "CL12345" |
| scrip_info | object | Yes | Scrip details (via token OR full instrument info) | Refer below |
| transaction_type | string | Yes | Order side (BUY/SELL) | "BUY" |
| product_type | string | Yes | Product type of the order | Refer global constants |
| order_type | string | Yes | Order type | Refer global constants |
| quantity | integer | Yes | Number of units to transact | 10 |
| price | number | No | Price per unit | 100.5 |
| trigger_price | number | No | Trigger price for SL orders | 99.5 |
| disclosed_quantity | integer | No | Quantity disclosed to market | 5 |
| validity | string | No | Order validity | "DAY" |
| validity_days | integer | No | Validity for GTD orders | 2 |
| is_amo | boolean | No | AMO order flag | false |
| order_identifier | string | No | Custom identifier (max 10 chars) | "ORD123" |
| part_code | string | No | Participant code | "PC001" |
| algo_id | string | No | Algo ID for strategy orders | "ALG123" |
| strategy_id | string | No | Strategy ID | "STR001" |
| vender_code | string | No | Vendor code for in-house apps | "VEN001" |
📘 Scrip Info Object Fields
| Field | Type | Required | Description | Example / Enum |
|---|---|---|---|---|
| exchange | string | Yes | Exchange segment | "NSE_EQ" |
| scrip_token | integer | No | Exchange token of instrument | 12345 |
| symbol | string | No | Instrument symbol | "RELIANCE" |
| series | string | No | Series (equity only) | "EQ" |
| expiry_date | string | No | Expiry date (YYYY-MM-DD) | "2026-12-31" |
| strike_price | number | No | Strike price (options) | 2500 |
| option_type | string | No | Option type | "CE" |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Status of API call | "success" |
| code | string | Response code to user request | "s-101" |
| message | string | Success message | "Order placed successfully" |
| data | object | Order response payload | Refer to Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example |
|---|---|---|---|
| orderId | string | System-generated order identifier | "ORD00012345" |