API reference · Wallets
List wallets
GET
/v1/walletsThe wallets your application may use, with their balances. Pages with a cursor.
Permission
wallets:readAuthenticationSigned read
Staff-set limits it counts towardAll requests
.NET SDK
anis.Wallets.ListAsync()Parameters
| Name | In | Type | Notes |
|---|---|---|---|
cursoroptional | query | string | The nextCursor of the previous page, passed back exactly as received. Leave it out for the first page. |
Request
Signed with your key. No body, no nonce.
Headers: Signature-Input, Signature, X-Anis-Date, Accept-Language (optional). The SDKs set all of them for you.
Body: none.
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Success. | WalletCollection |
| 401 | Refused: not authenticated. | Problem |
| 403 | Refused: not allowed. | Problem |
| 422 | Refused: the request breaks a rule. | Problem |
| 429 | Refused: a limit was reached. | Problem |
| 503 | No decision: a dependency was unavailable. | Problem |
Every answer is signed by Anis; the SDKs check it before you see it.
Refusals
Every refusal is a signed problem. Branch on its code; each links to what it means and what to do.
| Error | Code | Status |
|---|---|---|
| Invalid credentials | invalid_credentials | 401 |
| Insufficient scope | insufficient_scope | 403 |
| Source address not allowed | source_ip_not_allowed | 403 |
| Rate limited | rate_limited | 429 |
| Account not authorised | binding_not_authorized | 403 |
| Account inactive | account_inactive | 403 |
| Validation failed | validation_failed | 422 |
| Service unavailable | dependency_unavailable | 503 |
| Request timeout | request_timeout | 504 |
| Internal error | internal_error | 500 |
Types
WalletCollection
| Field | Type | Notes |
|---|---|---|
itemsalways present | list of Wallet | The wallets on this page. |
nextCursor | string | Pass it as cursor to get the next page. Absent on the last page. |
Wallet
| Field | Type | Notes |
|---|---|---|
idalways present | UUID | The wallet’s id. Every wallet-level call takes it in the address. |
namealways present | string | The wallet’s name. |
currencyalways present | string | The currency the wallet holds and buys in. |
balancealways present | Money | The balance you can spend now, with the moment it was read. |
Money
| Field | Type | Notes |
|---|---|---|
amountalways present | string | A decimal string with exactly three decimals, such as "10.500" — never a JSON number. |
currencyalways present | string | The currency code, such as LYD: always the wallet’s currency. |
asOf | string (date-time) | When this price or balance was read. |