Portfolio

Portfolio Positions

Returns a list of positions for the given account. The endpoint supports paging, page's default size is 30 positions. /portfolio/accounts or /portfolio/subaccounts must be called prior to this endpoint.

get/portfolio/{accountId}/positions/{pageId}

Request

  • Base URL
    http://localhost:5000/v1/api
  • URL
    http://localhost:5000/v1/api/portfolio/{accountId}/positions/{pageId}
  • Auth
    none declared

Path parameters

accountIdstring required

account id

pageIdstring required

page id

Query parameters

modelstring

optional

sortstring

declare the table to be sorted by which column

directionstring

in which order, a means ascending - d means descending

periodstring

period for pnl column, can be 1D, 7D, 1M...

Response

returns a list of positions in the portfolio

acctIdstring
conidinteger
contractDescstring
assetClassstring
positionnumber
mktPricenumber
mktValuenumber
currencystring
avgCostnumber
avgPricenumber
realizedPnlnumber
unrealizedPnlnumber
exchsstring
expirystring
putOrCallstring
multipliernumber
strikenumber
exerciseStylestring
undConidinteger
conExchMapstring[]
baseMktValuenumber
baseMktPricenumber
baseAvgCostnumber
baseAvgPricenumber
baseRealizedPnlnumber
baseUnrealizedPnlnumber
namestring
lastTradingDaystring
groupstring
sectorstring
sectorGroupstring
tickerstring
undCompstring
undSymstring
fullNamestring
pageSizeinteger
modelstring

Changes

No recorded changes to this operation across all 1 revision of this API.