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

# Read public settlement state.

Public explorer surface for receipt roots, recent receipt commitments, payout batch state, pending payout counts, and finalized payout counts. It omits customer IDs, raw request or response content, API keys, customer tokens, and private routing details. 

` GET /v1/public/settlement `

Read public settlement state.

Public explorer surface for receipt roots, recent receipt commitments,
payout batch state, pending payout counts, and finalized payout counts.
It omits customer IDs, raw request or response content, API keys,
customer tokens, and private routing details.


## Servers

- ` https://{controlPlaneHost} `

  - ` controlPlaneHost `: default ` control.example.test ` — B3IQ control-plane host for operational/admin paths.

## Parameters

### ` limit ` (query, optional)

Maximum recent receipt commitments to return.

- ` value `: type ` integer `

  - default: ` 25 `

  - minimum: ` 1 `

  - maximum: ` 100 `

### ` batch_limit ` (query, optional)

Maximum recent payout settlement batches to return.

- ` value `: type ` integer `

  - default: ` 10 `

  - minimum: ` 1 `

  - maximum: ` 50 `

## Responses

### ` 200 ` — Public-safe settlement state.

Content type: ` application/json `

- ` value `: type ` object `

  - ` protocol `: type ` object `

  - ` payout_settlement `: type ` object `

    - ` network_name `: type ` string `

    - ` chain_id `: type ` string `

    - ` rpc_url `: type ` string `

    - ` explorer_url `: type ` string `

    - ` contract_address `: type ` string `

    - ` event_topic `: type ` string `

  - ` summary `: type ` object `

    - ` accepted_receipts `: type ` integer `

    - ` pending_receipts `: type ` integer `

    - ` pending_root `: type ` string `

      - pattern: ` "^sha256:[a-f0-9]{64}$" `

    - ` latest_receipt_at `: type ` string `; nullable; format ` date-time `

    - ` settlement_ready `: type ` boolean `

    - ` payouts `: type ` object `

      - ` total_payouts `: type ` integer `

      - ` pending_payouts `: type ` integer `

      - ` batched_payouts `: type ` integer `

      - ` submitting_payouts `: type ` integer `

      - ` submitted_payouts `: type ` integer `

      - ` finalized_payouts `: type ` integer `

      - ` latest_payout_at `: type ` string `; nullable; format ` date-time `

      - ` latest_finalized_payout_at `: type ` string `; nullable; format ` date-time `

      - ` by_kind `: type ` array `

        - ` array item `: type ` object `

          - ` kind `: type ` string `

          - ` total_payouts `: type ` integer `

          - ` pending_payouts `: type ` integer `

          - ` finalized_payouts `: type ` integer `

          - ` latest_payout_at `: type ` string `; nullable; format ` date-time `

    - ` payout_batches `: type ` object `

      - ` total_batches `: type ` integer `

      - ` created_batches `: type ` integer `

      - ` submitting_batches `: type ` integer `

      - ` submitted_batches `: type ` integer `

      - ` completed_batches `: type ` integer `

      - ` latest_batch_at `: type ` string `; nullable; format ` date-time `

      - ` latest_finalized_batch_at `: type ` string `; nullable; format ` date-time `

  - ` receipts `: type ` array `

    - ` array item `: type ` object `

      - ` receipt_hash `: type ` string `

        - pattern: ` "^sha256:[a-f0-9]{64}$" `

      - ` node_id `: type ` string `

      - ` job_id `: type ` string `

      - ` node_class `: type ` string `

      - ` model_id `: type ` string `

      - ` status `: type ` string `

      - ` received_at `: type ` string `; format ` date-time `

      - ` batch_id `: type ` string `; nullable

  - ` payout_batches `: type ` array `

    - ` array item `: type ` object `

      - ` batch_id `: type ` string `

      - ` merkle_root `: type ` string `

        - pattern: ` "^sha256:[a-f0-9]{64}$" `

      - ` payout_count `: type ` integer `

      - ` total_amount_wei `: type ` string `

      - ` status `: type ` string `

      - ` submitted_tx_hash `: type ` string `; nullable

      - ` created_at `: type ` string `; format ` date-time `

      - ` submitted_at `: type ` string `; nullable; format ` date-time `

      - ` completed_at `: type ` string `; nullable; format ` date-time `

      - ` finalized_at `: type ` string `; nullable; format ` date-time `

      - ` settlement_block_number `: type ` string `; nullable

      - ` settlement_block_hash `: type ` string `; nullable

### ` default ` — B3IQ-native problem response.

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` object `

    - Required fields: ` status `, ` title `, ` detail `

    - ` status `: type ` integer `

    - ` title `: type ` string `

    - ` detail `: type ` string `

    - ` code `: type ` string ` — Stable B3IQ code when present. See docs/error-codes.md.

## Request examples

### cURL

```curl
curl -X GET 'https://control.example.test/v1/public/settlement'
```

### JavaScript

```javascript
const response = await fetch('https://control.example.test/v1/public/settlement', {
  method: 'GET'
});

const data = await response.json();
console.log(data);
```