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": true,
"moderated": true,
"orderBy": "blockNumber",
"orderDirection": "desc",
"pagination": {
"limit": 20,
"offset": 0
},
"where": {
"ipIds": [
"<string>"
],
"ownerAddress": "<string>",
"tokenContract": "<string>"
}
}
'import requests
url = "https://api.storyapis.com/api/v4/assets"
payload = {
"includeLicenses": True,
"moderated": True,
"orderBy": "blockNumber",
"orderDirection": "desc",
"pagination": {
"limit": 20,
"offset": 0
},
"where": {
"ipIds": ["<string>"],
"ownerAddress": "<string>",
"tokenContract": "<string>"
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
includeLicenses: true,
moderated: true,
orderBy: 'blockNumber',
orderDirection: 'desc',
pagination: {limit: 20, offset: 0},
where: {ipIds: ['<string>'], ownerAddress: '<string>', tokenContract: '<string>'}
})
};
fetch('https://api.storyapis.com/api/v4/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.storyapis.com/api/v4/assets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'includeLicenses' => true,
'moderated' => true,
'orderBy' => 'blockNumber',
'orderDirection' => 'desc',
'pagination' => [
'limit' => 20,
'offset' => 0
],
'where' => [
'ipIds' => [
'<string>'
],
'ownerAddress' => '<string>',
'tokenContract' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.storyapis.com/api/v4/assets"
payload := strings.NewReader("{\n \"includeLicenses\": true,\n \"moderated\": true,\n \"orderBy\": \"blockNumber\",\n \"orderDirection\": \"desc\",\n \"pagination\": {\n \"limit\": 20,\n \"offset\": 0\n },\n \"where\": {\n \"ipIds\": [\n \"<string>\"\n ],\n \"ownerAddress\": \"<string>\",\n \"tokenContract\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.storyapis.com/api/v4/assets")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"includeLicenses\": true,\n \"moderated\": true,\n \"orderBy\": \"blockNumber\",\n \"orderDirection\": \"desc\",\n \"pagination\": {\n \"limit\": 20,\n \"offset\": 0\n },\n \"where\": {\n \"ipIds\": [\n \"<string>\"\n ],\n \"ownerAddress\": \"<string>\",\n \"tokenContract\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.storyapis.com/api/v4/assets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"includeLicenses\": true,\n \"moderated\": true,\n \"orderBy\": \"blockNumber\",\n \"orderDirection\": \"desc\",\n \"pagination\": {\n \"limit\": 20,\n \"offset\": 0\n },\n \"where\": {\n \"ipIds\": [\n \"<string>\"\n ],\n \"ownerAddress\": \"<string>\",\n \"tokenContract\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}
],
"moderationStatus": {
"adult": "<string>",
"medical": "<string>",
"racy": "<string>",
"spoof": "<string>",
"violence": "<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": "<unknown>",
"timeLastUpdated": "2023-11-07T05:31:56Z",
"tokenId": "<string>",
"tokenType": "<string>",
"tokenUri": "<string>"
}
}
],
"$schema": "<string>",
"pagination": {
"hasMore": true,
"limit": 123,
"offset": 123,
"total": 123
}
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Endpoints
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 --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>"
}
}
'import requests
url = "https://api.storyapis.com/api/v4/assets"
payload = {
"includeLicenses": True,
"moderated": True,
"orderBy": "blockNumber",
"orderDirection": "desc",
"pagination": {
"limit": 20,
"offset": 0
},
"where": {
"ipIds": ["<string>"],
"ownerAddress": "<string>",
"tokenContract": "<string>"
}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
includeLicenses: true,
moderated: true,
orderBy: 'blockNumber',
orderDirection: 'desc',
pagination: {limit: 20, offset: 0},
where: {ipIds: ['<string>'], ownerAddress: '<string>', tokenContract: '<string>'}
})
};
fetch('https://api.storyapis.com/api/v4/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.storyapis.com/api/v4/assets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'includeLicenses' => true,
'moderated' => true,
'orderBy' => 'blockNumber',
'orderDirection' => 'desc',
'pagination' => [
'limit' => 20,
'offset' => 0
],
'where' => [
'ipIds' => [
'<string>'
],
'ownerAddress' => '<string>',
'tokenContract' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.storyapis.com/api/v4/assets"
payload := strings.NewReader("{\n \"includeLicenses\": true,\n \"moderated\": true,\n \"orderBy\": \"blockNumber\",\n \"orderDirection\": \"desc\",\n \"pagination\": {\n \"limit\": 20,\n \"offset\": 0\n },\n \"where\": {\n \"ipIds\": [\n \"<string>\"\n ],\n \"ownerAddress\": \"<string>\",\n \"tokenContract\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.storyapis.com/api/v4/assets")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"includeLicenses\": true,\n \"moderated\": true,\n \"orderBy\": \"blockNumber\",\n \"orderDirection\": \"desc\",\n \"pagination\": {\n \"limit\": 20,\n \"offset\": 0\n },\n \"where\": {\n \"ipIds\": [\n \"<string>\"\n ],\n \"ownerAddress\": \"<string>\",\n \"tokenContract\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.storyapis.com/api/v4/assets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"includeLicenses\": true,\n \"moderated\": true,\n \"orderBy\": \"blockNumber\",\n \"orderDirection\": \"desc\",\n \"pagination\": {\n \"limit\": 20,\n \"offset\": 0\n },\n \"where\": {\n \"ipIds\": [\n \"<string>\"\n ],\n \"ownerAddress\": \"<string>\",\n \"tokenContract\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}
],
"moderationStatus": {
"adult": "<string>",
"medical": "<string>",
"racy": "<string>",
"spoof": "<string>",
"violence": "<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": "<unknown>",
"timeLastUpdated": "2023-11-07T05:31:56Z",
"tokenId": "<string>",
"tokenType": "<string>",
"tokenUri": "<string>"
}
}
],
"$schema": "<string>",
"pagination": {
"hasMore": true,
"limit": 123,
"offset": 123,
"total": 123
}
}{
"$schema": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}Authorizations
Body
application/json
Include license information in response
Example:
false
Filter for moderated content only
Example:
false
Field to order results by
Available options:
descendantCount, blockNumber, createdAt Order direction for results
Available options:
asc, desc Pagination configuration
Show child attributes
Show child attributes
Optional filter options for IP assets
Show child attributes
Show child attributes
⌘I