Tokens

✅ Validado on-chain (Sepolia, ERC-4337)
Suite token — ciclo completo on-chain (Sepolia): deploy/mint/transfer/approve/burn/pause/unpause/royalty/permit/transfer_and_call + ERC20/721/1155/1363/Solady/SBT/ERC3643. 61 checagens.

Gerada automaticamente do spec OpenAPI da API (fonte de verdade). 31 endpoint(s).

List tokens

GET /v1/tokens

List all deployed token contracts

Auth: api-key

Respostas: 200, 401

---

Deploy token

POST /v1/tokens

Deploy a new ERC-20, ERC-721, ERC-1155, or ERC-3643 token contract

Auth: api-key

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 201, 400, 401

---

Get token

GET /v1/tokens/{id}

Get token details including on-chain state

Auth: api-key

Path params: id

Respostas: 200, 401, 404

---

Get allowance

GET /v1/tokens/{id}/allowance

Query ERC-20 allowance for spender

Auth: api-key

Path params: id

Respostas: 200, 401

---

Check approval for all

GET /v1/tokens/{id}/approval_for_all

Check if operator is approved for all tokens

Auth: api-key

Path params: id

Respostas: 200, 401

---

Get approved

GET /v1/tokens/{id}/approved

Query approved address for NFT

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Get balance

GET /v1/tokens/{id}/balance

Query token balance for address

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Get balance batch

GET /v1/tokens/{id}/balance_batch

Query batch balances (ERC-1155)

Auth: api-key

Path params: id

Respostas: 200, 401

---

Burn batch

POST /v1/tokens/{id}/burn_batch

Batch burn ERC-1155 tokens

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200, 400, 401

---

Cancel ownership handover

POST /v1/tokens/{id}/cancel_ownership_handover

Solady Ownable 2-step: requester cancels their handover request.

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200

---

Complete ownership handover

POST /v1/tokens/{id}/complete_ownership_handover

Solady Ownable 2-step: current owner accepts the handover request from pending_owner.

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200

---

Grant roles

POST /v1/tokens/{id}/grant_roles

Solady OwnableRoles: grant role bitmask to an address (admin only)

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200

---

Get SBT lock status

GET /v1/tokens/{id}/locked/{nftTokenId}

Check if an SBT (Soulbound Token / EIP-5192) is locked. Always returns true for existing tokens.

Auth: api-key

Path params: id, nftTokenId

Respostas: 200, 400, 401, 404

---

Mint batch

POST /v1/tokens/{id}/mint_batch

Batch mint ERC-1155 tokens

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200, 400, 401

---

List NFTs

GET /v1/tokens/{id}/nfts

List NFTs in a token contract

Auth: api-key

Path params: id

Respostas: 200, 401

---

Get NFT

GET /v1/tokens/{id}/nfts/{nftTokenId}

Get individual NFT details (ERC-721/1155)

Auth: api-key

Path params: id, nftTokenId

Respostas: 200, 400, 401, 404

---

Check ownership handover

GET /v1/tokens/{id}/ownership_handover

Check if a pending ownership handover exists and when it expires (Solady OwnableRoles only)

Auth: api-key

Path params: id

Respostas: 200, 400, 401, 404

---

Pause token

POST /v1/tokens/{id}/pause

Pause all transfers on the token contract

Auth: api-key

Path params: id

Respostas: 200, 401

---

Request ownership handover

POST /v1/tokens/{id}/request_ownership_handover

Solady Ownable 2-step: requester (new owner candidate) requests handover. Owner then accepts via complete_ownership_handover.

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200

---

Revoke roles

POST /v1/tokens/{id}/revoke_roles

Solady OwnableRoles: revoke role bitmask from an address (admin only)

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200

---

Get royalty info

GET /v1/tokens/{id}/royalty_info

Query ERC-2981 royaltyInfo for a given token and sale price

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Get supply

GET /v1/tokens/{id}/supply

Query total and max supply

Auth: api-key

Path params: id

Respostas: 200, 401

---

Check interface support

GET /v1/tokens/{id}/supports_interface

Check if a deployed contract supports a specific interface (ERC-165)

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Get token by index

GET /v1/tokens/{id}/token_by_index

Query the NFT token ID at a given index (ERC-721 Enumerable)

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Check token exists

GET /v1/tokens/{id}/token_exists

Check if ERC-1155 token ID exists

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Get token of owner by index

GET /v1/tokens/{id}/token_of_owner_by_index

Query the NFT token ID owned by an address at a given index (ERC-721 Enumerable)

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Get token URI

GET /v1/tokens/{id}/token_uri

Query NFT metadata URI

Auth: api-key

Path params: id

Respostas: 200, 400, 401

---

Transfer batch

POST /v1/tokens/{id}/transfer_batch

Batch transfer ERC-1155 tokens

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição

Respostas: 200, 400, 401

---

Transfer ownership

POST /v1/tokens/{id}/transfer_ownership

Transfer contract admin/ownership to a new address via the Factory

Auth: api-key

Path params: id

Request body:

Campo	Tipo	Obrigatório	Descrição
new_owner	string	sim	New admin/owner address
idempotency_key	string	não	Idempotency key

Respostas: 200, 400, 401, 404

---

Unpause token

POST /v1/tokens/{id}/unpause

Resume transfers on the token contract

Auth: api-key

Path params: id

Respostas: 200, 401

---

Get factory total deployed

GET /v1/tokens/factory/total_deployed

Get the total number of contracts deployed by the factory on a network

Auth: api-key

Query params:

Param	Tipo	Obrigatório
network_id	string	sim

Respostas: 200, 401

---