Skip to main content

Overview

The Open Positions API provides information about all currently open derivative positions held by a user on a specific date. Open positions represent active futures and options contracts that have not yet been closed. This data is essential for Quicko to:
  • Calculate unrealized P&L on active derivative positions
  • Monitor margin requirements and risk exposure
  • Prepare accurate profit/loss statements for tax compliance
  • Track derivative holdings for regulatory reporting

Query Parameters

Your API should accept an as_on_date query parameter to retrieve open positions for a specific date. This allows Quicko to fetch historical snapshots of derivative positions when needed for tax and compliance purposes.
GET /open-positions?as_on_date=YYYY-MM-DD

Response Format

Your API should return open positions data organized by derivative category:

Equity Derivatives

Equity derivatives open positions data should include the following fields:
ParamTypeRequiredDescription
symbolstringYesSymbol or description of the instrument
instrument_typestringYesType, possible values: Futures, Options
strike_pricenumberNoStrike price of the contract
expiry_datenumberNoContract expiry date epoch
buy_datenumberYesBuy date epoch
exchangestringNoExchange where trade is made
open_quantitynumberYesQuantity of units held of the instrument
average_pricenumberYesAverage buy price across all trades
previous_closing_pricenumberYesLast traded price of the instrument
unrealized_profit_or_lossnumberNoUnrealized P&L = (Previous Closing Price - Average Price) × Open Quantity

Currency Derivatives

Currency derivatives open positions data should include the following fields:
ParamTypeRequiredDescription
symbolstringYesSymbol or description of the instrument
instrument_typestringYesType, possible values: Futures, Options
strike_pricenumberNoStrike price of the contract
expiry_datenumberNoContract expiry date epoch
buy_datenumberYesBuy date epoch
exchangestringNoExchange where trade is made
open_quantitynumberYesQuantity of units held of the instrument
average_pricenumberYesAverage buy price across all trades
previous_closing_pricenumberYesLast traded price of the instrument
unrealized_profit_or_lossnumberNoUnrealized P&L = (Previous Closing Price - Average Price) × Open Quantity

Commodity Derivatives

Commodity derivatives open positions data should include the following fields:
ParamTypeRequiredDescription
symbolstringYesSymbol or description of the instrument
instrument_typestringYesType, possible values: Futures, Options
strike_pricenumberNoStrike price of the contract
expiry_datenumberNoContract expiry date epoch
buy_datenumberYesBuy date epoch
exchangestringNoExchange where trade is made
open_quantitynumberYesQuantity of units held of the instrument
average_pricenumberYesAverage buy price across all trades
previous_closing_pricenumberYesLast traded price of the instrument
unrealized_profit_or_lossnumberNoUnrealized P&L = (Previous Closing Price - Average Price) × Open Quantity