Holdings
Holdings
This endpoint returns a list of holdings and information about them.
Path parameters
-
fin
string Required The Finplex Identity Number of the user
Query parameters
-
asAtDate
string(date-time) Required Get holdings and valuation as of this date.
-
valCurrency
string Required The currency to value the holdings in.
Values are
ARS
,AUD
,BWP
,BRL
,CAD
,CNH
,CNY
,COP
,CZK
,DKK
,DOP
,EGP
,EUR
,GBP
,HKD
,HUF
,IDR
,INR
,ISK
,JPY
,KZT
,LTL
,LUF
,MXN
,MYR
,TWD
,NZD
,NOK
,PEN
,PLN
,KRW
,RON
,RUB
,SGD
,SKK
,SIT
,ZAR
,SEK
,CHF
,THB
,TRY
,USD
,UYU
, orVND
. -
fen
string | null -
fan
string | null
GET
/portfolio/{fin}/holdings
curl \
-X GET http://api.example.com/portfolio/{fin}/holdings?asAtDate=2023-05-04T09%3A42%3A00%2B00%3A00&valCurrency=ARS
Response examples (200)
[
{
"assetName": "string",
"assetSymbol": "string",
"assetType": "string",
"avgPurchasePrice": 42.0,
"currency": "ARS",
"exchangeCode": "string",
"fan": "string",
"fen": "string",
"holdingId": "string",
"marketPrice": 42.0,
"marketValue": 42.0,
"quantity": 42.0,
"totalGainLossValue": 42.0,
"totalMarketPrice": 42.0,
"totalMarketValue": 42.0,
"totalPurchasePrice": 42.0,
"totalPurchaseValue": 42.0
}
]
Response examples (200)
[
{
"assetName": "string",
"assetSymbol": "string",
"assetType": "string",
"avgPurchasePrice": 42.0,
"currency": "ARS",
"exchangeCode": "string",
"fan": "string",
"fen": "string",
"holdingId": "string",
"marketPrice": 42.0,
"marketValue": 42.0,
"quantity": 42.0,
"totalGainLossValue": 42.0,
"totalMarketPrice": 42.0,
"totalMarketValue": 42.0,
"totalPurchasePrice": 42.0,
"totalPurchaseValue": 42.0
}
]