Documentation
Developer console
Start typing to search…

Get collection details

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 fields

Type

Description

Condition

uid

String

The UID for the collection.

Mandatory

name

String

The name of the collection.

Mandatory

status

String

The status on the collection on the blockchain (deploying | deployed).

Mandatory

type

String

The type of the token minted in that collection (ERC721 | METAPLEX_CORE). For EVM chains, refer to ERC 721 Ethereum documentation). For Solana, refer to Metaplex Core.

Mandatory

created_at

String
(Timestamp)

The timestamp at which the collection has been created.

Mandatory

contract_address

String

The contract address of the collection. Can be null if collection is not yet deployed.

Mandatory

symbol

String

The token symbol associated to your collection. Can be null if not specified on creation.

Mandatory

description

String

The description to your collection. Can be null if not specified on creation.

Mandatory

chain

String

The chain of your collection (Polygon | Amoy | Solana Devnet | ...).

Mandatory

chain_id

Number

The chain id of your collection when EVM (Polygon | Amoy).

Optional

network

String

The network of your collection (Polygon | Solana).

Mandatory

explorer_url

String (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",
    "chain": "Amoy",
    "chain_id": 80002,
    "network": "Polygon",
    "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 8 days ago