Get collection details

Suggest Edits

What is a Collection?

A collection represents a unique smart contract on the blockchain that will be in charge of minting a series of NFTs.

When you create a collection, Original deploys a unique and secured smart contract on the blockchain (testnet or mainnet depending on the environment you are in) that will execute NFT mints on your demand.

In order to start minting NFTs you first need to create a collection via your developer console.

🚧

Important:

Request headers are required. See API basics introduction for more information.

Get collection details by uid

Endpoint

GET /collection/{uid}

  • Gets the collection for a given uid associated with the given App (set by the X-API-KEY).
  • Returns the collection details associated.

Parameters

Path parameters

Path parameterDescription
uidThe unique identifier of the collection for this app (ex. 113434045189).

Response

You will receive the collection details including the following fields:

Response fieldsTypeDescriptionCondition
uidStringThe UID for the collection.Mandatory
nameStringThe name of the collection.Mandatory
statusStringThe status on the collection on the blockchain (deploying | deployed).Mandatory
typeStringThe type of the token minted in that collection (In the V1 beta of the product, only ERC721 will be available. For more information about this standard, refer to the ERC 721 Ethereum documentation).Mandatory
created_atString
(Timestamp)		The timestamp at which the collection has been created.Mandatory
contract_addressStringThe contract address of the collection. Can be null if collection is not yet deployed.Mandatory
symbolStringThe token symbol associated to your collection. Can be null if not specified on creation.Mandatory
descriptionStringThe description to your collection. Can be null if not specified on creation.Mandatory
explorer_urlString (URL)The explorer URL (PolygonScan) of the collection. It can be used to see all blockchain related informations. Can be null if collection is not yet deployed.Mandatory

Response example

{
  "success": true,
  "data": {
    "uid": "113434045189",
    "name": "newContract",
    "status": "deployed",
    "type": "ERC721",
    "created_at": "2023-09-06T14:11:13.515036Z",
    "contract_address": "0xf8a913351bDf9f80145F8DE6f9d793F119Ae9609",
    "symbol": "SYMB",
    "description": "This is the wonderful description of my collection example for the documentation",
    "explorer_url": "https://amoy.polygonscan.com/address/0xf8a913351bDf9f80145F8DE6f9d793F119Ae9609"
  }
}

Example

The following example gets the collection details for uid 999999999999.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X GET \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/collection/999999999999"

Updated 18 days ago