PLACE OFS ORDER
This API allows you to place an OFS (Offer For Sale) buy order for a given scrip.
Endpoint: POST /transactional/v1/orders/regular
🔑 Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Content-Type | string | Specifies the media type of the request | application/json |
| x-api-key | string | API key used to authorize the request | {{x-api-key}} |
| Authorization | string | Bearer token for authenticated requests | {{access_token}} |
📑 Request Body Parameters
| Field | Type | Required | Description | Example / Enum |
|---|---|---|---|---|
| scrip_info | object | Yes | Instrument details for the OFS order | Refer below |
| transaction_type | string | Yes | Order side; OFS supports BUY only | "BUY" |
| product_type | string | Yes | Product type; must be OFS for OFS orders | "OFS" |
| order_type | string | Yes | Order type | "RL-MKT" |
| quantity | string | Yes | Number of units to subscribe | "1" |
| price | number | Yes | Price per unit; use 0 for market price (cut-off price) | 0 |
| trigger_price | number | No | Trigger price; pass null for OFS orders | null |
| disclosed_quantity | integer | No | Quantity disclosed to the market | 0 |
| validity | string | No | Order validity; leave empty for OFS orders | "" |
| validity_days | integer | No | Number of validity days for GTD orders | 0 |
| is_amo | boolean | No | AMO (After Market Order) flag; set to false for OFS | false |
| order_identifier | string | No | Custom identifier for the order (max 10 chars) | "" |
| freeze_quantity | integer | No | Freeze quantity limit applicable to the order | 0 |
📘 scrip_info Object Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| exchange | string | Yes | Exchange segment of the OFS instrument | "NSE_OTS" |
| scrip_token | integer | Yes | Exchange token of the OFS instrument | 2885 |
| symbol | string | Yes | Trading symbol of the instrument | "RELIANCE" |
| series | string | Yes | Series of the instrument | "RS" |
| expiry_date | string | No | Expiry date; leave empty for OFS instruments | "" |
| strike_price | string | No | Strike price; leave empty for OFS instruments | "" |
| option_type | string | No | Option type; leave empty for OFS instruments | "" |
🟢 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 Entry Sent to OMS" |
| data | object | Order response payload | Refer to Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example |
|---|---|---|---|
| orderId | string | System-generated OFS order identifier | "NXWAO00026L3" |