---
title: "GET /v1/portfolios/{portfolioSlug}/address-holdings/{address}/overview"
method: GET
path: "/v1/portfolios/{portfolioSlug}/address-holdings/{address}/overview"
tags: ["Portfolios"]
---

# GET /v1/portfolios/{portfolioSlug}/address-holdings/{address}/overview

`GET /v1/portfolios/{portfolioSlug}/address-holdings/{address}/overview`

## Request

- Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tokenbooks.io/v1/portfolios/{portfolioSlug}/address-holdings/{address}/overview`
- Auth: API key in header `x-api-key`

## Path parameters

- `address` string, required
- `portfolioSlug` string, required

## Query parameters

- `asOfDate` string, date-time: Optional snapshot timestamp for historical balance reads
- `showSpam` boolean: Whether spam tokens should be included

## Response `200`

- AddressHoldingsOverviewDto
  - `tokensCount` integer, required: Number of concrete tokens
  - `walletsCount` integer, required: Number of wallets in scope
  - `transferCount` integer, required: Number of transfers
  - `accountingSummary` object, nullable, required: Page-scoped accounting summary; null when the portfolio pools cost basis across wallets, since a wallet then has no basis of its own
    - `costBasis` string, nullable, required: Held cost basis of the page wallets' visible assets; 0 when they hold no open lots; null when the basis of any of those assets is withheld for any page wallet, since withheld basis is never shown or partially summed
    - `realizedGainLoss` string, required: Realized gain/loss of the page wallets' disposals of the page's assets
    - `unrealizedGainLoss` string, nullable, required: Sum over the page wallets of each wallet's /wallets unrealized gain/loss; null when the basis of any page asset is withheld for any page wallet, or when none of the page's holdings has both a known value and a cost basis
    - `roi` string, nullable, required: (realizedGainLoss + unrealizedGainLoss) ÷ costBasis; null when unrealizedGainLoss or costBasis is null, or costBasis is not positive

---

[API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/180622e6255e?raw)