improved

NFT-API & Token-API Updates

This update brings key improvements to the Token-API and NFT-API, enhancing response data, introducing new endpoints, and refining existing functionality. These changes improve the overall API experience, offering greater flexibility and control over token management.

Token-API + NFT-API Version 2.0 and 3.0 Updates


1. Response body expanded for Get All Token Mints endpoint (V2 & V3)

{
    "success": true,
    "result": [
        {
            "id": "7061761a-8c7e-4619-a281-052810cca595",
            "chain": "BSC",
            "contractAddress": "0xa51e79c53e149ae6ebaf7e6479f0458b59e68d4d",
            "tokenTypeId": 1,
            "tokenId": 2,
            "createdOn": "2024-05-01T11:30:24.432049",
            "status": "SUCCEEDED",
            "transactionHash": "0xd2ce027aa959d83a536ebdaa9db923a22714b239cca438729109364d7a4fafed",
            "destination": {
                "address": "0xcdA9e3959E7f9c58D2a2088b8F7C9F1C60B1Bd24",
                "amount": 1
            }
        },
        {
            "id": "e2882eb2-8b88-4971-ad4b-1ae0bfb17286",
            "chain": "ETHEREUM",
            "contractAddress": "0x5bacbf6e75cae54c7dcd9c94d95ccf9c98f6ac74",
            "tokenTypeId": 1,
            "tokenId": 5,
            "createdOn": "2024-05-24T10:27:55.891121",
            "status": "SUCCEEDED",
            "transactionHash": "0xb8b58257941da2b70153336718d1a55b3e0ac90b2e61eb794a2bc27ae9ec18c2",
            "destination": {
                "address": "0x50765794F78352055C9f4EBEEec78E95a325c27E",
                "amount": 1
            }
        },
        {
            "id": "951c00db-0ff7-4c94-bbb2-88ffe18f974b",
            "chain": "ETHEREUM",
            "contractAddress": "0x5bacbf6e75cae54c7dcd9c94d95ccf9c98f6ac74",
            "tokenTypeId": 1,
            "tokenId": 4,
            "createdOn": "2024-05-24T10:27:55.886295",
            "status": "SUCCEEDED",
            "transactionHash": "0xb8b58257941da2b70153336718d1a55b3e0ac90b2e61eb794a2bc27ae9ec18c2",
            "destination": {
                "address": "0x50765794F78352055C9f4EBEEec78E95a325c27E",
                "amount": 1
            }
        }
    ]
}

2. Response body expanded for Check Token Mint Status endpoint (V2 & V3)

{
    "success": true,
    "result": {
        "id": "c6429476-538f-48e5-9e27-c16d38c02456",
        "chain": "MATIC",
        "contractAddress": "0xdc944ec4c805feadd9aa1548d4861b58750ba9ac",
        "tokenTypeId": 3,
        "tokenId": 5,
        "createdOn": "2024-05-29T17:26:06.607087",
        "status": "SUCCEEDED",
        "transactionHash": "0xed62b5018d47679e6754484abb092b59800f5e704c546037b2c5ac7b98434177",
        "destination": {
            "address": "0x0B8C6bf3305ef22fD28b19ecFc1D6Cee4364B219",
            "amount": 1
        },
        "metadata": {
            "name": "Spaceship",
            "description": "Venly",
            "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/t7wrTeL6SiCuWdwXp9d1xw.png",
            "imagePreview": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/t7wrTeL6SiCuWdwXp9d1xw.png",
            "imageThumbnail": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/t7wrTeL6SiCuWdwXp9d1xw.png",
            "animationUrls": [],
            "attributes": [
                {
                    "type": "system",
                    "name": "tokenTypeId",
                    "value": "3",
                    "traitType": "Token Type ID",
                    "trait_type": "Token Type ID"
                },
                {
                    "type": "property",
                    "name": "mintNumber",
                    "value": "2",
                    "traitType": "Mint Number",
                    "trait_type": "Mint Number"
                }
            ],
            "contract": {
                "address": "0xdc944ec4c805feadd9aa1548d4861b58750ba9ac",
                "name": "My First NFT Collection",
                "symbol": "MYFINFCO",
                "image": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
                "imageUrl": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
                "image_url": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
                "description": "Sample description",
                "externalLink": "www.venly.io",
                "external_link": "www.venly.io",
                "externalUrl": "www.venly.io",
                "external_url": "www.venly.io",
                "media": [],
                "type": "ERC_1155"
            },
            "fungible": false
        }
    }
}

3. chain param added to response of Check Token Mint Status - Token API

{
    "success": true,
    "result": {
        "id": "7f78e6ed-d733-430c-83a4-5fc28032e667",
        "createdOn": "2024-09-23T09:28:49.562087",
        "status": "SUCCEEDED",
        "transactionHash": "0x95dba6ba9c8bae1d3179486e00eeb778fb9d2435741226e4d98b59e38cf7e875",
        "destination": {
            "address": "0xf2b1cEB69E765469a80E8d4c8635B05269889fa7",
            "amount": 35
        },
        "contract": {
            "chain": "MATIC",
            "address": "0x1e857475040b732d5adf3f8b2e7cd712914cdd23",
            "name": "Infinity Token",
            "symbol": "IFT",
            "maxSupply": 100,
            "burnable": true,
            "owner": "0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9",
            "type": "ERC_20"
        }
    }
}

4. New Endpoint: Get All ERC20 Token Mints - Token-API

  • New Endpoint:

    • GET /api/v3/erc20/tokens/mints
      
    • This endpoint allows you to retrieve all ERC20 token mints.
    • You can further filter the results based on to-from date, status of mints, mintIds, contract address, and company ID.
  • Guide + API-Reference:

5. New Endpoint: Archive a token by tokenId (V2 & V3)


6. Changes to Delete Contract Endpoints (V2 & V3)


7. Changes to Delete Token-type Endpoints (V2 & V3)


8. Changes to Delete ERC20 Contract Endpoint - Token-API

  • Endpoint Affected:
  • Change:
    • Archiving/deleting an ERC20 contract will also archive all the minted tokens under that contract.
    • Archived ERC20 contracts and minted tokens will not be returned in API calls.
    • The archived ERC20 contract and minted tokens will exist on-chain.

This changelog outlines the latest updates and enhancements to the Token-API & NFT-API, ensuring better functionality and flexibility for users of both V2 and V3 versions.