Skip to main content
GET
/
v1
/
users
/
{userId}
/
portfolio
Get a user's portfolio
curl --request GET \
  --url https://api.stockly.com/v1/users/{userId}/portfolio \
  --header 'x-api-key: <api-key>'
{
  "value": 4.26,
  "costBasis": 3.93,
  "change": "+8.4%",
  "holdings": [
    {
      "asset": "AAPL",
      "quantity": 0.00427,
      "value": 1.24,
      "costBasis": 1.15,
      "change": "+7.8%"
    },
    {
      "asset": "NVDA",
      "quantity": 0.0006,
      "value": 0.87,
      "costBasis": 0.8,
      "change": "+8.8%"
    },
    {
      "asset": "TSLA",
      "quantity": 0.0072,
      "value": 2.15,
      "costBasis": 1.98,
      "change": "+8.6%"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Your Stockly API key. Identifies your app; you never pass an app id.

Path Parameters

​
userId
string<uuid>
required

Response

The user's portfolio

​
value
number

Total current value in USD.

​
costBasis
number

Total USD given for the held stock.

​
change
string | null

Return vs cost basis, e.g. "+8.4%". Null if no cost basis yet.

​
holdings
object[]