Royalty distributions and claims, paginated independently

Both streams newest first. The filters apply to both; the cursors do not — each stream has its own. See the `RoyaltyFlow` schema for why this does not use the shared pagination shape.

GET

/v1/datasets/{id}/royalty-flow

Path Parameters

`id`
Required
string

The dataset version's 32-byte id.

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

Query Parameters

`token`string

Filter to one payment token. native or a 0x ERC-20 address.

`from`integer

Inclusive lower bound on block number. Omitting it is distinct from passing 0, so block 0 remains a usable filter value. Must be <= to.

Minimum: 0Format: "int64"

`to`integer

Inclusive upper bound on block number.

Minimum: 0Format: "int64"

`limit`integer

Page size. Server-configured default and ceiling (API_DEFAULT_LIMIT / API_MAX_LIMIT; 50 and 200 unless overridden). A value above the ceiling is silently clamped, not rejected — check pagination.limit in the response rather than assuming the requested value was honoured. Values below 1, or non-integers, are a 400.

Minimum: 1

`distCursor`string

Cursor for the distributions stream only. Note the name — this endpoint does not accept cursor.

`claimCursor`string

Cursor for the claims stream only.

curl -X GET "http://lineage-api.xny-staging.svc.cluster.local:8001/v1/datasets/0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41/royalty-flow?token=native&from=0&to=0&limit=1&distCursor=string&claimCursor=string"

One page of each stream.

{
  "datasetId": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
  "distributions": [
    {
      "blockNumber": 0,
      "token": "native",
      "totalAmount": "string",
      "platformFee": "string",
      "distributable": "string",
      "txHash": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41"
    }
  ],
  "claims": [
    {
      "blockNumber": 0,
      "token": "native",
      "contributorDidId": "00000000-0000-0000-0000-0000000007d1",
      "recipient": "string",
      "amount": "string",
      "txHash": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41"
    }
  ],
  "pagination": {
    "limit": 0,
    "distributionsHasMore": true,
    "claimsHasMore": true,
    "distributionsNextCursor": "string",
    "claimsNextCursor": "string"
  }
}

Royalty distributions and claims, paginated independently

Path Parameters

idRequiredstring

Query Parameters

tokenstring

frominteger

tointeger

limitinteger

distCursorstring

claimCursorstring

Response

TypeScript