Royalty claims made by this DID, newest first

Claims only — the amounts already taken. For what is available to claim, see `/datasets/{id}/royalty-flow`. 200 with an empty page for an unknown DID.

GET

/v1/dids/{did}/royalty-history

Path Parameters

`did`
Required
string

Accepts did:xny:<uuid>, did:xny:<decimal>, bare <uuid> or bare <decimal>. Percent-encoded forms work too — the handler unescapes first, so did%3Axny%3A... from encodeURIComponent resolves correctly.

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

`cursor`string

Opaque cursor from a previous response's pagination.nextCursor. Omit for the first page. A malformed cursor is a 400.

curl -X GET "http://lineage-api.xny-staging.svc.cluster.local:8001/v1/dids/string/royalty-history?token=native&from=0&to=0&limit=1&cursor=string"

A page of past claims.

{
  "items": [
    {
      "datasetId": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41",
      "blockNumber": 0,
      "token": "native",
      "recipient": "string",
      "amount": "string",
      "txHash": "0x807bacabedff64313f86ee41a00c566462c8b6fc807bacabedff64313f86ee41"
    }
  ],
  "pagination": {
    "limit": 0,
    "nextCursor": "string",
    "hasMore": true
  }
}

Royalty claims made by this DID, newest first

Path Parameters

didRequiredstring

Query Parameters

tokenstring

frominteger

tointeger

limitinteger

cursorstring

Response