Get Wallet

Retrieve a single wallet by ID.

Endpoint

GET /api/v3/fermata/wallet/get?walletId={walletId}

Description

Returns the wallet object including type, status, and metadata.

Authentication

Requires Bearer token authentication.

Authorization: Bearer {access_token}

Query Parameters

Parameter	Type	Required	Description
walletId	string	Yes	Wallet ID

Response

Returns the wallet object.

Field	Type	Description
walletId	string	Wallet ID
walletType	string	Wallet type (DEALER, CLIENT, EXCHANGE, ACCOUNTING)
status	string	Wallet status (ACTIVE, FROZEN, CLOSED)
allowNegative	boolean	Whether negative balances are allowed
metadata	object	Additional attributes
createdAt	integer	Creation timestamp (milliseconds)
updatedAt	integer	Last update timestamp (milliseconds)

Usage

import requests

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

response = requests.get(
    "https://cadenza-api.algo724.com/api/v3/fermata/wallet/get",
    headers=headers,
    params={"walletId": "880e8400-e29b-41d4-a716-446655440000"}
)

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

curl -X GET "https://cadenza-api.algo724.com/api/v3/fermata/wallet/get?walletId=880e8400-e29b-41d4-a716-446655440000" \
  -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
}

Error Responses

HTTP Code	Error	Description
400	Invalid request	Missing walletId
401	Unauthorized	Invalid or expired access token
403	Forbidden	Insufficient permissions
404	Not found	Wallet not found

Example Error

{
  "data": null,
  "success": false,
  "errno": -140002,
  "error": "Wallet not found: 880e8400-e29b-41d4-a716-446655440000"
}

Notes

• Users can only query their own wallets
• Admin users can query any wallet
• Use the portfolio endpoint to get wallet balances