arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Address Current Balances

Get real-time token balance information for any blockchain address or entity

hashtag
Common Scenarios

circle-info

You can use this endpoint to find correct entity name format to use in this Profiler Endpoint: Click Herearrow-up-right

Usecase
Required Parameters
Optional Filters
Expected Output

Check current holdings for a single address

address = "0x28c6c06298d514db089934071355e5743bf21d60", chain = "ethereum"

hide_spam_token = true,

List of tokens with amounts, USD values, and chain info for the address

View entity-wide portfolio (e.g., Vitalik Buterin)

entity_name = "Vitalik Buterin", chain = "all"

hide_spam_token = true

Aggregated balances for entity across all wallets, showing holdings per chain

hashtag
Get Address Current Balance Data

post

Retrieve current token holdings for addresses or entities. Returns detailed balance information across specified chains.

What it helps to answer:

  • Current token holdings with quantities and USD valuations

  • Asset distribution across different blockchain networks

  • Native token versus token balances

Note: The address field in the response will be empty if entity_name is provided.

Authorizations
apiKeystringRequired

API key for authentication

Body
post
/api/v1/profiler/address/current-balance
Stablecoin holdings and percentages
  • Cross-chain portfolio composition

  • addressany ofOptional

    Address to get balances for

    Example: 0x28c6c06298d514db089934071355e5743bf21d60
    stringOptional
    entity_nameany ofOptional

    Entity name to get balances for

    Example: Vitalik Buterin
    stringOptional
    chainstring · enumRequired

    Blockchain chain for the balances

    Example: ethereumPossible values:
    hide_spam_tokenbooleanOptional

    Removes suspicious tokens from the balance list

    Default: trueExample: true
    filtersany ofOptional

    Additional filters to apply. Only filters for columns that are being selected will be applied.

    Example: {"token_symbol":"USDC","value_usd":{"min":10}}
    value_usdany ofOptional

    Balance range filter in USD

    Example: {"max":100000,"min":10}
    minany ofOptional

    Minimum value (inclusive)

    Example: 1000
    numberOptional
    maxany ofOptional

    Maximum value (inclusive)

    Example: 50000
    numberOptional
    price_usdany ofOptional

    Token price range filter in USD

    Example: {"max":1000,"min":0.01}
    minany ofOptional

    Minimum value (inclusive)

    Example: 1000
    numberOptional
    maxany ofOptional

    Maximum value (inclusive)

    Example: 50000
    numberOptional
    token_amountany ofOptional

    Token amount range filter

    Example: {"max":1000000,"min":1}
    minany ofOptional

    Minimum value (inclusive)

    Example: 10
    integerOptional
    maxany ofOptional

    Maximum value (inclusive)

    Example: 100
    integerOptional
    token_symbolany ofOptional

    Token symbol filter

    Example: USDC
    stringOptional
    or
    string[]Optional
    or
    nullOptional
    token_addressany ofOptional

    Token address filter

    Example: 0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48
    stringOptional
    or
    string[]Optional
    or
    nullOptional
    token_nameany ofOptional

    Token name filter

    Example: USD Coin
    stringOptional
    or
    string[]Optional
    or
    nullOptional
    pageinteger · min: 1Optional

    Page number (1-based)

    Default: 1
    per_pageinteger · min: 1 · max: 1000Optional

    Number of records per page (max 1000)

    Default: 10
    order_byany ofOptional

    Custom sort order to override the endpoint's default ordering

    fieldstring · enumRequired

    Field to sort by

    Possible values:
    directionstring · enumRequired

    Sort direction (ASC or DESC)

    Possible values:
    Responses
    chevron-right
    200

    Address current balance data

    application/json
    X-Nansen-Credits-UsedstringOptional

    Number of credits consumed by this API request

    Example: 5
    X-Nansen-Credits-RemainingstringOptional

    Total credits remaining in the user's account after this request

    Example: 9995
    RateLimit-LimitstringOptional

    Combined rate limit across all configured time windows

    Example: 20
    RateLimit-RemainingstringOptional

    Number of requests remaining in the current limiting window

    Example: 15
    RateLimit-ResetstringOptional

    Time in seconds until the rate limit window resets

    Example: 30
    X-RateLimit-Limit-SecondstringOptional

    Maximum requests allowed per second

    Example: 20
    X-RateLimit-Remaining-SecondstringOptional

    Requests remaining in the current second

    Example: 19
    X-RateLimit-Limit-MinutestringOptional

    Maximum requests allowed per minute

    Example: 300
    X-RateLimit-Remaining-MinutestringOptional

    Requests remaining in the current minute

    Example: 295
    pageinteger · min: 1Optional

    Current page number

    Default: 1
    per_pageinteger · min: 1 · max: 1000Optional

    Number of records per page

    Default: 10
    is_last_pagebooleanOptional

    Whether this is the last page

    Default: true
    chainstringRequired

    Chain

    addressstringRequired

    Address of the wallet. Empty if entity_name is provided.

    token_addressstringRequired

    Address of token

    token_symbolstringRequired

    Token symbol

    token_nameany ofOptional

    Token name

    stringOptional
    token_amountany ofOptional

    Token balance

    numberOptional
    price_usdany ofOptional

    Price of the token

    numberOptional
    value_usdany ofOptional

    Token balance value in USD

    numberOptional
    chevron-right
    400

    Bad Request

    application/json
    chevron-right
    401

    Unauthorized

    application/json
    chevron-right
    402

    Payment Required

    application/json
    chevron-right
    403

    Forbidden

    application/json
    chevron-right
    404

    Not Found

    application/json
    chevron-right
    422

    Unprocessable Content

    application/json
    chevron-right
    429

    Too Many Requests

    application/json
    chevron-right
    500

    Internal Server Error

    application/json
    POST /api/v1/profiler/address/current-balance HTTP/1.1
    Host: api.nansen.ai
    apiKey: YOUR_API_KEY
    Content-Type: application/json
    Accept: */*
    Content-Length: 136
    
    {
      "address": "0x28c6c06298d514db089934071355e5743bf21d60",
      "chain": "ethereum",
      "hide_spam_token": true,
      "pagination": {
        "page": 1,
        "per_page": 10
      }
    }
    {
      "pagination": {
        "page": 1,
        "per_page": 10,
        "is_last_page": true
      },
      "data": [
        {
          "chain": "text",
          "address": "text",
          "token_address": "text",
          "token_symbol": "text",
          "token_name": "text",
          "token_amount": 1,
          "price_usd": 1,
          "value_usd": 1
        }
      ]
    }