These docs are for v2.0. Click to read the latest docs for v3.0.

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/v2/contracts/{secretType}/{contractAddress}
ParameterParam TypeDescriptionData TypeMandatory
{secretType}PathThe blockchain of the contractString
{contractAddress}PathThe contract address whose details you want to fetch.String

Example Request:

GET /api/v2/contracts/MATIC/0x30d6cff9cb268c59c75a94755b2c60e118d65657

Response Body:

{
    "success": true,
    "result": {
        "secretType": "MATIC",
        "address": "0x30d6cff9cb268c59c75a94755b2c60e118d65657",
        "contractUri": "https://metadata-staging.arkane.network/metadata/contracts/64260",
        "onChainStatus": "SUCCEEDED",
        "metadata": {
            "name": "My first collection",
            "description": "Sample description",
            "symbol": "MYFICO",
            "externalUrl": "www.venly.io",
            "image": "https://pbs.twimg.com/profile_images/1669300450649157635/4xg-wsbK_400x400.jpg",
            "media": [],
            "external_link": "www.venly.io"
        }
    }
}

2. Get all contracts

Request Endpoint: reference

GET /api/v2/contracts

Example Request:

GET /api/v2/contracts

Response Body:

{
    "success": true,
    "result": [
        {
            "secretType": "MATIC",
            "address": "0xedb47c1c4c5a14c67be6066c585a096188cd9544",
            "contractUri": "https://metadata-staging.arkane.network/metadata/contracts/64159",
            "name": "Name Changed",
            "symbol": "MYFICO",
            "image": "https://pbs.twimg.com/profile_images/1669300450649157635/4xg-wsbK_400x400.jpg",
            "onChainStatus": "SUCCEEDED"
        },
        {
            "secretType": "MATIC",
            "address": "0xe2a43584f37f9d4a8e446d2e38c37bde0405c75d",
            "contractUri": "ipfs://QmTxV2QFBWy7iXnusuLA1qHZAFp5wK3jF8KTQCyvnn4x2T",
            "name": "NFT Collection",
            "symbol": "NFTC",
            "image": "https://techround.co.uk/wp-content/uploads/2022/01/Venly-logo.png",
            "onChainStatus": "SUCCEEDED"
        },
        {
            "secretType": "MATIC",
            "address": "0x7eb667483a415937478bb9c662b27ed10c8df3b1",
            "contractUri": "https://metadata-staging.arkane.network/metadata/contracts/63097",
            "name": "Testing NFT Collection",
            "symbol": "TNFTC",
            "image": "https://pbs.twimg.com/profile_images/1669300450649157635/4xg-wsbK_400x400.jpg",
            "onChainStatus": "SUCCEEDED"
        }
    ]
}