v1

latestOpenAPI 3.0.32026-07-1765123145.7 KB

ledger.v2

Get account by its address

get/v2/{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+)*$

Query parameters

expandstring

pitstring date-time

Response

Example response

{
  "data": {
    "address": "users:001",
    "metadata": {
      "admin": "true"
    },
    "insertionDate": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z",
    "firstUsage": "2023-01-01T00:00:00Z",
    "volumes": {
      "USD": {
        "input": 100,
        "output": 10,
        "balance": 90
      },
      "EUR": {
        "input": 100,
        "output": 10,
        "balance": 90
      }
    },
    "effectiveVolumes": {
      "USD": {
        "input": 100,
        "output": 10,
        "balance": 90
      },
      "EUR": {
        "input": 100,
        "output": 10,
        "balance": 90
      }
    }
  }
}