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
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.
Query Parameters
limit
integer
optional
query
Maximum recent receipt commitments to return.
batch_limit
integer
optional
query
Maximum recent payout settlement batches to return.
Responses
200
Public-safe settlement state.
application/jsonprotocol
object
summary
object
accepted_receipts
integer
pending_receipts
integer
pending_root
string
latest_receipt_at
string (date-time) | null
settlement_ready
boolean
payouts
object
total_payouts
integer
pending_payouts
integer
batched_payouts
integer
submitting_payouts
integer
submitted_payouts
integer
finalized_payouts
integer
latest_payout_at
string (date-time) | null
latest_finalized_payout_at
string (date-time) | null
payout_batches
object
total_batches
integer
created_batches
integer
submitting_batches
integer
submitted_batches
integer
completed_batches
integer
latest_batch_at
string (date-time) | null
latest_finalized_batch_at
string (date-time) | null
receipts
object[]
Array of:
receipt_hash
string
node_id
string
job_id
string
node_class
string
model_id
string
status
string
received_at
string (date-time)
batch_id
string | null
payout_batches
object[]
Array of:
batch_id
string
merkle_root
string
payout_count
integer
total_amount_wei
string
status
string
submitted_tx_hash
string | null
created_at
string (date-time)
submitted_at
string (date-time) | null
completed_at
string (date-time) | null
finalized_at
string (date-time) | null
settlement_block_number
string | null
settlement_block_hash
string | null
default
B3IQ-native problem response.
curl -X GET 'https://{controlPlaneHost}/v1/public/settlement'const response = await fetch('https://{controlPlaneHost}/v1/public/settlement', { method: 'GET'});const data = await response.json();console.log(data);
200
Response
{ "protocol": "<object>", "summary": { "accepted_receipts": 123, "pending_receipts": 123, "pending_root": "<string>", "latest_receipt_at": "2024-01-01T00:00:00Z", "settlement_ready": true, "payouts": { "total_payouts": 123, "pending_payouts": 123, "batched_payouts": 123, "submitting_payouts": 123, "submitted_payouts": 123, "finalized_payouts": 123, "latest_payout_at": "2024-01-01T00:00:00Z", "latest_finalized_payout_at": "2024-01-01T00:00:00Z" }, "payout_batches": { "total_batches": 123, "created_batches": 123, "submitting_batches": 123, "submitted_batches": 123, "completed_batches": 123, "latest_batch_at": "2024-01-01T00:00:00Z", "latest_finalized_batch_at": "2024-01-01T00:00:00Z" } }, "receipts": [ { "receipt_hash": "<string>", "node_id": "<string>", "job_id": "<string>", "node_class": "<string>", "model_id": "<string>", "status": "<string>", "received_at": "2024-01-01T00:00:00Z", "batch_id": "<string>" } ], "payout_batches": [ { "batch_id": "<string>", "merkle_root": "<string>", "payout_count": 123, "total_amount_wei": "<string>", "status": "<string>", "submitted_tx_hash": "<string>", "created_at": "2024-01-01T00:00:00Z", "submitted_at": "2024-01-01T00:00:00Z", "completed_at": "2024-01-01T00:00:00Z", "finalized_at": "2024-01-01T00:00:00Z", "settlement_block_number": "<string>", "settlement_block_hash": "<string>" } ]}API Playground
Try this endpoint
GET
/v1/public/settlement