API & Developers

Crypto Portfolio API Endpoint Reference

Every Octav API endpoint with its parameters, credit cost and response, plus authentication, rate limits and caching behaviour for building on portfolio data.

Octav Team2 min read
Banner: Every Octav API endpoint, with credits and limits

A working reference for the Octav REST API. Base URL https://api.octav.fi, Bearer token authentication, credit-based billing.

For the conceptual walkthrough, start with How to Pull Portfolio Data From a Crypto API.

Authentication and limits

AuthAuthorization: Bearer <key> — keys from data.octav.fi
Rate limit360 requests/minute per key
Rate headersX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
BillingCredits, roughly $0.020–$0.025 each; most endpoints cost 1
CachingPortfolio 1 minute, transactions 10 minutes
AddressesEVM (0x…) and Solana (base58), comma-separated in one request

Batching addresses into a single request is the main cost lever: one call with three addresses costs one credit, three calls cost three.

Portfolio and valuation

EndpointMethodCreditsReturns
/v1/portfolioGET1Multi-chain holdings, decoded DeFi positions, net worth
/v1/navGET1A single net asset value figure
/v1/walletGET1Token balances and USD values only
/v1/token-overviewGET1Token breakdown by protocol — PRO only
/v1/portfolio/at-blockGET1 + add-onValuation at a specific Ethereum block
/v1/historicalGET1Portfolio snapshot at a past date

/v1/portfolio is the core endpoint and the one that decodes positions. /v1/wallet deliberately does not — use it when you only want token balances and want to pay less for them.

Transactions

EndpointMethodCreditsReturns
/v1/transactionsGET1Labelled transaction history
/v1/sync-transactionsPOST1 + 1 per 250 txnsTriggers indexing for an address

/v1/transactions filters on limit, offset, sort, chain, type, protocol and dateRange, across 53 transaction types. First sync of a busy address has a variable cost, which is worth knowing before you loop over a fund's whole address book.

Snapshots and history

EndpointMethodCreditsReturns
/v1/subscribe-snapshotPOST1200Enables daily automatic snapshots
/v1/historicalGET1Portfolio as of a past date

Snapshots only record forward from the moment you subscribe — see Daily Crypto Portfolio Snapshots.

Discovery and account (free)

EndpointCreditsReturns
/v1/chainsFreeSupported blockchains
/v1/chains/{chainKey}/protocolsFreeProtocols on a chain
/v1/statusFreeSync status and data freshness for an address
/v1/creditsFreeRemaining credit balance

Call /v1/status before trusting a portfolio response in a reporting pipeline; it tells you how fresh the underlying data is.

Specialised

EndpointCreditsNotes
/v1/approvals/{chain}1Token approvals — security review
/v1/contract-protocol5 (refunded on 404)Resolve a contract to a protocol
/v1/airdrop1Airdrop eligibility — Solana only
/v1/beacon/validators/*Add-onEthereum validator details and rewards
/v1/virtual-users1PRO only
/v1/virtual-users/portfolio1 per addressPRO only

Errors worth handling

CodeMeaningWhat to do
401Bad or missing keyCheck the Authorization header
402Out of creditsTop up at data.octav.fi
403PRO endpointSubscribe, or use a non-PRO equivalent
404Address not indexedAbove 100k transactions, contact support
429Rate limitedHonour Retry-After, back off exponentially

402 is the one people forget. An unhandled 402 in a nightly NAV job produces a silent gap in your reporting rather than a loud failure.

Coverage

33+ decoded DeFi position types across lending, liquidity, staking, vaults, perpetuals and margin, spanning EVM chains, Solana and Hyperliquid. What that covers in practice is measured in the portfolio API benchmark.

Other ways in

The same data is available through an MCP server for AI agents, a Rust CLI and x402, and an embeddable widget if you want UI rather than JSON.

Keep reading

  • Banner: How to choose a crypto portfolio API
    API & Developers

    How to Choose a Crypto Portfolio API

    A buyer's guide to evaluating crypto portfolio APIs — the tests to run, the questions vendors dislike, and the trade-offs between coverage, cost and latency.

    2 min read

  • Banner: Pull a multi-chain portfolio in one request
    API & Developers

    How to Pull Portfolio Data From a Crypto API

    A practical walkthrough of fetching multi-chain wallet balances, protocol positions and transaction history from a crypto portfolio API, with worked examples.

    1 min read

  • Banner: Every Octav tool, and when to use it
    API & Developers

    Every Octav Tool and When to Use It

    A map of the Octav toolset — dashboard, API, CLI, MCP server, widgets, snapshots, transparency pages and free utilities — and which one fits which job.

    2 min read