Skip to main content
POST
get_wallet_portfolio_breakdown
Execution runs a single tool and returns its structured data. Pass the tool’s inputs as a JSON body. Each call costs the tool’s price in credits; get_wallet_portfolio_breakdown, used below, costs 8. The Try it panel runs get_wallet_portfolio_breakdown. Enter wallet_address and network directly in the JSON body, as shown below. To run another tool, open its page in the Tools sidebar section and fill in its inputs.

Example: wallet portfolio

Providing exact entities

Tools are deterministic and expect precise inputs: an exact wallet, token, or contract address, a transaction hash, and a network. If you only have a symbol or a name, resolve it first. Call resolve_token_symbol to turn a symbol into an address, or resolve_name to turn an ENS or SNS name into an address.

Result

On success you receive the tool’s data object. Invalid arguments return 422 Unprocessable Entity and are not charged, so check the tool’s input schema from discovery if you hit one. When a tool has nothing to return, or hits a problem, you receive a status marker instead. See Errors & status.

Reading the portfolio result

The example uses made-up amounts and omits some response fields. major_holdings lists displayed tokens worth more than $1,000; top_holdings includes up to five holdings by value. total_value_displayed is a formatted USD string, while holding-level usd_value values are numbers. tokens_without_price counts holdings without an available valuation. composition_analysis covers only the returned holdings. The full response also includes a token table, summary, and metadata. Missing data and the limit parameter can leave holdings out of the result.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional. Your id for this logical request, 1 to 64 characters. A request is charged at most once per key; reusing a key whose request completed or is running returns 409 DUPLICATE_REQUEST without running the tool.

Required string length: 1 - 64
X-Credit-Catalog-Version
string

Optional. The price version you expect to be charged at. If prices have changed, the call returns 409 PRICE_CHANGED and is not charged. Omit it to be charged at the current price.

Required string length: 1 - 32

Body

application/json
wallet_address
string
required

Wallet address to analyze. Use the address format for the selected network.

network
string
required

Network to query, for example ethereum. See Supported Networks for coverage. Use all to query supported networks together.

limit
integer
default:20

Maximum number of holdings to include in the result.

Response

Portfolio breakdown: major/top holdings, total value, and composition analysis. Fields vary by network and available data. Check for status: no_data, status: error, or an error field even when HTTP status is 200. See Errors & status.

The response is of type object.