This guide outlines the seamless migration from NFT API v2 to NFT API v3, unlocking new features for creators and collectors alike. Migrate now by following the detailed guide which takes you through everything you need to change or update. Unlock new endpoints and features by migrating to NFT v3!

If you have any difficulties migrating, please contact the support team.

Why Migrate?

1. Future Updates

Receive future updates and new releases, available only on the NFT v3. We strongly encourage you to migrate to NFT API v3 to ensure continued support and access to future updates.

2. Update Owner

Upgrading to the NFT v3 allows you to update the owner of an NFT contract. The updated owner will have admin rights on the NFT contract. The endpoint to update the owner is available only on the NFT v3.

3. Configure Royalties

A new endpoint is added to NFT v3, allowing you to configure the NFT contract royalties. You can specify the royalty recipient's wallet address and the royalty percentage. The royalty configuring endpoint only works with NFT contracts created with the NFT v3.

4. Unlock Token API

Migrating from v2 to v3 will unlock the Token API, which allows you to create ERC20 contracts and mint ERC20 tokens! More details for the Token API are at the end of this guide.

Where to find NFT v2.0 docs?

• Switch between v2.0(deprecated) & v3.0(stable) of our documentation from the top left corner as shown below:
• The v2.0 includes the deprecated:
  • NFT-API v2 (Guides + API Reference)
  • Market API (Guides + API Reference)
• The v3.0 has the latest product features including the NFT-API v3.

Migrating to NFT API v3

1. Base URL Change

The base URL for NFT v3 will become:

https://token-api.venly.io

https://token-api-sandbox.venly.io

2. Path Change for company wallet and media endpoints

For the following endpoints, replace /v2/ with /v3/ in the path:

3. Path change for all other endpoints

In the path of every other endpoint, replace /v2/ with /v3/erc1155/

For example, the endpoint to create a contract:

Before (v2):

POST /api/v2/contracts/deployments

Now (v3):

POST /api/v3/erc1155/contracts/deployments

📘

Apply this path change for all the remaining endpoints.

4. Replace secretType with chain

Replace secretType with chain everywhere, specifically in the path variable and request bodies.

4.1 Request Bodies

Replace secretType with chain in the request bodies for:

• Mint tokens endpoint (POST /api/v3/erc1155/tokens/mints)
• Create token-type endpoint (POST /api/v3/erc1155/token-types/creations)

4.2 Path Params

Replace {secretType} with {chain} in the path of all the endpoints where applicable.

For example, the path to get a contract by blockchain and contract address:

Before (v2):

GET /api/v2/contracts/{secretType}/{contractAddress}

Now (v3):

GET /api/v3/erc1155/contracts/{chain}/{contractAddress}

4.3 Response Bodies

In the response bodies, secretType will be replaced by the chain parameter.

5. Removed Endpoints

The following endpoints from v2 have been removed in v3:

We decided to remove the endpoint mentioned above because of mass minting. Mass minting allows you to mint a huge number of NFTs simultaneously. You don't need to wait for the entire minting process to be completed before getting your response.

Mass minting takes care of the token-type creation request or an NFT mint request, thus eliminating the need to create company/minter wallets.

6. New Endpoints

Endpoints: v2 → v3 mapping

The following table lists endpoint mappings from v2 to v3 in full, along with the differences.

Token API Endpoints (v3)

Migrating to NFT v3 unlocks the Token API, which allows the creation of ERC20 token contracts and minting of ERC20 tokens. Following are the endpoints for the Token API:

📘

Read the Token API getting started guide.

Testing

Thoroughly test your integration with NFT API v3 in a sandbox environment to identify and address potential issues before deploying to production.