List IP Assets

Retrieve a list of IP assets with pagination and filtering options. The ‘where’ field is optional and should only be provided when filtering by specific IP IDs, owner address, or token contract address. This endpoint can also be used to fetch a single asset by passing its ID in the ipIds filter.

POST /assets

List IP Assets

cURL

curl --request POST \
  --url https://api.storyapis.com/api/v4/assets \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "includeLicenses": true,
  "moderated": true,
  "orderBy": "blockNumber",
  "orderDirection": "desc",
  "pagination": {
    "limit": 20,
    "offset": 0
  },
  "where": {
    "ipIds": [
      "<string>"
    ],
    "ownerAddress": "<string>",
    "tokenContract": "<string>"
  }
}
'

200

{
  "data": [
    {
      "ancestorsCount": 123,
      "blockNumber": 123,
      "chainId": "<string>",
      "childrenCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "descendantsCount": 123,
      "description": "<string>",
      "ipId": "<string>",
      "isInGroup": true,
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "logIndex": 123,
      "name": "<string>",
      "ownerAddress": "<string>",
      "parentsCount": 123,
      "registrationDate": "<string>",
      "rootIPs": [
        "<string>"
      ],
      "title": "<string>",
      "tokenContract": "<string>",
      "tokenId": "<string>",
      "txHash": "<string>",
      "uri": "<string>",
      "infringementStatus": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "customData": "<string>",
          "infringementDetails": "<string>",
          "isInfringing": true,
          "providerName": "<string>",
          "providerURL": "<string>",
          "responseTime": "2023-11-07T05:31:56Z",
          "status": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "ipaMetadataUri": "<string>",
      "licenses": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "licenseTemplateId": "<string>",
          "licenseTermsId": "<string>",
          "licensingConfig": {
            "commercialRevShare": 123,
            "disabled": true,
            "expectGroupRewardPool": "<string>",
            "expectMinimumGroupRewardShare": 123,
            "hookData": "<string>",
            "isSet": true,
            "licensingHook": "<string>",
            "mintingFee": "<string>"
          },
          "templateMetadataUri": "<string>",
          "templateName": "<string>",
          "terms": {
            "commercialAttribution": true,
            "commercialRevCeiling": "<string>",
            "commercialRevShare": 123,
            "commercialUse": true,
            "commercializerChecker": "<string>",
            "commercializerCheckerData": "<string>",
            "currency": "<string>",
            "defaultMintingFee": "<string>",
            "derivativeRevCeiling": "<string>",
            "derivativesAllowed": true,
            "derivativesApproval": true,
            "derivativesAttribution": true,
            "derivativesReciprocal": true,
            "expiration": "<string>",
            "royaltyPolicy": "<string>",
            "transferable": true,
            "uri": "<string>"
          },
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "$schema": "<string>"
}

Authorizations

X-Api-Key · string · header · required

Body

application/json

includeLicenses · boolean

Include license information in response

Example:

false

moderated · boolean

Filter for moderated content only

Example:

false

orderBy · enum<string> · default: blockNumber

Field to order results by

Available options: descendantCount, blockNumber, createdAt

orderDirection · enum<string> · default: desc

Order direction for results

Available options: asc, desc

pagination · object

Pagination configuration

Show child attributes

where · object

Optional filter options for IP assets

Show child attributes

Response

200

application/json

OK

data · object[] | null · required

List of enriched IP assets

Show child attributes

$schema · string<uri>

A URL to the JSON Schema for this object.

Example:

"https://api.storyapis.com/api/v4/IPAssetsResponseHumaBody.json"

pagination · object

Pagination metadata

Show child attributes