v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
NFT Collections

Get Royalties Config

Fetch the royalty configuration for a collection, from its current state in the blockchain.

This API is only supported on EVM chains.

If you call GET too soon after PUT/DELETE, you may not yet see your latest changes, as they can take a few seconds to record on the blockchain.

API scope required: collections.read

get/v1-alpha1/minting/collections/{collectionId}/royalties

Path parameters

collectionIdstring required

This is the identifier for the collection related to the request. Every project has default collections: default-solana and default-polygon.

The create-collection API will result in collections with UUID formatted collectionId. Example: 9c82ef99-617f-497d-9abb-fd355291681b

The create-collection-idempotent API allows you to specify an arbitrary identifier during the initial request. Example: your-custom-identifier

Response

Success.

Example response

{
  "recipients": [
    {
      "address": "0x71C...",
      "basisPoints": 100
    }
  ]
}