Get List Wallets

GET: {{endpoint}}/wallet/list

Headers

Key	Type	Value	Description
x-api-key	string	key_xxxxxxxxxxxxxxxxxxxx	API Key string
x-signature	string	SHA256	The HMAC SHA256 signature.
x-timestamp	string	1730998051892	Timestamp of the request

---

Request Parameters

Key	Type	Description
address	string	(Optional) the address of the wallet
chain	string	(Optional) the chain-id
wallet_type	string	(Optional) the type of wallet, Wallet Types
skip	number	(Optional) skip the first, default is 0
take	number	(Optional) take the first, default is 25
orderBy	string	(Optional) order by asc or desc, default is desc

Example Request

// Params: query
{
  "address": "0x849c4b408df9a63ab8543360e397f5d524483011",
  "chain": "bsc",
  "wallet_type": "RECEIPT",
  "skip": 0,
  "take": 25,
  "orderBy": "desc"
}

---

Response Parameters

The final response in the stream also includes additional data about the generation:

• items (Array): the list of wallets
• wallet_type: the type of wallet generated, Wallet Types
• chain: the blockchain network-id
• address: the public address of the wallet
• network: the network environment, e.g. testnet or mainnet
• unique_hash: a unique hash for the wallet, uniuqe key for the wallet
• pagination (Object): the pagination information
• total: the total number of wallets

Example Response

200: OK Success

{
  "data": {
    "items": [
      {
        "id": "6e8ebe97-880a-4beb-b2a3-6964f8971799",
        "wallet_type": "RECEIPT",
        "chain": "bsc",
        "address": "0x849c4b408df9a63ab8543360e397f5d524483011",
        "network": "testnet",
        "unique_hash": "98f022100a2633712ee90f668bd9f202f7431a0c6ddf395afdbd2324ef032865",
        "hdkey_id": "bsc-testnet",
        "index": 1000,
        "subscribe_id": null,
        "raw_user_meta": {},
        "is_activated": false,
        "created_at": "2024-11-03T08:05:06.360Z",
        "owned_by_group": "8e393308-28a9-4a6e-a689-0d7760483c7e",
        "agent_id": "aacc3472-f3c3-49bb-9040-d5a6aff283bf"
      }
    ],
    "pagination": {
      "total": 1
    }
  }
}

400: Bad Request

{
  "error": "Error message"
}

403: Forbidden

{
  "error": "Forbidden"
}