v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB
ledger.v1

Get account by its address

get/{ledger}/accounts/{address}

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

addressstring required
Example:users:001

Exact address of the account. It must match the following regular expressions pattern:

^\w+(:\w+)*$

Response

OK

Example response

{
  "data": {
    "address": "users:001",
    "type": "virtual",
    "metadata": {
      "admin": true,
      "a": {
        "nested": {
          "key": "value"
        }
      }
    },
    "volumes": {
      "USD": {
        "input": 100,
        "output": 10,
        "balance": 90
      },
      "EUR": {
        "input": 100,
        "output": 10,
        "balance": 90
      }
    },
    "balances": {
      "COIN": 100
    }
  }
}