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

Retrieve contract

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

1. Get a single contract by id

Request Endpoint: reference

GET /api/minter/contracts/{contractId}
ParameterParam TypeDescriptionData TypeMandatory
{contractId}PathThis is the id of the contract.Integer

Example Request:

GET https://nft-api.venly.io/api/minter/contracts/203

Response Body:

{
    "name": "Space Chickens",
    "description": "Space Chickens in Space is an American-Australian-Mexican-British-Irish animated television series produced by Ánima Estudios in Mexico, Studio Moshi in Australia. A trio of chickens—Chuck, Starley and Finley—are taken from their home and mistakenly enrolled in an elite intergalactic former military academy. It would take all their strength, and teamwork, to survive every escapade they have.",
    "confirmed": true,
    "address": "0xd3343d667d8d2c1c9dc6fe36d2b3f6b569e4d08b",
    "id": 203,
    "secretType": "MATIC",
    "symbol": "SPACECHICKS",
    "externalUrl": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
    "image": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
    "media": [
        {
            "type": "image",
            "value": "https://dg31sz3gwrwan.cloudfront.net/fanart/355763/1357791-0-q80.jpg"
        }
    ],
    "transactionHash": "0x959fdb61ab62354f780e7fce22c650f51e1d71a80f055062559719723858e3f4"
}

2. Get all contracts

Request Endpoint: reference

GET /api/minter/contracts

Example Request:

GET https://nft-api.venly.io/api/minter/contracts

Response Body:

[
    {
        "name": "Space Chickens",
        "description": "Space Chickens in Space is an American-Australian-Mexican-British-Irish animated television series produced by Ánima Estudios in Mexico, Studio Moshi in Australia. A trio of chickens—Chuck, Starley and Finley—are taken from their home and mistakenly enrolled in an elite intergalactic former military academy. It would take all their strength, and teamwork, to survive every escapade they have.",
        "confirmed": true,
        "address": "0xd3343d667d8d2c1c9dc6fe36d2b3f6b569e4d08b",
        "id": 203,
        "secretType": "MATIC",
        "symbol": "SPACECHICKS",
        "externalUrl": "https://en.wikipedia.org/wiki/Space_Chickens_in_Space",
        "image": "https://static.wikia.nocookie.net/logopedia/images/a/aa/Space_Chickens_in_Space.jpg",
        "media": [
            {
                "type": "image",
                "value": "https://dg31sz3gwrwan.cloudfront.net/fanart/355763/1357791-0-q80.jpg"
            }
        ],
        "transactionHash": "0x959fdb61ab62354f780e7fce22c650f51e1d71a80f055062559719723858e3f4"
    },
    {
        "name": "Puzzle in a Bag",
        "description": "PIAB, or Puzzle in a Bag, is a Ghentian start-up company looking to make puzzling cool again, which is why we're selling the first ever physical puzzle turned into NFTs. We create culturally relevant puzzles that contain fun, out-of-the-box references to the topic of every puzzle.",
        "confirmed": true,
        "address": "0x2aaaee990f595f21a88c1264f57d617ece271bd3",
        "id": 191,
        "secretType": "MATIC",
        "symbol": "PIAB",
        "externalUrl": "https://www.puzzleinabag.com",
        "image": "https://img.venly.io/marketing/PIAB/logo.png",
        "media": [
            {
                "type": "image",
                "value": "https://img.venly.io/marketing/PIAB/banner.png"
            },
            {
                "type": "instagram",
                "value": "https://www.instagram.com/puzzleinabag/?hl=en"
            },
            {
                "type": "linkedin",
                "value": "https://www.linkedin.com/company/puzzle-in-a-bag/"
            },
            {
                "type": "facebook",
                "value": "https://www.facebook.com/puzzleinabag/"
            }
        ],
        "transactionHash": "0xc3815cc0bbec756b9560ba3ed48557c682dee73e3752d3cf6a1c5467b01bf1f8"
    }
]