GETOrder Book API - All Orders

Use Case

Order Book API (All Orders) lets users retrieve all the orders requested in a day by a specific user across all the-platforms with their last updated status.

For example, Order 1 & 2 are placed from Paytm Mobile App and Order 3 & 4 are placed from your custom application. Whenever you try to retrieve orders from your custom application, you get the update for all the 4 orders placed across all the platforms.

Request Attributes

Content Type : JSON

Head

Attribute	Description
x-jwt-token string mandatory	xxxxxx ( The one retrieved from Generate Access Token Steps ) . Can be accessed using: {access_token} or {read_access_token} .

Response Attributes

Content Type : JSON

Body

Attribute	Description
client_id string	Unique customer identification number by PML
txn_type string	The type of transaction that is being executed (Buy / Sell)
exchange string	The exchange which is involved for this specific transaction ( NSE/BSE )
segment string	This describes, to which segment the transaction belongs. (E→ Equity Cash / D→ Equity Derivative)
product string	Type of product (C/I/B/V/M) C ((Cash and Carry / Delivery) Valid only for Segment='E'), I (Intraday (Valid for Segment= E/D)), M (Margin (Valid for Segment='D')) B (Bracket order (Valid for Segment= E/D)), V (Cover Order (Valid for Segment= E/D)),
security_id string	security_id of scrip in NSE / BSE
quantity string	Quantity of stocks to be traded in NSE / BSE
validity string	Validity of the Order, Day/IOC/GTC/GTD DAY - valid for day only IOC - Immediate or cancel, GTC - good till cancel, GTD - good till date
order_type string	LMT - Limit order (order is to be traded at mentioned price), MKT - market order (order is to be traded at market price), SL - Stop loss Limit (trigger which goes into trigger state when market reaches mentioned trigger price). SLM- Stop Loss Market
price string	Price at which order is to be placed
off_mkt_flag string	Boolean Value, default is false Set False for Live Order Set True for AMO (After Market Order)
mkt_type string	NL/OL/AU/SP/A1/A2 Default is NL- normal
order_no string	PML specific order_no.
serial_no string	Serial number specific to PML. This is updated on every order updation
group_id string	Group_id specific to PML
leg_no string	Leg number for multi leg orders like BO, CO
algo_order_no string	Order No. of Bracket Order 1st Leg in case of 2nd/3rd leg of BO. "-1" in case Bracket Order 1st Leg. 0 is default
trigger_price string	Price at which stop loss is to be triggered (mandatory if it is stop loss order)
status string	Describes whether the API request was Success/Failure
exch_order_no string	Exchange Order Number
exch_order_time string	Exchange Order Time
traded_qty string	Quantity of stocks traded in NSE / BSE
remaining_quantity string	Quantities yet to be traded out of the ordered quantities
avg_traded_price string	Average price at which security got traded
reason_description string	Reason behind the current status of the order
pr_abstick_value string	Profit Price
sl_abstick_value string	Stop Loss Price
isin string	The International Securities Identification Number is a code that uniquely identifies a specific security
display_name string	Custom Symbol Name
order_date_time string	Date and time at which order is placed
last_updated_time string	Recent date and time at which order got updated
child_leg_unq_id string	Unique ID of the Child Leg
ref_ltp string	Reference LTP
display_status string	Current status of the order by PML
display_product string	Full name of the product
display_order_type string	Full name of the product type
display_validity string	Fill name of the validity type
error_code string	Internal exception specific codes
tick_size string	Minimum price change between different bid and offer prices of an asset traded on an exchange platform
strategy_id string	Unique Id linked to particular strategy
placed_by string	Displays the Order is Placed By whom?
lot_size string	The no of contracts in a derivative security
strike_price string	Strike Price of option at which it is to be bought/sold
expiry_date string	The expiry date of an option is the date at which option expires
opt_type string	Option Type: Call/Put
instrument string	EQUITY(Cash)/FUTSTK/OPTSTK
channel string	MER_226 is the merchant id (ex- Algomatrix)
Platform string	Placed via Open api
instrument_type string	Script Type like ES= Equity Stock ETF= Exchange Traded Fund FUTIDX= Future Index FUTSTK= Future Stock OPTIDX= Option Index OPTSTK= Option Stock

⇾

Production

https://developer.paytmmoney.com/orders/v1/user/orders

REQUEST

RESPONSE

CURL

curl --location --request GET 'https://developer.paytmmoney.com/orders/v1/user/orders' \
--header 'x-jwt-token: {{JWT-TOKEN}}'