Interface directory
26 interface contracts and 41 specifications across 40 repositories. Every link points at an exact commit, so what you read is what that repository published rather than whatever its branch happens to hold today.
REST APIs
| Repository | Contract | Form | Lifecycle |
|---|---|---|---|
| bitcoin-indexer | docs/api/ordinals-openapi.json | OpenAPI 3.1 | experimental |
| bitcoin-indexer | docs/api/runes-openapi.json | OpenAPI 3.1 | experimental |
| docs-core | public/openapi/core-public-read.json | OpenAPI 3.1 | experimental |
| index-patina | src/openapi.ts | OpenAPI 3.1 | stable |
| index-tandem | site/src/data/openapi.json | OpenAPI 3.1 | experimental |
| ord-dogecoin | openapi.yaml | OpenAPI 3.1 | experimental |
| ordex | spec/openapi.json | OpenAPI 3.1 | experimental |
| stampchain.io | static/swagger/openapi.yml | OpenAPI 3.1 | experimental |
Event and WebSocket interfaces
No repository currently declares a contract of this kind. When one does, it appears here automatically.
Data models and payload schemas
Command line interfaces
| Repository | Contract | Form | Lifecycle |
|---|---|---|---|
| witness-circles | src/cli.ts | CLI reference | experimental |
SDKs
| Repository | Contract | Form | Lifecycle |
|---|---|---|---|
| witness-circles | src/index.ts | SDK | experimental |
Protocol specifications
Normative specification documents. These are the authority for protocol rules; the Protocol Atlas summarises and compares them but never replaces them.
Public status endpoints
Endpoints repositories declare as safe to poll. Read live status for what the fields mean.
https://api.bitcoinuniverse.io/health(docs-core)https://api.bitcoinuniverse.io/indexer-health(docs-core)https://stamp.api.bitcoinuniverse.io/api/health(docs-stampdex)https://stamp.api.bitcoinuniverse.io/api/version(docs-stampdex)https://stamp.api.bitcoinuniverse.io/api/v1/indexer/status(docs-stampdex)https://forkedfelines.art/api/v1/product(forked-felines-docs)https://forkedfelines.art/api/v1/mint/capacity(forked-felines-docs)https://explorer.bitcoinuniverse.io/api/v1/backend-info(mempool)https://explorer.bitcoinuniverse.io/api/v1/capabilities(mempool)https://explorer.bitcoinuniverse.io/api/v1/chains(mempool)https://explorer.bitcoinuniverse.io/api/v1/universe/protocols(mempool)https://explorer.bitcoinuniverse.io/api/v1/universe/sources(mempool)
Conventions that hold across the estate
- Indexer route prefixes
- An indexer serves under its repository name with the
index-prefix removed. The Patina indexer serves under/patina/. - The contract wins
- Where a contract and its prose documentation disagree, the contract is correct and the prose is a bug. Report it against the owning repository.
- Availability states are part of the interface
- Responses distinguish unavailable from empty and unknown from zero. Collapsing those into "no results" corrupts anything computed downstream.
- No endpoint asks for key material
- Nothing in this estate asks for a seed phrase or a private key. Signing happens in your wallet.