Skip to main content
GET
/
open-positions
Open Positions API
curl --request GET \
  --url https://api.broker.com/open-positions \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'
"{\n    \"sheets\": [\n        {\n            \"name\": \"Open Positions\",\n            \"blocks\": [\n                {\n                    \"@entity\": \"table\",\n                    \"name\": \"Equity Derivatives Open Positions\",\n                    \"header\": [\n                        \"symbol\",\n                        \"instrument_type\",\n                        \"strike_price\",\n                        \"expiry_date\",\n                        \"buy_date\",\n                        \"exchange\",\n                        \"open_quantity\",\n                        \"average_price\",\n                        \"previous_closing_price\",\n                        \"unrealized_profit_or_loss\"                      \n                    ],\n                    \"rows\": [\n                        [\n                            \"RELIANCE 25-05-2023 - ce - 2500\",\n                            \"OPT\",\n                            \"2500\",\n                            \"1685028600000\",\n                            \"1682436600000\",\n                            \"NSE\",\n                            250,\n                            3.5800,\n                            3.20,\n                            -95\n                        ]\n                    ]\n                },\n                {\n                    \"@entity\": \"table\",\n                    \"name\": \"Currency Derivatives Open Positions\",\n                    \"header\": [ \n                       \"symbol\",\n                        \"instrument_type\",\n                        \"strike_price\",\n                        \"expiry_date\",\n                        \"buy_date\",\n                        \"exchange\",\n                        \"open_quantity\",\n                        \"average_price\",\n                        \"previous_closing_price\",\n                        \"unrealized_profit_or_loss\"                      \n                    ],\n                    \"rows\": [\n                        [\n                            \"USDINR22APRFUT\",\n                            \"FUT\",\n                            \"83.0542\",\n                            \"1682849176000\",\n                            \"1680170776000\",\n                            \"NSE\",\n                            -60000,\n                            82.0000,\n                            82.4500,\n                            -27000\n                        ]\n                    ]\n                }\n                {\n                    \"@entity\": \"table\",\n                    \"name\": \"Commodity Derivatives Open Positions\",\n                    \"header\": [ \n                       \"symbol\",\n                        \"instrument_type\",\n                        \"strike_price\",\n                        \"expiry_date\",\n                        \"buy_date\",\n                        \"exchange\",\n                        \"open_quantity\",\n                        \"average_price\",\n                        \"previous_closing_price\",\n                        \"unrealized_profit_or_loss\"                      \n                    ],\n                    \"rows\": [\n                        [\n                            \"COPPER23APRFUT\",\n                            \"FUT\",\n                            \"9000.0000\",\n                            \"1682849176000\",\n                            \"1680170776000\",\n                            \"MCX\",\n                            -2500,\n                            815.05,\n                            821.45,\n                            -16000  \n                        ]\n                    ]\n                }\n            ]\n        }\n    ]\n}"

Headers

x-api-key
string
required

API key to uniquely identify the API user

x-api-version
string

API version

Authorization
string
required

Authentication token to authorize the request

Query Parameters

as_on_date
string
required

Holdings as on date

Response

200