• Home
  • Products
    • Login
    • Product Info
    • User Guide
    • Pricing
  • Services
    • Stock Brokers
    • Freelancers
  • Help
    • Documentation
    • Knowledge Base
    • FAQ
  • Company
    • About Us
    • Contact Us
    • Terms & Conditions
  • Home
  • Products
    • Login
    • Product Info
    • User Guide
    • Pricing
  • Services
    • Stock Brokers
    • Freelancers
  • Help
    • Documentation
    • Knowledge Base
    • FAQ
  • Company
    • About Us
    • Contact Us
    • Terms & Conditions

AutoTrader Web

home/Documentation/AutoTrader Web
Expand All Collapse All
  • Index
  • Getting Started
  • Portfolio Management System (PMS)
  •  Copy Trading (Master-Child Auto-Copy)
    • Master-Child Copy - Performance
  • PMS vs Master-Child
  • Trading View
  •  Supported Brokers
    • Symphony XTS
    • Zerodha
    • Angel Broking
    • Dhan
    • Aliceblue
    • Fyers
    • Nuvama
    • IIFL
    • Zebu
    • Finvasia
    • Motilal Oswal
    • Kotak
    • Mastertrust
    • Five Paisa
    • Choice Broking
    • FlatTrade
    • Tradejini
    • Upstox
    • SAS Online
    • Profitmart
  •  Client Setup
    • Desktop Client
    • AmiBroker Library
    • Excel Library or Tools
    • Java Library
    • MetaTrader Library
    • C# Library
    • Python Library
    • HTTP REST
  •  User Interface
    • User Registration
    •   Settings
      • General
      • Trading Accounts
      • Pseudo Accounts
      • Group Accounts
      • API Key
    •   AutoTrader
      • Activity
      • Instruments
    •   Trading
      • Summary
      • Positions
      • Orders
      • Margins
      • Holdings
      • Trade
    •   User
      • Account
      • Profile
  •  API (Application Programming Interface)
    • Place Regular Order
    • Place Cover Order
    • Place Bracket Order
    • Place Advanced Order
    • Cancel Order
    • Cancel Child Orders
    • Cancel All Orders
    • Modify Order
    • Modify Order Price
    • Modify Order Quantity
    • Square-off Position
    • Square-off Portfolio
    • Read Orders
    • Read Positions
    • Read Margins
    • Read Holdings
    • Read Portfolio Summary
    • Fetch All Trading Accounts
    • Create or Update Trading Account
    • Validate Trading Account Credentials
    • API Parameters
    • API Rate Limits
    • Email Limits
    • Postman
  • Pricing
  • Precautions
  •  Broker Independence
    • API Functions
    • Pseudo Account
    • Instruments (Trading Symbols)
  • Quantity Multiplier
  • Architecture

Read Portfolio Summary

2335 views February 25, 2021 Pritesh 3

API functions to read portfolio level summary information.

Note: These functions are only available to libraries that use at-desktop client. They help reduce the work of programmers. Other libraries return portfolio as a collection of records & these values can be easily calculated from the collection.

  • AmiBroker
  • MetaTrader
  • Excel

Signatures

/*
* Retrieve portfolio M2M (Position category = DAY).
*/
function getPortfolioMtm(pseudoAccount)

/*
* Retrieve portfolio PNL (Position category = DAY).
*/
function getPortfolioPnl(pseudoAccount)

/*
* Retrieve portfolio position count (Position category = DAY).
*/
function getPortfolioPositionCount(pseudoAccount)

/*
* Retrieve portfolio OPEN position count (Position category = DAY).
*/
function getPortfolioOpenPositionCount(pseudoAccount)

/*
* Retrieve portfolio CLOSED position count (Position category = DAY).
*/
function getPortfolioClosedPositionCount(pseudoAccount)

/*
* Retrieve portfolio open short quantity (Position category = DAY).
*/
function getPortfolioOpenShortQuantity(pseudoAccount)

/*
* Retrieve portfolio open long quantity (Position category = DAY).
*/
function getPortfolioOpenLongQuantity(pseudoAccount)

/*
* Retrieve portfolio M2M (Position category = NET).
*/
function getPortfolioMtmNET(pseudoAccount)

/*
* Retrieve portfolio PNL (Position category = NET).
*/
function getPortfolioPnlNET(pseudoAccount)

/*
* Retrieve portfolio position count (Position category = NET).
*/
function getPortfolioPositionCountNET(pseudoAccount)

/*
* Retrieve portfolio OPEN position count (Position category = NET).
*/
function getPortfolioOpenPositionCountNET(pseudoAccount)

/*
* Retrieve portfolio CLOSED position count (Position category = NET).
*/
function getPortfolioClosedPositionCountNET(pseudoAccount)

/*
* Retrieve portfolio open short quantity (Position category = NET).
*/
function getPortfolioOpenShortQuantityNET(pseudoAccount)

