UTxO Statistics

GET /shared-wallets/{walletId}/statistics/utxos

status: stable

Return the UTxO distribution across the whole wallet, in the form of a histogram.

     │
 100 ─
     │
     │                                 ┌───┐
  10 ─                         ┌───┐   │   │                   ┌───┐
     │                 ┌───┐   │   │   │   │                   │   │
     │                 │   │   │   │   │   │   ┌───┐           │   │
   1 ─ ┌───┐           │   │   │   │   │   │   │   │           │   │
     │ │   │           │   │   │   │   │   │   │   │           │   │
     │ │   │ │       │ │   │ │ │   │ ╷ │   │ ╷ │   │ ╷       ╷ │   │
     └─┘   └─│───────│─┘   └─│─┘   └─│─┘   └─│─┘   └─│───────│─┘   └────
           10μ₳    100μ₳   1000μ₳   0.1₳    1₳      10₳     100₳

Path parameters

  • walletId string(hex) Required

    Minimum length is 40, maximum length is 40.

Responses

  • 406 application/json

    Not Acceptable

    Hide response attributes Show response attributes object
    • message string Required

      May occur when providing an invalid 'Accept' header.

    • code string Required

      Value is not_acceptable.

  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • message string Required

      May occur when a given walletId does not match with any known wallets (because it has been deleted, or has never existed).

    • code string Required

      Value is no_such_wallet.

    • info object
      Hide info attribute Show info attribute object
      • wallet_id string(hex) Required

        A unique identifier for the wallet

        Minimum length is 40, maximum length is 40.

  • 200 application/json

    Ok

    Hide response attributes Show response attributes object
    • total object Required

      Coins, in Lovelace. Only relates to 'Ada'. Refer to assets for multi-assets wallets instead.

      Hide total attributes Show total attributes object
      • quantity integer Required

        Minimum value is 0.

      • unit string Required

        Value is lovelace.

    • scale string Required

      Value is log10.

    • distribution object Required
      Hide distribution attributes Show distribution attributes object
GET /shared-wallets/{walletId}/statistics/utxos
curl \
 --request GET https://localhost:8090/v2/shared-wallets/{walletId}/statistics/utxos
Response examples (406)
{
  "message": "string",
  "code": "not_acceptable"
}
Response examples (404)
{
  "message": "string",
  "code": "no_such_wallet",
  "info": {
    "wallet_id": "2512a00e9653fe49a44a5886202e24d77eeb998f"
  }
}
Response examples (200)
{
  "scale": "log10",
  "total": {
    "unit": "lovelace",
    "quantity": 42000000
  },
  "distribution": {
    "10": 1,
    "100": 0,
    "1000": 8,
    "10000": 14,
    "100000": 32,
    "1000000": 3,
    "10000000": 0,
    "100000000": 12,
    "1000000000": 0,
    "10000000000": 0,
    "100000000000": 0,
    "1000000000000": 0,
    "10000000000000": 0,
    "100000000000000": 0,
    "1000000000000000": 0,
    "10000000000000000": 0,
    "45000000000000000": 0
  }
}