Skip to main content

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

HeaderTypeDescriptionExample
Content-TypestringSpecifies the media type of the requestapplication/json
x-api-keystringAPI key used to authorize the request{{x-api-key}}
AuthorizationstringBearer token for authenticated requests{{access_token}}

📑 Request Body Parameters

FieldTypeRequiredDescriptionExample / Enum
scrip_infoobjectYesInstrument details for the OFS orderRefer below
transaction_typestringYesOrder side; OFS supports BUY only"BUY"
product_typestringYesProduct type; must be OFS for OFS orders"OFS"
order_typestringYesOrder type"RL-MKT"
quantitystringYesNumber of units to subscribe"1"
pricenumberYesPrice per unit; use 0 for market price (cut-off price)0
trigger_pricenumberNoTrigger price; pass null for OFS ordersnull
disclosed_quantityintegerNoQuantity disclosed to the market0
validitystringNoOrder validity; leave empty for OFS orders""
validity_daysintegerNoNumber of validity days for GTD orders0
is_amobooleanNoAMO (After Market Order) flag; set to false for OFSfalse
order_identifierstringNoCustom identifier for the order (max 10 chars)""
freeze_quantityintegerNoFreeze quantity limit applicable to the order0

📘 scrip_info Object Fields

FieldTypeRequiredDescriptionExample
exchangestringYesExchange segment of the OFS instrument"NSE_OTS"
scrip_tokenintegerYesExchange token of the OFS instrument2885
symbolstringYesTrading symbol of the instrument"RELIANCE"
seriesstringYesSeries of the instrument"RS"
expiry_datestringNoExpiry date; leave empty for OFS instruments""
strike_pricestringNoStrike price; leave empty for OFS instruments""
option_typestringNoOption type; leave empty for OFS instruments""

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code to user request"s-101"
messagestringSuccess message"Order Entry Sent to OMS"
dataobjectOrder response payloadRefer to Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
orderIdstringSystem-generated OFS order identifier"NXWAO00026L3"