API Reference
The read endpoints of the public lineage API, and where to find the parts a schema cannot describe.
This reference is generated from lineage-api 1.3.0 and covers its 26 public endpoints.
Every page under this section is generated from the service's own OpenAPI document, one page per endpoint, grouped the way the API groups itself. What you get there is exact: paths, parameters, response shapes, and the field descriptions the service ships.
What you do not get there is everything you need to use it. An OpenAPI document describes the shape of a call, not the conventions around it — how an identifier is written, what an integer enum means, how a cursor behaves, or how long after a write a read reflects it. That material is prose:
Worth reading before the first call:
| Access | Base URL, and what authentication is and is not required |
| Identifiers | bytes32 hex versus a DID's two renderings — the same value appears both ways, and one endpoint returns it as a decimal string |
| Enum values | kind, verdict, qualityGrade, taskType and execution come back as raw on-chain integers. This is the key |
| Pagination | Cursors are opaque and must be handed back verbatim |
| Eventual consistency | A write is not readable the instant it lands on chain |
| Errors | The error body's shape, and the codes it carries |
If you would rather start by making a call than by reading, that page opens with a five-step walkthrough — read a CF, follow its task, campaign and frontier, then list the task’s CFs — each step a request you can paste.
Two other surfaces are documented elsewhere, and neither is in this section. The metadata documents are what a publisher writes and anchors, rather than what this API returns. The Explorer's key concepts page carries the live network and contract addresses, which stay there because they are rendered from the same code the Explorer's own pages read.
What this section does not cover
Seven of the endpoints in the service's document are deliberately absent here, and the public service withholds the same set:
- Probes, whose contract is that an operator may change them at will —
/health,/ready. - Page-shaped reads served to internal consumers, where publishing them would commit an external contract to following the Explorer's interface —
/v1/cfs/{cf_id}/overview,/v1/datasets/{id}/overview,/v1/dids/{did}/owned,/v1/frontiers/{id}/activity,/v1/search.
If an endpoint you can call is missing from these pages, that is a bug in this site rather than a policy: the list above is read out of the same Go the public service enforces its own exclusions with, so the two cannot disagree without failing this site's build.
Last updated