Sign in
Wallets

List wallet overviews

Changed on

Returns all the wallet overviews. A wallet overview is a summary of a wallet with the number of payments, invoices and contacts.

get/v1/wallets/overviews

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Response

Success

account_idstring uuid required

Owning account ID

asset_idstring uuid required

Spendable asset held by this wallet

created_atstring date-time required

Date of creation in database

idstring uuid required

Internal ID

labelstring nullable

Optional account-specific display label.

n_contactsinteger required

Number of contacts

n_invoicesinteger required

Number of invoices

n_paymentsinteger required

Number of payments

updated_atstring date-time nullable

Date of update in database

Example response

[
  {
    "asset": {
      "asset_ref": "native",
      "code": "BTC",
      "decimals": 11,
      "display_ticker": "BTC",
      "name": "Bitcoin"
    },
    "balance": {
      "available_msat": 989999000,
      "fees_paid_msat": 1000,
      "received_msat": 1000000000,
      "reserved_msat": 2000,
      "sent_msat": 10000000
    },
    "ln_address": {
      "nostr_pubkey": "d9c2ec59a98c..."
    }
  }
]

Changes

  • 44b172644309Revision changes
    • info

      added the required property ////// to the response with the status

  • 2aba664778fbRevision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status