# Description Of SRR Data

{% hint style="info" %}
Please note that we may add a new field. So make sure that your implementation can support accepting new fields without breaking your implementation. In case we remove the field, we will deprecate it first and let you know beforehand.
{% endhint %}

{% hint style="warning" %}
**Source of truth: subgraph + IPFS CDN gateway**

The fields below mirror the Startrail [subgraph](/subgraph/subgraph.md) schema. The Get SRR REST endpoints are thin convenience wrappers that proxy this data; for richer / faster / more flexible queries, query the subgraph directly.

The `metadata` JSON itself lives on IPFS and is fetched from the [Startrail IPFS CDN gateway](/subgraph/ipfs-cdn-gateway.md) (`https://cdn.startrail.io/ipfs/<metadataDigest>`). The same gateway also serves any image and attachment file CIDs that appear inside the metadata.
{% endhint %}

<mark style="color:red;">\*</mark> indicates field that will always exist

| Name                                                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Type      | Example             |
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------- |
| id<mark style="color:red;">\*</mark>                   | Subgraph SRR id (`<collectionAddress>-<tokenId>`)                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string    |                     |
| tokenId<mark style="color:red;">\*</mark>              | NFT token ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | string    |                     |
| ownerAddress                                           | Current owner EOA / contract address.                                                                                                                                                                                                                                                                                                                                                                                                                                                                | string    |                     |
| isPrimaryIssuer                                        | true if it's primary sales                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | boolean   |                     |
| artistAddress                                          | Artist LUW wallet address                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string    |                     |
| metadataDigest<mark style="color:red;">\*</mark>       | IPFS CID of the SRR metadata JSON. Resolve via the [Startrail IPFS CDN gateway](/subgraph/ipfs-cdn-gateway.md) at `https://cdn.startrail.io/ipfs/<metadataDigest>`.                                                                                                                                                                                                                                                                                                                                  | string    | `bafkrei…`          |
| transferCommitment                                     | If set, the SRR currently has a pending transfer commitment hash.                                                                                                                                                                                                                                                                                                                                                                                                                                    | string    |                     |
| lockExternalTransfer                                   | If true, standard ERC721 transfer methods are disabled for this SRR.                                                                                                                                                                                                                                                                                                                                                                                                                                 | boolean   |                     |
| royaltyReceiver                                        | EIP-2981 royalty receiver address.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | string    |                     |
| royaltyBasisPoints                                     | EIP-2981 royalty basis points (e.g. `1570` = 15.70%).                                                                                                                                                                                                                                                                                                                                                                                                                                                | number    |                     |
| createdAt<mark style="color:red;">\*</mark>            | Time when SRR was minted on chain.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Date      |                     |
| updatedAt<mark style="color:red;">\*</mark>            | Time when SRR data was last updated on chain.                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Date      |                     |
| issuer.walletAddress<mark style="color:red;">\*</mark> | Issuer LUW wallet address                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string    |                     |
| issuer.originalName<mark style="color:red;">\*</mark>  | Issuer name (originalName)                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | string    |                     |
| issuer.englishName<mark style="color:red;">\*</mark>   | Issuer name (EN)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | string    |                     |
| issuer.userType<mark style="color:red;">\*</mark>      | User type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string    | 'artist', 'handler' |
| issuer.salt                                            | LUW salt                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | string    |                     |
| issuer.owners                                          | EOA owners of the LUW                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | string\[] |                     |
| issuer.threshold                                       | Multisig threshold of the LUW                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number    |                     |
| issuer.createdAt<mark style="color:red;">\*</mark>     | Time when issuer LUW was created                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Date      |                     |
| issuer.updatedAt<mark style="color:red;">\*</mark>     | Time when issuer LUW was updated                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Date      |                     |
| artist.walletAddress<mark style="color:red;">\*</mark> | Artist LUW wallet address                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string    |                     |
| artist.originalName<mark style="color:red;">\*</mark>  | Artist name (originalName)                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | string    |                     |
| artist.englishName<mark style="color:red;">\*</mark>   | Artist name (EN)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | string    |                     |
| artist.userType<mark style="color:red;">\*</mark>      | User type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string    | 'artist', 'handler' |
| artist.salt                                            | LUW salt                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | string    |                     |
| artist.owners                                          | EOA owners of the LUW                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | string\[] |                     |
| artist.threshold                                       | Multisig threshold of the LUW                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number    |                     |
| artist.createdAt<mark style="color:red;">\*</mark>     | Time when artist LUW was created                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Date      |                     |
| artist.updatedAt<mark style="color:red;">\*</mark>     | Time when artist LUW was updated                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Date      |                     |
| collection                                             | Collection the SRR belongs to. Absent for SRRs not issued under a custom collection.                                                                                                                                                                                                                                                                                                                                                                                                                 | object    |                     |
| collection.id                                          | Collection contract address (lowercased).                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string    |                     |
| collection.name                                        | Name of collection                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | string    |                     |
| collection.symbol                                      | Symbol of collection                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | string    |                     |
| collection.ownerAddress                                | Owner LUW wallet address of the collection                                                                                                                                                                                                                                                                                                                                                                                                                                                           | string    |                     |
| collection.createdAt                                   | Time when collection was created                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | Date      |                     |
| collection.updatedAt                                   | Time when collection was last updated                                                                                                                                                                                                                                                                                                                                                                                                                                                                | Date      |                     |
| metadata                                               | <p>Raw SRR metadata JSON fetched from IPFS via the Startrail IPFS CDN gateway.<br><br>Only present on endpoints that aggregate the metadata (e.g. <a href="/pages/Zw64KJiFT5upn7IxhswK">Get Owned SRRs</a>). For <a href="/pages/qlXBPGW7iA7bCtQeBfrc">Get SRR by Token Id</a>, fetch it yourself from <code>[https://cdn.startrail.io/ipfs/\&#x3C;metadataDigest>](https://cdn.startrail.io/ipfs/\&#x3C;metadataDigest>)</code>. See <a href="/pages/Ll08JupmVgJ6aILTc8tT">Metadata Schema</a>.</p> | Object    |                     |
| metadataHistory                                        | History of metadata changes (each entry has its own `metadataDigest` CID).                                                                                                                                                                                                                                                                                                                                                                                                                           | Array     |                     |
| history                                                | History of custom-history attachments to the SRR. See [Custom Histories](/metadata-schema/custom-history.md).                                                                                                                                                                                                                                                                                                                                                                                        | Array     |                     |
| provenance                                             | Subgraph provenance entries (raw on-chain transfer events). See [Transfer](/metadata-schema/transfer.md).                                                                                                                                                                                                                                                                                                                                                                                            | Array     |                     |
| customHistories                                        | Aggregated custom histories (only on aggregating endpoints).                                                                                                                                                                                                                                                                                                                                                                                                                                         | Array     |                     |
| transfers                                              | Aggregated provenance / transfers with metadata (only on aggregating endpoints).                                                                                                                                                                                                                                                                                                                                                                                                                     | Array     |                     |

Example

```json
{
  "id": "0x7942627305545af0e6c826d54cc9b2c5d190a874-227890056407",
  "tokenId": "227890056407",
  "ownerAddress": "0x2B8A689885278012a7681C3A37aC33B9357eFA2F",
  "isPrimaryIssuer": true,
  "artistAddress": "0xd80228C535e52470C2034491cFE9dF1F840caFB9",
  "metadataDigest": "bafkreiabepvyxyetkcb3xbjo3ocuyfo6psv3rc3yj34hequwcsilyvjima",
  "transferCommitment": null,
  "lockExternalTransfer": false,
  "royaltyReceiver": "0xA6E6a9E20a541680a1D6E1412f5088AefBF58a22",
  "royaltyBasisPoints": 1570,
  "createdAt": "2023-08-12T10:21:33.000Z",
  "updatedAt": "2023-09-03T04:11:02.000Z",
  "issuer": {
    "id": "0xa6e6a9e20a541680a1d6e1412f5088aefbf58a22",
    "walletAddress": "0xA6E6a9E20a541680a1D6E1412f5088AefBF58a22",
    "salt": "0x...",
    "owners": ["0x..."],
    "originalName": "issuer original name",
    "englishName": "issuer english name",
    "userType": "handler",
    "threshold": 1,
    "createdAt": "2022-04-14T03:15:35.153Z",
    "updatedAt": "2022-04-14T03:15:35.153Z"
  },
  "artist": {
    "id": "0xd80228c535e52470c2034491cfe9df1f840cafb9",
    "walletAddress": "0xd80228C535e52470C2034491cFE9dF1F840caFB9",
    "salt": "0x...",
    "owners": ["0x..."],
    "originalName": "Willem de Kooning",
    "englishName": "William de Kooning",
    "userType": "artist",
    "threshold": 1,
    "createdAt": "2020-10-23T07:54:54.486Z",
    "updatedAt": "2020-10-23T07:54:54.486Z"
  },
  "collection": {
    "id": "0x7942627305545af0e6c826d54cc9b2c5d190a874",
    "name": "collection name",
    "symbol": "T22",
    "ownerAddress": "0xA6E6a9E20a541680a1D6E1412f5088AefBF58a22",
    "createdAt": "2023-08-01T06:00:00.000Z",
    "updatedAt": "2023-08-01T06:00:00.000Z"
  },
  "metadata": {
    // Raw SRR metadata JSON, fetched from the Startrail IPFS CDN gateway
    // at https://cdn.startrail.io/ipfs/<metadataDigest>.
    // See the Metadata Schema section for the full schema.
  },
  "metadataHistory": [
    {
      "metadataDigest": "bafkreiabepvyxyetkcb3xbjo3ocuyfo6psv3rc3yj34hequwcsilyvjima",
      "createdAt": "2023-08-12T10:21:33.000Z"
    }
  ],
  "history": [],
  "provenance": [],
  "customHistories": [],
  "transfers": []
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.startrail.io/get-srr-api/description-of-srr-data.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
