wallet

List hot wallets, optionally filtered or searched by payment source, type and free text. (read access required)

Changed on

Lists hot wallets across payment sources with cursor-based pagination. searchQuery applies before pagination, so a wallet beyond the first page is still found.

get/wallet/list

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/wallet/list
  • Auth: API key in header token

Query parameters

takenumber

The number of wallets to return

cursorIdstring

Used to paginate through the wallets (provide the id of the last returned wallet)

paymentSourceIdstring

Filter wallets to a single payment source

walletType'Selling' | 'Purchasing' | 'Funding'

Filter wallets by type (Selling, Purchasing or Funding)

walletVkeystring

Filter to the single wallet with this payment key hash

walletAddressstring

Filter to wallets with this Cardano address

searchQuerystring

Free-text search applied before pagination, so a wallet beyond the first page is still found. Matches wallet address, collection address, note, payment key hash and id (case-insensitive substring), and the wallet type by either its API name ("Purchasing") or the label the admin UI renders ("Buying"). "%" and "_" are matched literally. Balance is not searchable: it is read from the chain, not stored. Combined with the exact filters above as a logical AND.

Response

Paginated list of hot wallets

status'success' required

Example response

{
  "status": "success",
  "data": {
    "Wallets": [
      {
        "id": "unique_cuid_v2_auto_generated",
        "paymentSourceId": "unique_cuid_v2_of_payment_source",
        "type": "Selling",
        "walletVkey": "wallet_vkey",
        "walletAddress": "wallet_address",
        "collectionAddress": null,
        "note": "note",
        "LowBalanceSummary": {
          "isLow": false,
          "lowRuleCount": 0,
          "lastCheckedAt": "1970-01-20T20:00:36.260Z"
        }
      }
    ]
  }
}

Changes