Transactions

Analyze transaction flow patterns

Changed on

Scans all transactions in a ledger, discovers flow patterns by normalizing account addresses, and returns statistics per flow type including temporal distribution and volume metrics. Requires ledger:read scope.

get/v3/{ledgerName}/analyze-transactions

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/{ledgerName}/analyze-transactions
  • Auth
    • HTTP bearer
    • or none

Path parameters

ledgerNamestring required

Name of the ledger

Query parameters

variableThresholdinteger

Max distinct children before classifying as variable (0 = default 10)

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

Analysis completed successfully

Changes

    • info

      api operation id analyzeTransactions removed and replaced with v3AnalyzeTransactions

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      response property data/flowPatterns/items/volumeStats/items/totalVolume 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