GET
/
portfolio
/
snapshot
/
items
cURL
curl --request GET \
  --url https://openapiv1.coinstats.app/portfolio/snapshot/items \
  --header 'X-API-KEY: <api-key>'
{
  "result": [
    {
      "date": "2024-01-15T12:00:00.000Z",
      "coinBalances": [
        {
          "symbol": "BTC",
          "icon": "<string>",
          "quantity": 0.5,
          "balance": 25000.5,
          "quantityChange": 0.1,
          "balanceChange": 5000.25,
          "pricePerUnit": 50000,
          "pricePercentChange": 5.25
        }
      ],
      "totalBalance": 100000.5,
      "totalBalanceChange": 5000.25,
      "totalBalancePercentChange": 5.25
    }
  ]
}
500 credits per request
Get historical portfolio snapshot data with normalized coin balances and portfolio metrics:
  • Historical coin quantities and balances over time
  • Total portfolio balance tracking with changes
  • Price changes and quantity changes between snapshots
  • Filterable by date range and specific coins
Required:
  • shareToken: Get this from your CoinStats portfolio page by clicking “Share” and copying the token from the share URL
Optional Parameters:
  • from & to: Date range filter (YYYY-MM-DD format)
  • coinIds: Comma-separated list of coin IDs to filter by
  • skip & limit: Pagination controls
  • passcode: Optional passcode for accessing protected portfolio data
Note: This endpoint is only available for users with a Degen plan subscription.

Authorizations

​
X-API-KEY
string
header
required

API key needed to access the endpoints. Example: 'demo-api-key'

Query Parameters

​
page
number
Example:

1

​
limit
number
Example:

20

​
shareToken
string
required

<b>To access your Share Token</b> Visit <a target='_blank' href='https://coinstats.app/portfolio'>CoinStats Portfolio</a> and make sure you are signed in to your account. In the top-right corner of the page, click on the Share button. This will bring up sharing preferences for your portfolio. Generate a Share Link. In the generated URL, the segment following <code>/p/</code> (e.g., <code>XXX</code>) is your share token. Copy only that token (without additional slashes or characters). Use the Token in the API

​
from
string

Start date for snapshot data (YYYY-MM-DD format)

Example:

"2024-01-01"

​
to
string

End date for snapshot data (YYYY-MM-DD format)

Example:

"2024-12-31"

​
coinIds
string

Comma-separated list of coin IDs to filter by

Example:

"bitcoin,ethereum,cardano"

​
passcode
string

Optional passcode for accessing protected portfolio data

Example:

"123456"

Response

200
application/json

Portfolio Snapshot Items

The response is of type object.