HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2
GET

Explorer · settlements

Get compose the settlement evidence dashboard

/api/v2/explorer/settlements
AUTHENTICATIONNone · publicAUTHORITATIVE OWNERsettlement-evidence-read-modelCONTRACT AUTHORITYCapability registry · plannedSTATUSPlanned · not executable
PLANNING CONTRACT · NOT CALLABLE

This page describes intended capability and integration boundaries so people and agents can prepare safely. Do not send this request or register it as an executable tool. Wait until the capability registry marks it implemented-contract, then re-fetch the deployed OpenAPI document and build the request from that machine contract.

PURPOSE + BUSINESS CONTEXT

Planned capability: planning marker for the Explorer website's settlement dashboard composition. It is not an aggregate API endpoint: clients assemble the view from implemented settlement status, evidence, operations, bounded history, archive checkpoints, integrity audit, quorum canaries, authorization activations, wallet enrollments and activations, network-scoped faucet evidence, testnet infrastructure, synthetic assets, and funding settlement intents.

WHEN THIS CALL IS USEFUL

Do not call or register this operation as an executable agent tool yet. Use this page to plan the future compose the settlement evidence dashboard workflow; enable it only after the status becomes implemented-contract and the exact operation appears in deployed OpenAPI.

OUTCOME · Planned · Discover

What changes

None today: this route is not executable. Its intended behavior is: read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

  • Lets people and agents prepare for compose the settlement evidence dashboard without falsely presenting roadmap scope as a live capability.
  • Gives people and agents a contract-backed way to discover compose the settlement evidence dashboard.
  • Keeps website presentation separate from the stable public contract that wallets, indexers, and agents can ingest.

ISOLATION + AUTHORITY

This is a public, read-only Explorer projection. It exposes only fields admitted by the live OpenAPI schema; it grants no owner, wallet, signing, settlement, publisher, matching, or trading authority. Indexed observation time is not the same as chain finality. This planning record grants no runtime authority, and only deployed OpenAPI can define an executable public contract.

BEFORE YOU CALL

  • First confirm that this operation is marked implemented-contract and exists in the currently deployed OpenAPI document; until then, no production request is valid.
  • Its capability-registry profile is provisional integration guidance, not an executable request schema.
  • No bearer credential is required; apply bounded filters and canonical public identifiers where the contract provides them.
  • Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.
  • Account for projection freshness, indexing position, and chain or domain finality in the consuming decision.

WHAT TO DO NEXT

  • Keep this operation disabled in clients, agents, SDKs, and workflow automation while it remains planned-contract.
  • Use the stated owner, lifecycle, authority boundary, and provisional compose the settlement evidence dashboard profile to prepare requirements and conformance tests without sending a request.
  • Monitor the capability registry for implemented-contract, then re-fetch deployed OpenAPI and validate its exact security, parameters, schemas, responses, and agent metadata before enabling the integration.

AGENT GUIDANCE

  • Never call this planned contract, include it in an executable tool registry, or infer runtime availability from this readable page.
  • Its capability-registry profile is provisional integration guidance, not an executable request schema.
  • Use compose the settlement evidence dashboard only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Treat the capability-registry profile as design guidance only; deployed OpenAPI must define the executable request and response shapes.
  • Treat observation timestamps, indexing position, proof state, and finality as separate facts; do not infer final settlement or authority from presence in an Explorer result.
  • Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.
  • When implementation lands, discard generated requests based on this planning record and rebuild them from the deployed OpenAPI operation.
MACHINE CONTRACT

This operation is a non-executable planning contract. Its capability-registry record defines the intended owner, parameters, responses, and integration boundary until an implemented Rust OpenAPI operation replaces it.

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples describe the reviewed planning contract and remain non-executable until promoted into OpenAPI.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

RESPONSES

Status and payload examples

200Canonical resource projection.Not executable · JSON RESPONSE+
{
  "result": "See the operation's authoritative OpenAPI response schema."
}
INTEGRATION DECISION
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from indexed blocks, transactions, addresses, tokens, contracts, validators, governance, supply, and chain-health projections through an implemented operation.
ESCALATE WHEN
Escalate when canonical hashes, heights, finality, or index freshness disagree with an authoritative node or when a reorganization exceeds policy.
422Path, query, or body validation failed.Not executable · JSON RESPONSE+
{
  "code": "request_failed",
  "message": "Path, query, or body validation failed."
}
INTEGRATION DECISIONrequest_failed
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from indexed blocks, transactions, addresses, tokens, contracts, validators, governance, supply, and chain-health projections through an implemented operation.
ESCALATE WHEN
Escalate when canonical hashes, heights, finality, or index freshness disagree with an authoritative node or when a reorganization exceeds policy.
503The authoritative service or read model is unavailable.Not executable · JSON RESPONSE+
{
  "code": "request_failed",
  "message": "The authoritative service or read model is unavailable."
}
INTEGRATION DECISIONrequest_failed
CALLER ACTION
Do not send this request or register it as an executable agent tool. Use the implemented alternatives linked by the module guide.
RETRY SAFETY
Do not retry on a timer. Re-fetch production OpenAPI and proceed only after this exact operation appears there.
STATE RECONCILIATION
No runtime state exists to reconcile for this planning contract. Continue from indexed blocks, transactions, addresses, tokens, contracts, validators, governance, supply, and chain-health projections through an implemented operation.
ESCALATE WHEN
Escalate when canonical hashes, heights, finality, or index freshness disagree with an authoritative node or when a reorganization exceeds policy.

OPERATIONAL NOTES

Security and lifecycle guarantees

  • The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
DOCUMENTATION STATUS

This planned contract now defines its public parameters, authorization boundary, replay behavior, responses, and authoritative owner. It remains non-executable until its owner adapter and conformance tests are promoted into the Rust gateway.

Return to the V2 directory