Accounts

Retrieves account information including metadata for a specific account address. Requires ledger:read scope.

get/v3/{ledgerName}/accounts/{address}

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/{ledgerName}/accounts/{address}
  • Auth
    • HTTP bearer
    • or none

Path parameters

ledgerNamestring required

Name of the ledger

addressstring required
Example:users:001

Raw account address, for example users:001. Direct HTTP clients may URL-encode it as one path segment (users%3A001). Decoded exactly once.

Query parameters

collapseColorsboolean

When true, every colored bucket of the same asset is summed into a single AccountVolume entry with color = "". By default each (asset, color) tuple is returned as its own entry.

Headers

X-Consistency'linearizable' | 'stale'

Read consistency. linearizable (the default) runs a Raft ReadIndex barrier and waits for the receiving node to apply up to it. stale serves the read from the receiving node's own store, with no barrier and no forwarding to the leader, so the answer may lag the leader. Matching ignores case and surrounding whitespace. An unknown value, or a repeated or comma-joined header, returns 400 INVALID_REQUEST on every /v3 route, writes included; a valid value has no effect on writes. The gRPC equivalent is the x-consistency request metadata.

Formance-Bigint-As-Stringstring

Render all response Uint256, BigUint and SignedBigInt values as canonical decimal strings, regardless of business meaning, including posting amounts, volume input/output and balances. Ordinary integer IDs/counts, metadata and explicitly string-encoded counters keep their existing representation. Case-insensitive true, yes, y and 1 enable this option, matching Ledger v2. Whitespace is not trimmed. Omission and every other value retain JSON number tokens. This affects only this response, including nested objects, maps, arrays, transaction/log/cursor and bulk results. Request decoding is unchanged.

Response

Account retrieved successfully

Changes

    • info

      api operation id getAccount removed and replaced with v3GetAccount

    • breaking

      response property data/volumes/items/volumes/balance list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      response property data/volumes/items/volumes/input list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      response property data/volumes/items/volumes/output list-of-types was widened by adding types integer to media type application/json of response 200

    • info

      added the new optional header request parameter Formance-Bigint-As-String

    • info

      the //// response's property pattern ^(0|-?[1-9][0-9]*)$ was removed for the status

    • info

      the //// response's property pattern ^(0|[1-9][0-9]*)$ was removed for the status

    • info

      the //// response's property pattern ^(0|[1-9][0-9]*)$ was removed for the status