/*
* Retrieve portfolio open long quantity (Position category = NET).
*/
function getPortfolioOpenLongQuantityNET(pseudoAccount)

/*
* Retrieve portfolio order count.
*/
function getPortfolioOrderCount(pseudoAccount)

/*
* Retrieve portfolio "open" order count.
*/
function getPortfolioOpenOrderCount(pseudoAccount)

/*
* Retrieve portfolio "complete" order count.
*/
function getPortfolioCompleteOrderCount(pseudoAccount)

/*
* Retrieve portfolio "cancelled" order count.
*/
function getPortfolioCancelledOrderCount(pseudoAccount)

/*
* Retrieve portfolio "rejected" order count.
*/
function getPortfolioRejectedOrderCount(pseudoAccount)

/*
* Retrieve portfolio "trigger pending" order count.
*/
function getPortfolioTriggerPendingOrderCount(pseudoAccount)

Example

mtm = getPortfolioMtm("XX1234");

pnl = getPortfolioPnl("XX1234");

positionCount = getPortfolioPositionCount("XX1234");

openPositionCount = getPortfolioOpenPositionCount("XX1234");

closedPositionCount = getPortfolioClosedPositionCount("XX1234");

openShortQuantity = getPortfolioOpenShortQuantity("XX1234");

openLongQuantity = getPortfolioOpenLongQuantity("XX1234");

mtmNET = getPortfolioMtmNET("XX1234");

pnlNET = getPortfolioPnlNET("XX1234");

positionCountNET = getPortfolioPositionCountNET("XX1234");

openPositionCountNET = getPortfolioOpenPositionCountNET("XX1234");

closedPositionCountNET = getPortfolioClosedPositionCountNET("XX1234");

openShortQuantityNET = getPortfolioOpenShortQuantityNET("XX1234");

openLongQuantityNET = getPortfolioOpenLongQuantityNET("XX1234");

orderCount = getPortfolioOrderCount("XX1234");

openOrderCount = getPortfolioOpenOrderCount("XX1234");

completeOrderCount = getPortfolioCompleteOrderCount("XX1234");

cancelledOrderCount = getPortfolioCancelledOrderCount("XX1234");

rejectedOrderCount = getPortfolioRejectedOrderCount("XX1234");

triggerPendingOrderCount = getPortfolioTriggerPendingOrderCount("XX1234");

Signatures

/*
* Retrieve portfolio M2M (Position category = DAY).
*/
double getPortfolioMtm(string pseudoAccount)

/*
* Retrieve portfolio PNL (Position category = DAY).
*/
double getPortfolioPnl(string pseudoAccount)

/*
* Retrieve portfolio position count (Position category = DAY).
*/
long getPortfolioPositionCount(string pseudoAccount)

/*
* Retrieve portfolio OPEN position count (Position category = DAY).
*/
long getPortfolioOpenPositionCount(string pseudoAccount)

/*
* Retrieve portfolio CLOSED position count (Position category = DAY).
*/
long getPortfolioClosedPositionCount(string pseudoAccount)

/*
* Retrieve portfolio open short quantity (Position category = DAY).
*/
long getPortfolioOpenShortQuantity(string pseudoAccount)

/*
* Retrieve portfolio open long quantity (Position category = DAY).
*/
long getPortfolioOpenLongQuantity(string pseudoAccount)

/*
* Retrieve portfolio M2M (Position category = NET).
*/
double getPortfolioMtmNET(string pseudoAccount)

/*
* Retrieve portfolio PNL (Position category = NET).
*/
double getPortfolioPnlNET(string pseudoAccount)

/*
* Retrieve portfolio position count (Position category = NET).
*/
long getPortfolioPositionCountNET(string pseudoAccount)

/*
* Retrieve portfolio OPEN position count (Position category = NET).
*/
long getPortfolioOpenPositionCountNET(string pseudoAccount)

/*
* Retrieve portfolio CLOSED position count (Position category = NET).
*/
long getPortfolioClosedPositionCountNET(string pseudoAccount)

/*
* Retrieve portfolio open short quantity (Position category = NET).
*/
long getPortfolioOpenShortQuantityNET(string pseudoAccount)

/*
* Retrieve portfolio open long quantity (Position category = NET).
*/
long getPortfolioOpenLongQuantityNET(string pseudoAccount)

/*
* Retrieve portfolio order count.
*/
long getPortfolioOrderCount(string pseudoAccount)

/*
* Retrieve portfolio "open" order count.
*/
long getPortfolioOpenOrderCount(string pseudoAccount)

/*
* Retrieve portfolio "complete" order count.
*/
long getPortfolioCompleteOrderCount(string pseudoAccount)

/*
* Retrieve portfolio "cancelled" order count.
*/
long getPortfolioCancelledOrderCount(string pseudoAccount)

/*
* Retrieve portfolio "rejected" order count.
*/
long getPortfolioRejectedOrderCount(string pseudoAccount)

