Description Of SRR Data

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.

* indicates field that will always exist

Name	Description	Type	Example
tokenId*	NFT ID	string
status*	Mining status	string	'draft', 'waiting_for_mining', 'issued', 'failed'
isPrimaryIssuer*	true if it's primary sales	boolean
issuedAt*	Time when NFT is minted on chain	Date
createdAt*	Time when artwork data is registered on Port. dashboard	Date
updatedAt*	Time when artwork data is updated on Port. dashboard	Date
srrOwnable.ownerAddress	NFT's Owner EOA address	string
srrOwnable.createdAt	Creation date of SRR Ownable. This does not important in client's side.	Date
srrOwnable.updatedAt	Update date of SRR Ownable. This does not important in client's side.	Date
certOwnable	[DEPRECATED] Changed into srrOwndable	Object
issuer.contractAddress*	Issuer EOA address	string
issuer.originalName*	Issuer name (originalName)	string
issuer.englishName*	Issuer name (EN)	string
issuer.userType*	User type	string	'artist', 'handler'
issuer.createdAt*	Time when issuer data is created	Date
issuer.updatedAt*	Time when issuer data is updated	Date
artist.contractAddress*	Artist EOA address	string
artist.originalName*	Artist name (originalName)	string
artist.englishName*	Artist name (EN)	string
artist.userType*	User type	string	'artist', 'handler'
artist.createdAt*	Time when artist data is created	Date
artist.updatedAt*	Time when artist data is updated	Date
metadata.digest*	Digest calculated with metadata itself	string
metadata.json*	Metadata json data field could change based on schema version update See Metadata Schema	Object
metadata.createdAt*	Time when metadata is created	Date
metadata.updatedAt*	Time when metadata is updated	Date
metadata.cid	CID of the SRR metadata in IPFS. Refer to CID Documentation	string
customHistories	Custom History Array See Custom Histories	Object
collectionContractAddress	Address of collection contract. Does not always exist	string
collection	Collection .Does not always exist.	Object
collection.contractAddress	Address of collection contract	string
collection.name	Name of collection	string
collection.symbol	Symbol of collection	string

Example

{
  "tokenId": "6460655",
  "status": "issued",
  "isPrimaryIssuer": true,
  "issuedAt": "2021-05-17T05:31:51.000Z",
  "createdAt": "2020-10-23T08:41:59.949Z",
  "updatedAt": "2021-05-17T05:32:16.000Z",
  "srOwnable": {
    "ownerAddress": "0x2B8A689885278012a7681C3A37aC33B9357eFA2F",
    "createdAt": "2021-01-27T02:36:00.457Z",
    "updatedAt": "2021-01-27T02:36:00.457Z"
  },
  "artist": {
    "contractAddress": "0xd80228C535e52470C2034491cFE9dF1F840caFB9",
    "originalName": "Willem de Kooning",
    "englishName": "William de Kooning",
    "userType": "artist",
    "createdAt": "2020-10-23T07:54:54.486Z",
    "updatedAt": "2020-10-23T07:54:54.486Z"
  },
  "metadata": {
    "digest": "7dd366baa375c83d8a379bb4af12fef77f04c2b6ec46e3dbcbf1902f9145263d",
    "json": {
	      // Check Response Data Description section below for Artwork Metadata
    },
  "customHistories": [
    {
      "id": 9,
      "digest": "11a023bffc0145c6d3fce17ca249eb3715bf2a931f73d769e975d90f4ecd15a9",
      "json": {
        "city": "Tokyo",
        "venue": {
          "en": "Online",
          "ja": "オンライン",
          "zh": "一个标题"
        },
        "period": {
          "to": "2020-03-21",
          "from": "2020-01-23"
        },
        "$schema": "https://api.startrail.io/api/v1/customHistories/metadata/custom-history-of-auction-metadata.schema.json",
        "hostLUW": "0x8DFea3525EE810A7FEa886Fee69c57e68B5d5052",
        "saleName": {
          "en": "AuctionM_201207",
          "ja": "オークション ABC"
        },
        "historyType": "auction",
        "hostCountry": "JP"
      },
      "historyType": "auction",
      "name": "AuctionM_201207",
      "collectionContractAddress": "0x5B8A689885278012a7681C3A37aC33B9357eFA2F",
      "collection": {
        "contractAddress": "0x5B8A689885278012a7681C3A37aC33B9357eFA2F",
        "name": "collection name",
        "symbol": "collection-symbol"
      },
      "createdAt": "2020-12-07T06:56:05.859Z",
      "updatedAt": "2020-12-07T06:56:05.859Z"
    }
  ]
}