---
title: "Live wallet overview"
method: GET
path: "/v1/wallets/{address}/overview"
tags: ["wallets"]
---

# Live wallet overview

`GET /v1/wallets/{address}/overview`

## Request

- Base URL: `https://satoshidata.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://satoshidata.ai/v1/wallets/{address}/overview`
- Auth: none declared

Free live wallet balance, UTXO count, transaction count, activity timing, and BTC price context.

## Path parameters

- `address` string, required

## Query parameters

- `view` string, nullable: Optional response view. Set `view=compact` for a smaller agent-oriented payload.

## Response `200`

Live wallet overview

- WalletOverviewResponse
  - `kind` 'wallet_overview'
  - `address` string, required
  - `address_type` WalletAddressType, required
    - `label` string, required: Human-readable Bitcoin address type, such as Legacy or Taproot.
    - `short` string, required: Short address format label, such as P2PKH, P2SH, Bech32, or Bech32m.
    - `class_name` string, required: Stable UI/API class key for the address type, such as legacy, p2sh, or bech32.
  - `balance_btc` number, nullable
  - `balance_sat` integer, nullable
  - `unconfirmed_balance_btc` number, nullable
  - `unconfirmed_balance_sat` integer, nullable
  - `balance_usd` number, nullable
  - `tx_count` integer, nullable
  - `utxo_count` integer, nullable
  - `first_seen_at` string, nullable
  - `first_seen_at_source` string, nullable
  - `last_seen_at` string, nullable
  - `last_inbound_at` string, nullable
  - `last_outbound_at` string, nullable
  - `last_activity_direction` string, nullable
  - `dormancy_status` string, nullable
  - `activity_timestamp_semantics` string, nullable
  - `address_history_first_seen_at` string, nullable
  - `history_source` string, nullable
  - `history_degraded` boolean, nullable
  - `history_note` string, nullable
  - `indexer_start_date` string, nullable
  - `btc_price_usd` number, nullable
  - `price_change_24h_pct` number, nullable
  - `price_fetched_at` string, nullable
  - `price_source` string, nullable
  - `fx_rates` object
  - `fx_rates_as_of` string, nullable
  - `fx_status` string, nullable
  - `wallet_health` WalletHealthCheck[]: Wallet-health checks estimated from the overview balance, UTXOs, and transaction count.
    - `id` string, required: Stable check identifier, such as consolidation, dust, reuse, script, or concentration.
    - `code` string, nullable: Stable Chain Notes message variant. Display title and comment as sent.
    - `params` object: Numeric facts used to render the message variant.
    - `status` 'good' | 'info' | 'warning' | 'alert', required: Severity of the wallet-health check.
    - `title` string, required: Human-readable wallet-health check title.
    - `comment` string, required: Short explanation of the check result.
  - `access` PublicAccessProjection
    - `tier` string, nullable
    - `auth_mode` string, nullable
    - `auth_header` string, nullable
    - `authorization_scheme` string, nullable
    - `label` string, nullable
  - `_meta` ResponseMeta, required
    - `endpoint` string, required
    - `freshness` string, nullable
    - `freshness_semantics` 'internal_refresh' | 'source_poll' | 'claim_made', nullable
    - `source` string, required
    - `price_sats` integer, nullable
    - `price_usd` string, nullable
    - `docs` string, nullable
    - `warnings` ResponseWarning[]
      - `code` string, required
      - `message` string, required
    - `pagination` ResponsePagination
      - `offset` integer, required
      - `limit` integer, required
      - `total_alerts` integer, required
      - `next_offset` integer, nullable, required
      - `has_more` boolean, required
    - `view` 'compact', nullable
    - `bitcoin_backend` string, nullable
    - `beta` boolean, nullable
    - `cache_seconds` integer, nullable
    - `cache_ttl_seconds` integer, nullable
    - `cache_status` string, nullable
    - `cache_age_seconds` number, nullable
    - `cache_cached_at` string, nullable
    - `cached` boolean, nullable
    - `cache_policy` string, nullable
    - `compute_ms` integer, nullable
    - `warning` string, nullable
    - `refresh_warning` string, nullable
    - `last_refresh_started_at` string, nullable
    - `last_refresh_completed_at` string, nullable
    - `last_refresh_status` string, nullable
    - `last_refresh_error` string, nullable
    - `last_refresh_duration_ms` integer, nullable
    - `feature_flag` string, nullable
    - `rollout_state` string, nullable
    - `schema_version` string, nullable
    - `methodology_version` string, nullable
    - `materialized_source` string, nullable
    - `max_hops` integer, nullable
    - `retention` string, nullable
    - `not_compliance_advice` boolean, nullable
    - `future_native_price_mode` string, nullable
    - `future_native_price_note` string, nullable
    - `future_native_quote_endpoint` string, nullable
    - `overview_activity_cache` object, nullable
    - `attribution_confidence` string, nullable
    - `generated_at` string, nullable
    - `last_computed` string, nullable
    - `snapshot_generated_at` string, nullable
    - `snapshot_age_seconds` number, nullable
    - `snapshot_stale_after_seconds` integer, nullable
    - `snapshot_status` string, nullable
    - `history_window_basis` string, nullable
    - `total_blocks_last_24h` integer, nullable
    - `field_semantics` object, nullable
    - `semantic_completeness` object, nullable
  - `beta` boolean, required

## Other responses

- `400`: Bad request.
- `404`: Resource not found.
- `405`: Method not allowed.
- `422`: Request validation failed.

---

[API](https://skmtc.dev/satoshidata/apis/satoshidata-agent-api.md) · [All operations](https://skmtc.dev/satoshidata/apis/satoshidata-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/satoshidata/apis/satoshidata-agent-api/revisions/9fc9edc41ac4?raw)