XnY Protocol
ConceptsDeveloper
API ReferenceDatasets

Dataset derivation graph

Walks `previousDatasetId` edges. Because that link is enrichment-derived, a dataset whose `metadataStatus` is not `DONE` can return a single-node graph even though an ancestor exists on chain — an empty result means "nothing known yet", not "nothing there".

GET
/v1/datasets/{id}/lineage
/v1/datasets/{id}/lineage

Path Parameters

id
Required
string

The dataset version's 32-byte id.

Pattern: "^0[xX][0-9a-fA-F]{64}$"

Query Parameters

depthinteger

How many hops to walk. Default 2, hard cap 5. Unlike limit, exceeding the cap is a 400, not a clamp.

Default: 2Minimum: 0Maximum: 5

directionstring

Which way to walk: up toward ancestors, down toward descendants, or both. Empty is treated as both; any other value is a 400.

Default: "both"Value in: "up" | "down" | "both"

nodeLimitinteger

Cap on nodes returned, bounding payload size independently of depth. Default 50, hard cap 100; exceeding the cap is a 400, not a clamp. When the walk is cut short the response sets truncated: true.

Default: 50Minimum: 1Maximum: 100
curl -X GET "http://lineage-api.xny-staging.svc.cluster.local:8001/v1/datasets/0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41/lineage?depth=2&direction=up&nodeLimit=50"

The graph.

{
  "rootDatasetId": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
  "nodes": [
    {
      "datasetId": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
      "frontierId": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
      "versionNumber": 0,
      "totalShares": "string",
      "metadataStatus": "PENDING"
    }
  ],
  "edges": [
    {
      "from": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
      "to": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
      "type": "derived_from"
    }
  ],
  "truncated": true
}

Last updated

Previous

Frontier-membership verification state

Next

Royalty distributions and claims, paginated independently