v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

IP Story Protocol

Get IP Asset Licenses

Get the licenses of an IP Asset

The ipassetId parameter should be the Story Protocol asset ID (not the Crossmint ID). Must start with '0x' followed by hexadecimal characters.

API scope required: nfts.read

get/v1/ip/licenses/{ipassetId}

Path parameters

ipassetIdstring required

Headers

X-API-KEYstring required

API key required for authentication

Response

IP Asset License found

idstring required

The License Terms ID

disabledboolean

If true, the license terms will be disabled. Effectively preventing future mints with this license.

Example response

[
  {
    "id": "155",
    "terms": {
      "transferable": true,
      "royaltyPolicy": "0x1234567890123456789012345678901234567890",
      "defaultMintingFee": 100,
      "expiration": 0,
      "commercialUse": true,
      "commercialAttribution": true,
      "commercializerChecker": "0x0000000000000000000000000000000000000000",
      "commercializerCheckerData": "0x0000000000000000000000000000000000000000",
      "commercialRevShare": 10000000,
      "commercialRevCeiling": 0,
      "derivativesAllowed": true,
      "derivativesAttribution": true,
      "derivativesApproval": false,
      "derivativesReciprocal": true,
      "derivativeRevCeiling": 0,
      "currency": "0x1234567890123456789012345678901234567890",
      "uri": "Will contain a reference to the license terms metadata"
    },
    "disabled": false
  }
]