Skip to main content
GET
/
api
/
ledger
/
v2
/
{ledger}
/
accounts
/
{address}
Get account by its address
curl --request GET \
  --url http://localhost/api/ledger/v2/{ledger}/accounts/{address} \
  --header 'Authorization: Bearer <token>'
{
  "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
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve details for a specific account including its balances and metadata.

​
Parameters

ledger: The name of the ledger containing the account. (e.g., ledger001) address: The account address. Uses colon-separated segments (e.g., users:john:wallet). Pattern must match ^\w+(:\w+)*$. (e.g., users:john:wallet) expand: Include additional data. Use volumes to include balance and volume details. (e.g., volumes) pit: Point-in-time query. Returns account state as it existed at this timestamp. (e.g., 2024-01-15T10:30:00Z)

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"

Query Parameters

​
expand
string
​
pit
string<date-time>

Response

OK

​
data
object
required