GET
/
portfolio
/
coins
cURL
curl --request GET \
  --url https://openapiv1.coinstats.app/portfolio/coins \
  --header 'X-API-KEY: <api-key>'
{
  "result": [
    {
      "count": 1,
      "coin": {
        "rank": 123,
        "identifier": "<string>",
        "symbol": "<string>",
        "name": "<string>",
        "icon": "<string>",
        "isFake": true,
        "isFiat": true,
        "priceChange24h": 123,
        "priceChange1h": 123,
        "priceChange7d": 123,
        "volume": 123
      },
      "price": {
        "USD": 123,
        "BTC": 123,
        "ETH": 123
      },
      "profit": {
        "allTime": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "hour24": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "lastTrade": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "unrealized": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "realized": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        }
      },
      "averageBuy": {
        "allTime": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "hour24": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "lastTrade": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "unrealized": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        }
      },
      "averageSell": {
        "allTime": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "hour24": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "lastTrade": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "unrealized": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        }
      },
      "profitPercent": {
        "allTime": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "hour24": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "lastTrade": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "unrealized": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        },
        "realized": {
          "USD": 123,
          "BTC": 123,
          "ETH": 123
        }
      },
      "liquidityScore": 123,
      "volatilityScore": 123,
      "marketCapScore": 123,
      "riskScore": 123,
      "avgChange": 123
    }
  ]
}
8 credits per request
Get detailed information about all coins in your portfolio, including:
  • Current holdings and their USD value
  • Profit/Loss (PnL) information
  • Performance metrics and statistics
  • Risk assessment scores (optional)
Required:
  • shareToken: Get this from your CoinStats portfolio page by clicking “Share” and copying the token from the share URL
Optional Parameters:
  • skip & limit: Control the number of results per page
  • includeRiskScore: Set to “true” to include risk metrics
  • 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

​
includeRiskScore
string

true or false. Default - false

​
passcode
string

Optional passcode for accessing protected portfolio data

Example:

"123456"

Response

200
application/json

Coins

The response is of type object.