Retrieve Contract

How to retrieve the information of one or all of your NFT contracts.

Retrieve information about a specific NFT contract, or get all of your NFT contracts.

1. Get a specific contract by chain and contract address

Request Endpoint: reference

GET /api/v3/erc1155/contracts/{chain}/{contractAddress}
ParameterParam TypeDescriptionData TypeMandatory
{chain}PathThe blockchain of the contractString
{contractAddress}PathThe contract address whose details you want to fetch.String

Example Request:

GET /api/v3/erc1155/contracts/MATIC/0xfe70a8d4c3c1c53aea3753d38eec27d7f5137b3a

Response Body:

{
    "success": true,
    "result": {
        "chain": "MATIC",
        "address": "0xfe70a8d4c3c1c53aea3753d38eec27d7f5137b3a",
        "contractUri": "https://metadata-staging.venly.io/metadata/contracts/70858",
        "onChainStatus": "SUCCEEDED",
        "owner": "0xb811Fac088E8E80F56258a5f29D47d0FF1a37BD5",
        "royalties": {
            "percentage": 21.50,
            "receiver": "0x7312750DF4d2057b758a61C7017729c6Ec9bB3E9"
        },
        "metadata": {
            "name": "Updated Contract Name",
            "description": "Updated description.",
            "symbol": "ABCD",
            "externalUrl": "https://www.venly.io/",
            "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/logovenly.png",
            "media": [
                {
                    "type": "instagram",
                    "value": "https://www.instagram.com/venly.market/"
                }
            ],
            "external_link": "https://www.venly.io/"
        }
    }
}

2. Get all contracts

Request Endpoint: reference

GET /api/v3/erc1155/contracts

Example Request:

GET /api/v3/erc1155/contracts

Response Body:

{
    "success": true,
    "result": [
        {
            "chain": "BSC",
            "address": "0x21e55c3dbcd38da726c6cc4c0242d0fdcf962feb",
            "contractUri": "https://metadata-staging.venly.io/metadata/contracts/68287",
            "name": "Venly NFT Collection",
            "symbol": "VENFCO",
            "image": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
            "onChainStatus": "SUCCEEDED"
        },
        {
            "chain": "MATIC",
            "contractUri": "https://metadata-staging.venly.io/metadata/contracts/68285",
            "name": "Venly Test Collection",
            "symbol": "VETECO",
            "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/fe1ae5254854c3871817c1ba8f7b827e75a18cce.png",
            "onChainStatus": "FAILED"
        },
        {
            "chain": "BSC",
            "address": "0x4a192714a4c571c76e8abe28c385c4288a167993",
            "contractUri": "https://metadata-staging.venly.io/metadata/contracts/68286",
            "name": "Venly Test Collection",
            "symbol": "VETECO",
            "image": "https://storage-staging.venly.io/applications/bff93371-db40-4363-9692-4fbe64a34b54/b965125103e907651e5b8c9c80e418983cba2475.png",
            "onChainStatus": "SUCCEEDED"
        },
        {
            "chain": "AVAC",
            "address": "0x07b1cbbc1e9e4d3fc0d2879106fbc41475a9ab46",
            "contractUri": "https://metadata-staging.venly.io/metadata/contracts/68580",
            "name": "Venly NFT Collection",
            "symbol": "VENFCO",
            "image": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
            "onChainStatus": "SUCCEEDED"
        },
        {
            "chain": "MATIC",
            "address": "0xdc944ec4c805feadd9aa1548d4861b58750ba9ac",
            "contractUri": "https://metadata-staging.venly.io/metadata/contracts/65730",
            "name": "My First NFT Collection",
            "symbol": "MYFINFCO",
            "image": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
            "onChainStatus": "SUCCEEDED"
        }
    ]
}