Protocol API Overview
Collections
IPLicenseTerms
LicenseTemplates
LicenseTerms
LicenseTokens
Permissions
IPAssets
List IPAssets
Retrieve a paginated, filtered list of IPAssets
POST
/
api
/
v3
/
assets
curl --request POST \
--url https://api.storyapis.com/api/v3/assets \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--header 'X-Chain: <x-chain>' \
--data '{
"options": {
"ipAssetIds": [
"<string>"
],
"orderBy": "id",
"orderDirection": "asc",
"pagination": {
"after": "<string>",
"before": "<string>",
"limit": 123
},
"tokenContractIds": [
"<string>"
],
"tokenIds": [
"<string>"
],
"where": {
"blockNumber": "<string>",
"blockNumberGte": "<string>",
"blockNumberLte": "<string>",
"id": "<string>",
"ipId": "<string>",
"tokenContract": "<string>",
"tokenId": "<string>"
}
}
}'{
"data": [
{
"ancestorCount": 123,
"blockNumber": "<string>",
"blockTimestamp": "<string>",
"childrenCount": 123,
"descendantCount": 123,
"id": "<string>",
"ipId": "<string>",
"isGroup": true,
"latestArbitrationPolicy": "<string>",
"nftMetadata": {
"chainId": "<string>",
"imageUrl": "<string>",
"name": "<string>",
"tokenContract": "<string>",
"tokenId": "<string>",
"tokenUri": "<string>"
},
"parentCount": 123,
"rootCount": 123,
"rootIpIds": [
"<string>"
],
"transactionHash": "<string>"
}
],
"hasNextPage": true,
"hasPreviousPage": true,
"next": "<string>",
"prev": "<string>"
}Important! You must include an options object in your request body (though it can be left empty), otherwise your API call will not work!
When testing on this API Playground, you can do this by just inputting dummy fields to an options property and deleting it.
Headers
API Key
Chain Destination
Body
application/json
Available options:
id, blockNumber, ipId, resourceType Available options:
asc, desc Response
200 - application/json
OK
curl --request POST \
--url https://api.storyapis.com/api/v3/assets \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <x-api-key>' \
--header 'X-Chain: <x-chain>' \
--data '{
"options": {
"ipAssetIds": [
"<string>"
],
"orderBy": "id",
"orderDirection": "asc",
"pagination": {
"after": "<string>",
"before": "<string>",
"limit": 123
},
"tokenContractIds": [
"<string>"
],
"tokenIds": [
"<string>"
],
"where": {
"blockNumber": "<string>",
"blockNumberGte": "<string>",
"blockNumberLte": "<string>",
"id": "<string>",
"ipId": "<string>",
"tokenContract": "<string>",
"tokenId": "<string>"
}
}
}'{
"data": [
{
"ancestorCount": 123,
"blockNumber": "<string>",
"blockTimestamp": "<string>",
"childrenCount": 123,
"descendantCount": 123,
"id": "<string>",
"ipId": "<string>",
"isGroup": true,
"latestArbitrationPolicy": "<string>",
"nftMetadata": {
"chainId": "<string>",
"imageUrl": "<string>",
"name": "<string>",
"tokenContract": "<string>",
"tokenId": "<string>",
"tokenUri": "<string>"
},
"parentCount": 123,
"rootCount": 123,
"rootIpIds": [
"<string>"
],
"transactionHash": "<string>"
}
],
"hasNextPage": true,
"hasPreviousPage": true,
"next": "<string>",
"prev": "<string>"
}