Skip to content

Collections ​

Deploy collections, mint, manage onchain controls, and set ERC-8048 metadata. Related guides: Getting Started, Credits, Sandbox.

App-level ownership is enforced in the API database. Onchain admin remains the deployer; the API signs as that role holder. Metadata (tokenURI) is built by the shared onchain token descriptor from ERC-8048 keys/values.

TIP

Full request/response schemas coming soon. Use the curl examples in Getting Started for create/mint.

CRUD ​

MethodPathAuthCreditsDescription
POST/v1/collectionsYes5 Fuji / 15 Avalanche / 0 sandboxDeploy NFT collection (name, symbol)
GET/v1/collectionsYes—List your collections
GET/v1/collections/:addressYes—Get one collection (must own)

Mint ​

MethodPathAuthCreditsDescription
POST/v1/collections/:address/mintYes1 (0 sandbox)Mint to to
POST/v1/collections/:address/mint-with-metadataYes1 (0 sandbox)Mint + metadata values (keys must exist)
POST/v1/collections/:address/mint-batchYesFuji ceil(n/6) / live ceil(n/2)Batch mint; optional values all-or-nothing

Management (free) ​

MethodPathDescription
POST.../freezeFreeze account (account in body)
POST.../unfreezeUnfreeze account
POST.../lock-transfersLock transfers
POST.../unlock-transfersUnlock transfers
POST.../pausePause collection
POST.../unpauseUnpause collection
POST.../registry/approveApprove registry operator
POST.../registry/unapproveUnapprove registry operator

Metadata (free) ​

MethodPathDescription
POST.../metadata/keysSet ERC-8048 keys once
POST.../metadata/:tokenIdSet values for a token

State ​

MethodPathAuthDescription
GET/v1/collections/:address/onchainYesRead onchain collection state
GET/v1/collections/:address/tokensYesPaginated items via tokenByIndex + decoded tokenURI

List tokens ​

GET /v1/collections/:address/tokens?cursor=&limit=
  • cursor — offset into the enumerable supply (omit for the first page)
  • limit — page size (default 24, max 48)

Response:

json
{
  "totalSupply": "12",
  "page": [
    {
      "tokenId": "0",
      "owner": "0x…",
      "tokenURI": "data:application/json;base64,…",
      "metadata": {
        "name": "Star",
        "description": "…",
        "image": "ipfs://…",
        "attributes": [{ "trait_type": "rarity", "value": "rare" }]
      }
    }
  ],
  "nextCursor": "24"
}

If a single tokenURI/ownerOf read fails, that item is still returned with metadata: null rather than failing the page.