Skip to main content

Overview Scope

Source: src/sdk/overview.ts

Use sdk.overview for Core digital-assets overview endpoints.

Methods

getDigitalAssetsOverview(query?: DigitalAssetsOverviewQueryDto): Promise<DigitalAssetsOverviewResponseDto>

Endpoint

GET /api/v1/core/overview/digital-assets

How it works

Returns the global digital-assets dashboard payload for the requested date range.

Arguments

ArgumentTypeRequiredNotes
query.fromstringNoInclusive start date in YYYY-MM-DD.
query.tostringNoInclusive end date in YYYY-MM-DD.
query.granularity'day'NoCurrently only day is supported.

Returns

Promise<DigitalAssetsOverviewResponseDto>

getPortfolioOverview(query?: DigitalAssetsOverviewQueryDto): Promise<PortfolioOverviewResponseDto>

Endpoint

GET /api/v1/core/overview/digital-assets/portfolio

How it works

Returns portfolio-only overview breakdowns and series grouped by asset and network.

Arguments

Same query options as getDigitalAssetsOverview.

Returns

Promise<PortfolioOverviewResponseDto>

getPortfolioNetworkOverview(network: string, query?: DigitalAssetsOverviewQueryDto): Promise<PortfolioNetworkDetailOverviewResponseDto>

Endpoint

GET /api/v1/core/overview/digital-assets/portfolio/networks/:network

How it works

Returns portfolio-only overview details for one network.

Arguments

ArgumentTypeRequiredNotes
networkstringYesNetwork identifier used in route path.
query.fromstringNoInclusive start date in YYYY-MM-DD.
query.tostringNoInclusive end date in YYYY-MM-DD.
query.granularity'day'NoCurrently only day is supported.

Returns

Promise<PortfolioNetworkDetailOverviewResponseDto>

Request Example

const portfolioByNetwork = await sdk.overview.getPortfolioNetworkOverview(
'ethereum',
{
from: '2026-04-01',
to: '2026-04-22',
granularity: 'day',
},
);