Appearance
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
| Method | Path | Auth | Credits | Description |
|---|---|---|---|---|
POST | /v1/collections | Yes | 5 Fuji / 15 Avalanche / 0 sandbox | Deploy NFT collection (name, symbol) |
GET | /v1/collections | Yes | — | List your collections |
GET | /v1/collections/:address | Yes | — | Get one collection (must own) |
Mint
| Method | Path | Auth | Credits | Description |
|---|---|---|---|---|
POST | /v1/collections/:address/mint | Yes | 1 (0 sandbox) | Mint to to |
POST | /v1/collections/:address/mint-with-metadata | Yes | 1 (0 sandbox) | Mint + metadata values (keys must exist) |
POST | /v1/collections/:address/mint-batch | Yes | Fuji ceil(n/6) / live ceil(n/2) | Batch mint; optional values all-or-nothing |
Management (free)
| Method | Path | Description |
|---|---|---|
POST | .../freeze | Freeze account (account in body) |
POST | .../unfreeze | Unfreeze account |
POST | .../lock-transfers | Lock transfers |
POST | .../unlock-transfers | Unlock transfers |
POST | .../pause | Pause collection |
POST | .../unpause | Unpause collection |
POST | .../registry/approve | Approve registry operator |
POST | .../registry/unapprove | Unapprove registry operator |
Metadata (free)
| Method | Path | Description |
|---|---|---|
POST | .../metadata/keys | Set ERC-8048 keys once |
POST | .../metadata/:tokenId | Set values for a token |
State
| Method | Path | Auth | Description |
|---|---|---|---|
GET | /v1/collections/:address/onchain | Yes | Read onchain collection state |
GET | /v1/collections/:address/tokens | Yes | Paginated 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.