Skip to main content
GET
/
portfolio
/
coins
Get detailed information about all coins in your portfolio
curl --request GET \
  --url https://openapiv1.coinstats.app/portfolio/coins \
  --header 'X-API-KEY: <api-key>'
{
  "result": [
    {
      "count": 44.4987,
      "coin": {
        "rank": 2,
        "identifier": "ethereum",
        "symbol": "ETH",
        "name": "Ethereum",
        "icon": "https://static.coinstats.app/coins/1650455629727.png",
        "isFake": false,
        "isFiat": false,
        "priceChange24h": -5.74,
        "priceChange1h": 0.1,
        "priceChange7d": 1.12,
        "volume": 61315198931.43572
      },
      "price": {
        "USD": 4343.564311034,
        "BTC": 0.039479708,
        "ETH": 1
      },
      "profit": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        },
        "realized": {
          "USD": 18844.785945298,
          "BTC": -0.46237401135664413,
          "ETH": -0.0008426785167330308
        }
      },
      "averageBuy": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        }
      },
      "averageSell": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        }
      },
      "profitPercent": {
        "allTime": {
          "USD": 83720.75297372,
          "BTC": 0.054246576,
          "ETH": -0.0008427712028833412
        },
        "hour24": {
          "USD": -11770.04265107636,
          "BTC": -0.055726915608058335,
          "ETH": 0
        },
        "lastTrade": {
          "USD": -0.0011652685976688212,
          "BTC": -8.325768295004658e-9,
          "ETH": 8.470329472543003e-22
        },
        "unrealized": {
          "USD": 64875.375139922,
          "BTC": 0.516615331,
          "ETH": -0.000013421973257266018
        },
        "realized": {
          "USD": 18844.785945298,
          "BTC": -0.46237401135664413,
          "ETH": -0.0008426785167330308
        }
      },
      "liquidityScore": 94.44676177373067,
      "volatilityScore": 6.823477152064536,
      "marketCapScore": 90.15554879029162,
      "riskScore": 7.407055529347417,
      "avgChange": 2.631321607022045
    }
  ]
}
8 credits per request
  • Current holdings and their USD value
  • Profit/Loss (PnL) information
  • Performance metrics and statistics
  • Risk assessment scores (optional)
This endpoint is only available for users with a Degen plan subscription.
  • shareToken: Get this from your CoinStats portfolio page by clicking “Share” and copying the token from the share URL
  • page & limit: Control the number of results per page
  • includeRiskScore: Set to “true” to include risk metrics
  • passcode: Passcode for accessing protected portfolio data (can be passed in header or query parameter)

Authorizations

​
X-API-KEY
string
header
required

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

Headers

​
passcode
string

Passcode for accessing protected portfolio data

Example:

"123456"

Query Parameters

​
page
number

Page number to retrieve (1-based indexing)

Example:

1

​
limit
number

Number of items to return per page

Example:

20

​
shareToken
string
required

Get Share Token

​
includeRiskScore
enum<string>
default:false

Include Risk Score Information

Available options:
true,
false
Example:

"true"

​
passcode
string

Passcode for accessing protected portfolio data

Example:

"123456"

Response

Portfolio coins

​
result
object[]
required

Array of portfolio items containing detailed information about each held cryptocurrency including prices, profits, averages, and risk metrics

⌘I