/*
* Retrieve portfolio "trigger pending" order count.
*/
long getPortfolioTriggerPendingOrderCount(string pseudoAccount)

Examples

double mtm = getPortfolioMtm("XX1234");

double pnl = getPortfolioPnl("XX1234");

long positionCount = getPortfolioPositionCount("XX1234");

long openPositionCount = getPortfolioOpenPositionCount("XX1234");

long closedPositionCount = getPortfolioClosedPositionCount("XX1234");

long openShortQuantity = getPortfolioOpenShortQuantity("XX1234");

long openLongQuantity = getPortfolioOpenLongQuantity("XX1234");

double mtmNET = getPortfolioMtmNET("XX1234");

double pnlNET = getPortfolioPnlNET("XX1234");

long positionCountNET = getPortfolioPositionCountNET("XX1234");

long openPositionCountNET = getPortfolioOpenPositionCountNET("XX1234");

long closedPositionCountNET = getPortfolioClosedPositionCountNET("XX1234");

long openShortQuantityNET = getPortfolioOpenShortQuantityNET("XX1234");

long openLongQuantityNET = getPortfolioOpenLongQuantityNET("XX1234");

long orderCount = getPortfolioOrderCount("XX1234");

long openOrderCount = getPortfolioOpenOrderCount("XX1234");

long completeOrderCount = getPortfolioCompleteOrderCount("XX1234");

long cancelledOrderCount = getPortfolioCancelledOrderCount("XX1234");

long rejectedOrderCount = getPortfolioRejectedOrderCount("XX1234");

long triggerPendingOrderCount = getPortfolioTriggerPendingOrderCount("XX1234");

Signatures

' Retrieve portfolio M2M (Position category = DAY).
Public Function GetPortfolioMtm(pseudoAccount As String) As Double

' Retrieve portfolio PNL (Position category = DAY).
Public Function GetPortfolioPnl(pseudoAccount As String) As Double

' Retrieve portfolio position count (Position category = DAY).
Public Function GetPortfolioPositionCount(pseudoAccount As String) As Long

' Retrieve portfolio OPEN position count (Position category = DAY).
Public Function GetPortfolioOpenPositionCount(pseudoAccount As String) As Long

' Retrieve portfolio CLOSED position count (Position category = DAY).
Public Function GetPortfolioClosedPositionCount(pseudoAccount As String) As Long

' Retrieve portfolio open short quantity (Position category = DAY).
Public Function GetPortfolioOpenShortQuantity(pseudoAccount As String) As Long

' Retrieve portfolio open long quantity (Position category = DAY).
Public Function GetPortfolioOpenLongQuantity(pseudoAccount As String) As Long

' Retrieve portfolio order count.
Public Function GetPortfolioOrderCount(pseudoAccount As String) As Long

' Retrieve portfolio "open" order count.
Public Function GetPortfolioOpenOrderCount(pseudoAccount As String) As Long

' Retrieve portfolio "complete" order count.
Public Function GetPortfolioCompleteOrderCount(pseudoAccount As String) As Long

' Retrieve portfolio "cancelled" order count.
Public Function GetPortfolioCancelledOrderCount(pseudoAccount As String) As Long

' Retrieve portfolio "rejected" order count.
Public Function GetPortfolioRejectedOrderCount(pseudoAccount As String) As Long

' Retrieve portfolio "trigger pending" order count.
Public Function GetPortfolioTriggerPendingOrderCount(pseudoAccount As String) As Long

' Retrieve portfolio M2M (Position category = NET).
Public Function GetPortfolioMtmNET(pseudoAccount As String) As Double

' Retrieve portfolio PNL (Position category = NET).
Public Function GetPortfolioPnlNET(pseudoAccount As String) As Double

' Retrieve portfolio position count (Position category = NET).
Public Function GetPortfolioPositionCountNET(pseudoAccount As String) As Long

' Retrieve portfolio OPEN position count (Position category = NET).
Public Function GetPortfolioOpenPositionCountNET(pseudoAccount As String) As Long

' Retrieve portfolio CLOSED position count (Position category = NET).
Public Function GetPortfolioClosedPositionCountNET(pseudoAccount As String) As Long

' Retrieve portfolio open short quantity (Position category = NET).
Public Function GetPortfolioOpenShortQuantityNET(pseudoAccount As String) As Long

' Retrieve portfolio open long quantity (Position category = NET).
Public Function GetPortfolioOpenLongQuantityNET(pseudoAccount As String) As Long

Parameters

  • account – pseudo account

Return value

Requested portfolio statistic value

Read Holdings
API Parameters

Was this helpful?

3 Yes  No
Related Articles
  • Master-Child Copy – Performance
  • Tradejini
  • Dhan
  • FlatTrade
  • Supported Brokers
  • Symphony XTS

© 2025 Stocks Developer. All Rights Reserved.