POST
/
assets
List IP Assets
curl --request POST \
  --url https://api.storyapis.com/api/v4/assets \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "includeLicenses": false,
  "moderated": false,
  "orderBy": "blockNumber",
  "orderDirection": "desc",
  "pagination": {
    "limit": 20,
    "offset": 0
  },
  "where": {
    "ipIds": [
      "<string>"
    ],
    "ownerAddress": "<string>",
    "tokenContract": "<string>"
  }
}'
{
  "$schema": "https://api.storyapis.com/api/v4/IPAssetsResponseHumaBody.json",
  "data": [
    {
      "ancestorsCount": 123,
      "blockNumber": 123,
      "chainId": "<string>",
      "childrenCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "descendantsCount": 123,
      "description": "<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"
        }
      ],
      "ipId": "<string>",
      "ipaMetadataUri": "<string>",
      "isInGroup": true,
      "lastUpdatedAt": "2023-11-07T05:31:56Z",
      "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"
        }
      ],
      "logIndex": 123,
      "moderationStatus": {
        "adult": "<string>",
        "medical": "<string>",
        "racy": "<string>",
        "spoof": "<string>",
        "violence": "<string>"
      },
      "name": "<string>",
      "nftMetadata": {
        "animation": {
          "cachedUrl": "<string>",
          "contentType": "<string>",
          "originalUrl": "<string>",
          "size": 123
        },
        "collection": {
          "bannerImageUrl": "<string>",
          "externalUrl": "<string>",
          "name": "<string>",
          "slug": "<string>"
        },
        "contract": {
          "address": "<string>",
          "chain": "<string>",
          "contractDeployer": "<string>",
          "deployedBlockNumber": 123,
          "name": "<string>",
          "openSeaMetadata": {
            "bannerImageUrl": "<string>",
            "collectionName": "<string>",
            "collectionSlug": "<string>",
            "description": "<string>",
            "discordUrl": "<string>",
            "externalUrl": "<string>",
            "floorPrice": 123,
            "imageUrl": "<string>",
            "lastIngestedAt": "2023-11-07T05:31:56Z",
            "safelistRequestStatus": "<string>",
            "twitterUsername": "<string>"
          },
          "symbol": "<string>",
          "tokenType": "<string>",
          "totalSupply": "<string>"
        },
        "contract_address": "<string>",
        "description": "<string>",
        "image": {
          "cachedUrl": "<string>",
          "contentType": "<string>",
          "originalUrl": "<string>",
          "pngUrl": "<string>",
          "size": 123,
          "thumbnailUrl": "<string>"
        },
        "mint": {
          "blockNumber": 123,
          "mintAddress": "<string>",
          "timestamp": "<string>",
          "transactionHash": "<string>"
        },
        "name": "<string>",
        "nft_id": "<string>",
        "raw": "<any>",
        "timeLastUpdated": "2023-11-07T05:31:56Z",
        "tokenId": "<string>",
        "tokenType": "<string>",
        "tokenUri": "<string>"
      },
      "ownerAddress": "<string>",
      "parentsCount": 123,
      "registrationDate": "<string>",
      "rootIPs": [
        "<string>"
      ],
      "title": "<string>",
      "tokenContract": "<string>",
      "tokenId": "<string>",
      "txHash": "<string>",
      "uri": "<string>"
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

X-Api-Key
string
header
required

Body

application/json
includeLicenses
boolean

Include license information in response

Examples:

false

moderated
boolean

Filter for moderated content only

Examples:

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

where
object

Optional filter options for IP assets

Response

OK

data
object[] | null
required

List of enriched IP assets

$schema
string<uri>

A URL to the JSON Schema for this object.

Examples:

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

pagination
object

Pagination metadata