> ## Documentation Index
> Fetch the complete documentation index at: https://docs.limitguard.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Financial Health

> Get overall financial system health status.

The settlement fields are operator-wide and only disclosed to admin keys; other callers do not receive them at all. So is
treasury_balance_usdc, the platform treasury rather than the caller's. Revenue scope follows the same split: an admin sees the
platform-wide total -- every key's prepaid revenue plus anonymous x402
wallet revenue that belongs to no tenant; anyone else sees only revenue
attributed to their own key.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/financial/health
openapi: 3.1.0
info:
  title: Limitguard.ai
  description: >-
    Lead validation API: the company behind each lead checked against the NL and
    BE business registers, EU VAT and sanctions lists, plus company, KYB and
    agent wallet checks for developers and AI agents
  version: 0.1.0
servers:
  - url: https://api.limitguard.ai
security: []
paths:
  /v1/financial/health:
    get:
      summary: Financial Health
      description: >-
        Get overall financial system health status.


        The settlement fields are operator-wide and only disclosed to admin
        keys; other callers do not receive them at all. So is

        treasury_balance_usdc, the platform treasury rather than the caller's.
        Revenue scope follows the same split: an admin sees the

        platform-wide total -- every key's prepaid revenue plus anonymous x402

        wallet revenue that belongs to no tenant; anyone else sees only revenue

        attributed to their own key.
      operationId: financial_health_v1_financial_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletHealth'
      security:
        - APIKeyHeader: []
components:
  schemas:
    WalletHealth:
      properties:
        treasury_balance_usdc:
          type: number
          minimum: 0
          title: Treasury Balance Usdc
        frozen:
          type: boolean
          title: Frozen
          default: false
        pending_settlements:
          type: integer
          minimum: 0
          title: Pending Settlements
          description: >-
            Pending rows still inside the sweep's retry budget (in-flight). Rows
            the sweep cannot rebuild into a payment are charged the same budget,
            so they drain to exhausted_settlements rather than sitting here
            forever
        exhausted_settlements:
          type: integer
          minimum: 0
          title: Exhausted Settlements
          description: >-
            Pending rows whose sweep_attempts reached MAX_RETRIES: credited,
            never settled, no longer retried. Not included in
            pending_settlements
          default: 0
        failed_settlements:
          type: integer
          minimum: 0
          title: Failed Settlements
          description: >-
            Ledger rows the startup sweep resolved to FAILED. These are no
            longer counted by pending_settlements, so without this they would
            disappear from the health view entirely.
          default: 0
        uncollected_usdc:
          type: number
          minimum: 0
          title: Uncollected Usdc
          description: >-
            USDC credited to the ledger that will never settle: exhausted
            PENDING plus FAILED rows, excluding rows written off (, see
            written_off_usdc). Reconciliation work, expressed as money rather
            than as two row counts.
          default: 0
        written_off_usdc:
          type: number
          minimum: 0
          title: Written Off Usdc
          description: >-
            USDC on ledger rows an operator wrote off as never settling:
            excluded from exhausted_settlements, failed_settlements and
            uncollected_usdc, summed here so the loss stays visible.
          default: 0
        settlement_configured:
          type: boolean
          title: Settlement Configured
          description: >-
            True when the EVM settler would run (SETTLEMENT_RPC_URL and
            SETTLEMENT_PRIVATE_KEY both set). EVM leg only; see
            solana_settlement_configured for the other leg. When False, EVM rows
            stay pending indefinitely
          default: false
        solana_settlement_configured:
          type: boolean
          title: Solana Settlement Configured
          description: >-
            True when the Solana settler would run (SOLANA_RPC_URL and
            SOLANA_FEE_PAYER_PRIVATE_KEY both set). All three settlement
            counters above are chain-mixed, so both flags must be read to know
            whether they are trustworthy. When False, Solana rows stay pending
            indefinitely
          default: false
        total_revenue_usdc:
          type: number
          minimum: 0
          title: Total Revenue Usdc
        agents_tracked:
          type: integer
          minimum: 0
          title: Agents Tracked
        failed_settlement_queue_depth:
          type: integer
          minimum: 0
          title: Failed Settlement Queue Depth
          default: 0
        solana_fee_payer_balance_sol:
          anyOf:
            - type: number
            - type: 'null'
          title: Solana Fee Payer Balance Sol
          description: >-
            Fee payer's SOL balance, or null when solana_settlement_configured
            is false or the RPC read failed (not the same as a genuine zero).
        solana_fee_payer_low_balance:
          type: boolean
          title: Solana Fee Payer Low Balance
          description: >-
            True when solana_fee_payer_balance_sol is below
            SOLANA_FEE_PAYER_LOW_BALANCE_SOL (default 0.05). Always false when
            the balance could not be read.
          default: false
      type: object
      required:
        - treasury_balance_usdc
        - pending_settlements
        - total_revenue_usdc
        - agents_tracked
      title: WalletHealth
      description: Financial system health status.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.