Modify Regular Order

The Modify Order API enables users to make changes in both open or pending orders within the order book. To execute a modification, users must provide the oms_order_id which can be obtained from the order book. User can modify parameters like price, quantity, order type, and validity. This API facilitates efficient management of orders by allowing users to tailor their orders to meet changing market conditions or trading strategies seamlessly.

Endpoint: api/v1/orders
Method-Type: PUT

Headers

Header Name	Value	Description
x-authorization-token	`<your_access_token>`	Valid JWT token for authentication
x-device-type	`WEB`	The device type (e.g., WEB, ANDROID, IOS)
Content-Type	`application/json`	Format of the request body

Request Packet

{
    "exchange": "NSE",
    "instrument_token": "11915",
    "client_id": "clientId",
    "order_type": "LIMIT",
    "price": 13,
    "quantity": 3,
    "disclosed_quantity": 0,
    "validity": "DAY",
    "product": "CNC",
    "order_side": "BUY",
    "device": "WEB",
    "user_order_id": 1,
    "trigger_price": 0,
    "oms_order_id":"202403111778",
    "execution_type": "REGULAR"
}

Body Params

FieldName	Datatype	Description
exchange	`String`	Name of the exchange where the order is being placed. Possible values include `NSE`, `BSE`, `NFO`, `MCX`
instrument_token	`String`	The unique ID of the financial instrument.
client_id	`String`	Represents the unique id of user.
order_type	`String`	`LIMIT`, `SL`
price	`Float`	If order_type is market, give value 0 else limit price
quantity	`Integer`	Total quantity of the instrument.
disclosed_quantity	`Integer`	hidden quantity from the market
validity	`String`	`DAY` or `IOC`
product	`String`	`CNC`, `MIS`, `NRML`
oms_order_id	`Integer`	Represents the unique id of order given by oms.
trigger_price	`Integer`	specified activation threshold, required in SL or SLM orders
execution_type	`String`	`REGULAR`

Example cURL Request

curl --location --request PUT 'https://algo.pocketful.in/api/v1/orders' \
--header 'Content-Type: application/json' \
--header 'x-authorization-token: <your_access_token>' \
--header 'x-device-type: WEB' \
--data '{
    "exchange": "NSE",
    "instrument_token": "11915",
    "client_id": "clientId",
    "order_type": "LIMIT",
    "price": 13,
    "quantity": 3,
    "disclosed_quantity": 0,
    "validity": "DAY",
    "product": "CNC",
    "order_side": "BUY",
    "device": "WEB",
    "user_order_id": 1,
    "trigger_price": 0,
    "oms_order_id": "202403111778",
    "execution_type": "REGULAR"
}'

Response

{
    "data":{
        "oms_order_id": "202403111778"
    },
    "message": "Order modification request submitted",
    "status": "success"
}

Key	Description
oms_order_id	The ID assigned to the order in the Order Management System.
message	A message indicating the result of the order placement.
status	The status of the operation (success/failure).

Error Response

{
    "data":{
    },
    "error_code": 45010,
    "message": "Something went wrong",
    "status": "error"
}