> ## Documentation Index
> Fetch the complete documentation index at: https://coinstats.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Portfolio Value
> Get detailed information about portfolio profit/loss
**10** credits per request
* Total value of portfolio
* Defi value of portfolio
* Total cost of portfolio
* Unrealized profit/loss
* Realized profit/loss
* All time profit/loss
This endpoint is only available for users with a Degen plan subscription (when using shareToken).
* shareToken OR portfolioId: Provide one of these to identify the portfolio.
* shareToken: Get this from your CoinStats portfolio page by clicking "Share"
* portfolioId: Use a portfolio connected via POST /portfolio/wallet or POST /portfolio/exchange
* If neither is provided, returns aggregated data for all API-connected portfolios
* currency: Specify the currency for price values, default is USD
* passcode: Passcode for accessing protected portfolio data (can be passed in header or query parameter)
## OpenAPI
````yaml /api-reference/openapi.json get /v1/portfolio/value
openapi: 3.0.0
info:
title: CoinStats Public API
description: >-
CoinStats Public API — programmatic access to market data, news, NFTs,
wallets, exchange connections, and user portfolios. Authenticate every
request with the `X-API-KEY` header (or an OAuth Bearer token in the
`Authorization` header). Generate keys at https://openapi.coinstats.app.
version: '1.0'
contact: {}
servers:
- url: https://openapiv1.coinstats.app
security: []
tags:
- name: CoinStats
description: ''
- name: Market Data
description: >-
The Market Data section of the API provides endpoints to access a wide
range of market-related information, including cryptocurrency coins,
ticker data, and fiat currency rates. This category offers comprehensive
data to help users monitor and analyze the cryptocurrency market, track
prices, and gain insights into market trends
- name: News
description: >-
The News section of the API allows you to access news articles and updates
related to cryptocurrencies and the blockchain industry. It provides
valuable information from various sources to keep you informed about the
latest developments
- name: NFTs
description: >-
The NFT section of the API provides endpoints to interact with
Non-Fungible Tokens (NFTs), which are unique digital assets stored on a
blockchain. These endpoints allow you to retrieve information about NFTs,
including collections, assets, trending NFTs, and specific assets
associated with wallet addresses.
- name: Wallet Data
description: >-
The Wallet section of the API provides a comprehensive set of endpoints to
manage and interact with wallets. It enables users to retrieve wallet
balances, monitor syncing status, fetch transaction data, and synchronize
wallet information with the blockchain. By integrating these endpoints
into your application, you can offer robust wallet functionality to your
users.
- name: Exchange Connection
description: >-
The Exchange Connection section of the API provides a comprehensive set of
endpoints to manage and interact with exchanges. It enables users to
retrieve exchange balances, monitor syncing status, fetch transaction
data. By integrating these endpoints into your application, you can offer
robust exchange portfolio tracking functionality to your users.
- name: User Portfolio
description: >-
The Portfolio section of the API provides a comprehensive set of endpoints
to manage and interact with Share Portfolios. It enables users to retrieve
current Portfolio Coins and Transactions.
- name: Usage
description: The Usage section provides account-level API usage data.
- name: Status
description: The Status section provides API availability checks.
paths:
/v1/portfolio/value:
get:
tags:
- User Portfolio
summary: Get detailed information about portfolio profit/loss
operationId: get-portfolio-value
parameters:
- name: sharetoken
required: false
in: header
description: '[Get Share Token](/sharetoken)'
schema:
type: string
- name: passcode
required: false
in: header
description: Passcode for accessing protected portfolio data
schema:
example: '123456'
type: string
- name: currency
required: false
in: query
description: Currency for price values. Default is USD.
schema:
default: USD
example: USD
type: string
- name: portfolioId
required: false
in: query
description: >-
Portfolio ID for accessing a specific API-connected portfolio.
Required if shareToken is not provided.
schema:
example: abc123def456
type: string
responses:
'200':
description: Portfolio profit/loss
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioValueResponseDto'
'400':
description: Bad Request
content:
application/json:
example:
statusCode: 400
message: Bad Request
requestId: 11111111-2222-3333-4444-555555555555
path:
'401':
description: Unauthorized
content:
application/json:
example:
statusCode: 401
message: Unauthorized
requestId: 11111111-2222-3333-4444-555555555555
path:
'403':
description: Forbidden
content:
application/json:
example:
statusCode: 403
message: Forbidden
requestId: 11111111-2222-3333-4444-555555555555
path:
'404':
description: Not Found
content:
application/json:
example:
statusCode: 404
message: Not Found
requestId: 11111111-2222-3333-4444-555555555555
path:
'409':
description: Conflict (for some endpoints)
content:
application/json:
example:
statusCode: 409
message: Transactions not synced
requestId: 11111111-2222-3333-4444-555555555555
path:
'429':
description: Too Many Requests
content:
application/json:
example:
statusCode: 429
message: Rate limit exceeded
requestId: 11111111-2222-3333-4444-555555555555
path:
'503':
description: Service Unavailable
content:
application/json:
example:
statusCode: 503
message: Service Unavailable. Please Contact Support
security:
- X-API-KEY: []
components:
schemas:
PortfolioValueResponseDto:
type: object
properties:
totalValue:
type: number
description: Total value of portfolio
example: 12500.75
defiValue:
type: number
description: DeFi value of portfolio
example: 2500.25
totalCost:
type: number
description: Total cost of portfolio
example: 10000.5
unrealizedProfitLoss:
type: number
description: Unrealized profit/loss
example: 1250.75
unrealizedProfitLossPercent:
type: number
description: Unrealized profit/loss percentage
example: 12.5
realizedProfitLoss:
type: number
description: Realized profit/loss
example: 500.25
realizedProfitLossPercent:
type: number
description: Realized profit/loss percentage
example: 5
allTimeProfitLoss:
type: number
description: All Time profit/loss
example: 1751
allTimeProfitLossPercent:
type: number
description: All Time profit/loss percentage
example: 17.5
required:
- unrealizedProfitLossPercent
- realizedProfitLossPercent
- allTimeProfitLossPercent
securitySchemes:
X-API-KEY:
type: apiKey
in: header
name: X-API-KEY
description: >-
API key required to access the endpoints. Generate one from your
dashboard at https://openapi.coinstats.app and pass it in the
`X-API-KEY` request header. Never expose your key in client-side code.
````