API Reference
Wallets
- POSTCreate Wallet
- GETGet Wallet By Locator
- GETGet Wallet Balance
- POSTFund Wallet
- GETGet NFTs from Wallet
- POSTCreate Transaction
- GETGet Transaction
- GETGet Wallet Transactions
- POSTApprove Transaction
- POSTCreate Signature
- GETGet All Signatures
- GETGet Signature
- POSTApprove Signature
- POSTRegister Delegated Signer
- GETGet Delegated Signer
- POSTSend Token
NFTs
IP
NFT Collections
NFT Templates
Verifiable Credentials
Verifiable Credential Types
Verifiable Credential Templates
Headless Checkout
Action Status
Admin
Subscriptions
Get IP Assets in Collection
Get all IP Assets in a collection
API scope required: nfts.read
curl --request GET \
--url https://staging.crossmint.com/api/v1/ip/collections/{collectionId}/ipassets \
--header 'X-API-KEY: <x-api-key>'[
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"nftMetadata": {
"name": "Art #123",
"description": "A unique story NFT",
"image": "https://example.com/nft/123.png"
},
"ipAssetMetadata": {
"title": "Harry Potter and the Philosopher's Stone",
"createdAt": "1997-06-26T00:00:00",
"ipType": "literature",
"creators": [
{
"name": "JK Rowling",
"email": "JKRowling@example.com",
"crossmintUserLocator": "email:JKRowling@example.com:story",
"description": "Author",
"contributionPercent": 80,
"socialMedia": [
{
"platform": "Wikipedia",
"url": "https://en.wikipedia.org/wiki/J._K._Rowling"
}
]
},
{
"name": "Thomas Taylor",
"address": "0x1234567890123456789012345678901234567890",
"description": "Illustrator",
"contributionPercent": 15
},
{
"name": "Bloomsbury Publishing",
"email": "BloomsburyPublishing@example.com",
"address": "0x1234567890123456789012345678901234567890",
"description": "Publisher",
"contributionPercent": 5,
"socialMedia": [
{
"platform": "Website",
"url": "https://www.bloomsbury.com/"
}
]
}
],
"media": [
{
"name": "ePub",
"url": "link_to_epub",
"mimeType": "application/epub+zip"
},
{
"name": "Book Summary PDF",
"url": "link_to_book_summary_pdf",
"mimeType": "application/pdf"
}
],
"attributes": [
{
"key": "ISBN",
"value": "978-0-7475-3269-0"
},
{
"key": "Genre",
"value": "Fantasy"
}
]
},
"onChain": {
"status": "success",
"chain": "story-testnet",
"contractAddress": "0x123",
"ipAssetId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"tokenId": "1",
"txId": "0x123",
"explorerLink": "https://explorer.story.foundation/ipa/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280",
"owner": "0x123"
},
"licenseTerms": [
{
"type": "non-commercial-social-remixing",
"licenseTermsId": 1
}
],
"derivData": {
"parentIpIds": [
"0x123"
],
"licenseTermsIds": [
1
],
"maxMintingFee": 0,
"maxRevenueShare": 100,
"maxRts": 10000000
}
},
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"nftMetadata": {
"name": "Art #123",
"description": "A unique story NFT",
"image": "https://example.com/nft/123.png"
},
"ipAssetMetadata": {
"title": "Harry Potter and the Philosopher's Stone",
"createdAt": "1997-06-26T00:00:00",
"ipType": "literature",
"creators": [
{
"name": "JK Rowling",
"email": "JKRowling@example.com",
"crossmintUserLocator": "email:JKRowling@example.com:story",
"description": "Author",
"contributionPercent": 80,
"socialMedia": [
{
"platform": "Wikipedia",
"url": "https://en.wikipedia.org/wiki/J._K._Rowling"
}
]
},
{
"name": "Thomas Taylor",
"address": "0x1234567890123456789012345678901234567890",
"description": "Illustrator",
"contributionPercent": 15
},
{
"name": "Bloomsbury Publishing",
"email": "BloomsburyPublishing@example.com",
"address": "0x1234567890123456789012345678901234567890",
"description": "Publisher",
"contributionPercent": 5,
"socialMedia": [
{
"platform": "Website",
"url": "https://www.bloomsbury.com/"
}
]
}
],
"media": [
{
"name": "ePub",
"url": "link_to_epub",
"mimeType": "application/epub+zip"
},
{
"name": "Book Summary PDF",
"url": "link_to_book_summary_pdf",
"mimeType": "application/pdf"
}
],
"attributes": [
{
"key": "ISBN",
"value": "978-0-7475-3269-0"
},
{
"key": "Genre",
"value": "Fantasy"
}
]
},
"onChain": {
"status": "success",
"chain": "story-testnet",
"contractAddress": "0x123",
"ipAssetId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"tokenId": "1",
"txId": "0x123",
"explorerLink": "https://explorer.story.foundation/ipa/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280",
"owner": "0x123"
},
"licenseTerms": [
{
"type": "non-commercial-social-remixing",
"licenseTermsId": 1
}
],
"derivData": {
"parentIpIds": [
"0x123"
],
"licenseTermsIds": [
1
],
"maxMintingFee": 0,
"maxRevenueShare": 100,
"maxRts": 10000000
}
}
]Headers
API key required for authentication
Path Parameters
Response
The id of the IPAsset
The action id for the IPAsset creation
Metadata for the NFT representation of this IP asset
5000Metadata containing information about the IP asset itself
Title of the IP
Information about the IP creators
0 < x < 100The creator of the IP asset email
A internal locator for the creator of the IP asset, crossmint will automatically map this to the correct wallet address, not required if address is specified, is always required for the main creator(owner): Allowed formats:
<chain>:<address> or
email:<email_address>:<chain> or
userId:<userId>:<chain> or
twitter:<twitter_handle>:<chain>
Wallet address of the IP creator. This field is optional only if a crossmint user locator is specified
Description of the IP
Creation date of the IP (ISO8601 or unix format)
The detailed relationship info with the IPA's direct parent asset, such as APPEARS_IN, FINETUNED_FROM, etc. See more examples https://docs.story.foundation/docs/ipa-metadata-standard#relationship-types
A separate image with your watermark already applied. This way apps choosing to use it can render this version of the image (with watermark applied).
Type of the IP Asset, can be defined arbitrarily by the creator. I.e. "character", "chapter", "location", "items", "music", etc
Any tags that can help surface this IPA
The address of the collection on the chain
The status of the IP asset on the chain
success The id of the IP asset on the chain. This ID is also the address of the IP Account that is bound to the IP Asset.
The token id of the associatedNFT
The transaction id of the IP asset creation on chain
The owner of the IP asset
The chain of the collection
The explorer link of the ip asset
Licensing parameters for the IP asset
non-commercial-social-remixing Additional license terms that are stored off-chain due to their descriptive nature
Limit usage of the IP to certain regions and/or countries. By default, the IP can be used globally.
Restrict usage of the IP to certain media formats and channels of distribution. By default, the IP can be used across all possible channels.
Set content standards around use of the IP. By default, no standards apply.
If true, derivative works can grant the same rights they received under this license to a 3rd party, without approval from the original licensor.
Whether or not the IP can be used to develop AI learning models. By default, the IP cannot be used for such development.
If true, limits licensing and creation of derivative works solely on the app on which the IP is made available.
The laws of a certain jurisdiction by which this license abides. By default, this is California, USA.
License terms stored off-chain
Data for the parent IP asset and license terms (for derivative IP assets only)
The parent IP IDs of the derivative IP asset
The license terms IDs of the derivative IP asset
The max minting fee of the derivative IP asset
The max revenue share of the derivative IP asset
The max RTS of the derivative IP asset
Was this page helpful?
curl --request GET \
--url https://staging.crossmint.com/api/v1/ip/collections/{collectionId}/ipassets \
--header 'X-API-KEY: <x-api-key>'[
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"nftMetadata": {
"name": "Art #123",
"description": "A unique story NFT",
"image": "https://example.com/nft/123.png"
},
"ipAssetMetadata": {
"title": "Harry Potter and the Philosopher's Stone",
"createdAt": "1997-06-26T00:00:00",
"ipType": "literature",
"creators": [
{
"name": "JK Rowling",
"email": "JKRowling@example.com",
"crossmintUserLocator": "email:JKRowling@example.com:story",
"description": "Author",
"contributionPercent": 80,
"socialMedia": [
{
"platform": "Wikipedia",
"url": "https://en.wikipedia.org/wiki/J._K._Rowling"
}
]
},
{
"name": "Thomas Taylor",
"address": "0x1234567890123456789012345678901234567890",
"description": "Illustrator",
"contributionPercent": 15
},
{
"name": "Bloomsbury Publishing",
"email": "BloomsburyPublishing@example.com",
"address": "0x1234567890123456789012345678901234567890",
"description": "Publisher",
"contributionPercent": 5,
"socialMedia": [
{
"platform": "Website",
"url": "https://www.bloomsbury.com/"
}
]
}
],
"media": [
{
"name": "ePub",
"url": "link_to_epub",
"mimeType": "application/epub+zip"
},
{
"name": "Book Summary PDF",
"url": "link_to_book_summary_pdf",
"mimeType": "application/pdf"
}
],
"attributes": [
{
"key": "ISBN",
"value": "978-0-7475-3269-0"
},
{
"key": "Genre",
"value": "Fantasy"
}
]
},
"onChain": {
"status": "success",
"chain": "story-testnet",
"contractAddress": "0x123",
"ipAssetId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"tokenId": "1",
"txId": "0x123",
"explorerLink": "https://explorer.story.foundation/ipa/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280",
"owner": "0x123"
},
"licenseTerms": [
{
"type": "non-commercial-social-remixing",
"licenseTermsId": 1
}
],
"derivData": {
"parentIpIds": [
"0x123"
],
"licenseTermsIds": [
1
],
"maxMintingFee": 0,
"maxRevenueShare": 100,
"maxRts": 10000000
}
},
{
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"nftMetadata": {
"name": "Art #123",
"description": "A unique story NFT",
"image": "https://example.com/nft/123.png"
},
"ipAssetMetadata": {
"title": "Harry Potter and the Philosopher's Stone",
"createdAt": "1997-06-26T00:00:00",
"ipType": "literature",
"creators": [
{
"name": "JK Rowling",
"email": "JKRowling@example.com",
"crossmintUserLocator": "email:JKRowling@example.com:story",
"description": "Author",
"contributionPercent": 80,
"socialMedia": [
{
"platform": "Wikipedia",
"url": "https://en.wikipedia.org/wiki/J._K._Rowling"
}
]
},
{
"name": "Thomas Taylor",
"address": "0x1234567890123456789012345678901234567890",
"description": "Illustrator",
"contributionPercent": 15
},
{
"name": "Bloomsbury Publishing",
"email": "BloomsburyPublishing@example.com",
"address": "0x1234567890123456789012345678901234567890",
"description": "Publisher",
"contributionPercent": 5,
"socialMedia": [
{
"platform": "Website",
"url": "https://www.bloomsbury.com/"
}
]
}
],
"media": [
{
"name": "ePub",
"url": "link_to_epub",
"mimeType": "application/epub+zip"
},
{
"name": "Book Summary PDF",
"url": "link_to_book_summary_pdf",
"mimeType": "application/pdf"
}
],
"attributes": [
{
"key": "ISBN",
"value": "978-0-7475-3269-0"
},
{
"key": "Genre",
"value": "Fantasy"
}
]
},
"onChain": {
"status": "success",
"chain": "story-testnet",
"contractAddress": "0x123",
"ipAssetId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"tokenId": "1",
"txId": "0x123",
"explorerLink": "https://explorer.story.foundation/ipa/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280",
"owner": "0x123"
},
"licenseTerms": [
{
"type": "non-commercial-social-remixing",
"licenseTermsId": 1
}
],
"derivData": {
"parentIpIds": [
"0x123"
],
"licenseTermsIds": [
1
],
"maxMintingFee": 0,
"maxRevenueShare": 100,
"maxRts": 10000000
}
}
]