List Wallets

List wallets with optional filtering.

Endpoint

GET /api/v3/fermata/wallet/list

Description

Returns a paginated list of wallets. Supports filtering by wallet type.

Authentication

Requires Bearer token authentication.

Authorization: Bearer {access_token}

Query Parameters

Parameter	Type	Required	Description
walletType	string	No	Filter by wallet type (DEALER, CLIENT, EXCHANGE, ACCOUNTING)
limit	integer	No	Maximum items to return (default: 10, max: 100)
offset	integer	No	Number of items to skip
cursor	string	No	Cursor for next page

Response

Returns an array of wallet objects with pagination.

Field	Type	Description
data	array	Array of wallet objects
data[].walletId	string	Wallet ID
data[].walletType	string	Wallet type
data[].status	string	Wallet status
data[].allowNegative	boolean	Whether negative balances allowed
data[].metadata	object	Additional attributes
data[].createdAt	integer	Creation timestamp (milliseconds)
data[].updatedAt	integer	Last update timestamp (milliseconds)
pagination	object	Pagination metadata

Usage

import requests

headers = {"Authorization": f"Bearer {access_token}"}

# List all client wallets
response = requests.get(
    "https://cadenza-api.algo724.com/api/v3/fermata/wallet/list",
    headers=headers,
    params={"walletType": "CLIENT", "limit": 20}
)

wallets = response.json()["data"]
for wallet in wallets:
    print(f"{wallet['walletId']}: {wallet['walletType']} ({wallet['status']})")

curl -X GET "https://cadenza-api.algo724.com/api/v3/fermata/wallet/list?walletType=CLIENT&limit=20" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Example Response

{
  "data": [
    {
      "walletId": "880e8400-e29b-41d4-a716-446655440000",
      "walletType": "CLIENT",
      "status": "ACTIVE",
      "allowNegative": false,
      "metadata": {
        "nickname": "Trading Wallet"
      },
      "createdAt": 1711929600000,
      "createdAtDateTime": "2025-04-01T00:00:00.000Z",
      "updatedAt": 1711929600000,
      "updatedAtDateTime": "2025-04-01T00:00:00.000Z"
    }
  ],
  "success": true,
  "errno": 0,
  "error": null,
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 1
  }
}

Error Responses

HTTP Code	Error	Description
400	Invalid request	Invalid query parameters
401	Unauthorized	Invalid or expired access token
403	Forbidden	Insufficient permissions

Example Error

{
  "data": null,
  "success": false,
  "errno": -140003,
  "error": "Invalid walletType: UNKNOWN"
}

Notes

• Regular users see only their own wallets
• Admin users can list all wallets, including dealer and exchange wallets