Get account by its address

GET /api/ledger/{ledger}/accounts/{address}

Try it

Get account by its address

cURL

curl --request GET \
  --url http://localhost/api/ledger/{ledger}/accounts/{address} \
  --header 'Authorization: Bearer <token>'

200

{
  "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
    }
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

ledger · string · required

Name of the ledger.

Example:

"ledger001"

address · string · required

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

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

Example:

"users:001"

Response

200

application/json

OK

data · object · required

Show child attributes

data. address · string · required

Example:

"users:001"

data. type · string

Example:

"virtual"

data. metadata · object

Example:

{
  "admin": true,
  "a": { "nested": { "key": "value" } }
}

data. volumes · object

Show child attributes

data.volumes. {key} · object

Show child attributes

data.volumes.{key}. input · integer<bigint> · required

data.volumes.{key}. output · integer<bigint> · required

data.volumes.{key}. balance · integer<bigint>

Example:

{ "input": 100, "output": 20, "balance": 80 }

Example:

{
  "USD": { "input": 100, "output": 10, "balance": 90 },
  "EUR": { "input": 100, "output": 10, "balance": 90 }
}

data. balances · object

Show child attributes

data.balances. {key} · integer<bigint>

Example:

{ "COIN": 100 }