NFT Collections

Get NFT Collection by Id

Returns NFT Collection by Id

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (ContractAddress)

Address of the collection

Example: ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/collections/{collection}
Response samples
application/json
{
  • "id": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8",
  • "parent": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8",
  • "blockchain": "ETHEREUM",
  • "structure": "REGULAR",
  • "type": "CRYPTO_PUNKS",
  • "status": "PENDING",
  • "name": "string",
  • "symbol": "string",
  • "owner": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
  • "features": [ ],
  • "minters": [
    ],
  • "meta": {
    },
  • "bestBidOrder": {
    },
  • "bestSellOrder": {
    },
  • "bestBidOrdersByCurrency": [
    ],
  • "originOrders": [
    ],
  • "self": true,
  • "scam": false,
  • "hasTraits": true,
  • "shared": false,
  • "extra": {
    }
}

Generate TokenId

Returns next available TokenId for specified minter

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (ContractAddress)

Address of the NFT collection

Example: ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
query Parameters
minter
required
string (UnionAddress)

Minter address

Example: minter=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/collections/{collection}/generateTokenId
Response samples
application/json
{
  • "@type": "DEFAULT",
  • "tokenId": 123456
}

Reset NFT metadata

Reloads metadata for all NFTs in the Collection (see 'Reset NFT metadata' API)

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (CollectionId)

Address of the collection

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8
Responses
200

OK

400

Bad Request

500

Internal Server Error

delete/v0.1/collections/{collection}/refreshMeta
Response samples
application/json
{
  • "code": "BAD_REQUEST",
  • "message": "string"
}

Reset Collection metadata

Reloads metadata for Collection (NOT for collection's NFTs)

SecurityApiKeyAuth
Request
path Parameters
collection
required
string (CollectionId)

Collection id

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8
Responses
200

OK

400

Bad Request

500

Internal Server Error

delete/v0.1/collections/{collection}/resetMeta
Response samples
application/json
{
  • "code": "BAD_REQUEST",
  • "message": "string"
}

Get NFT Collections owned by user

Returns list of NFT Collections belong to specified user

SecurityApiKeyAuth
Request
query Parameters
blockchains
Array of strings (Blockchain)

Since user's address can be present in several blockchains (for example, ETHEREUM and POLYGON), you can use this filter to get Orders only for specific blockchains. Or keep it empty to get Order from all blockchains

Items Enum: "APTOS" "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" "MANTLE" "ARBITRUM" "CHILIZ" "LIGHTLINK" "ZKSYNC" "ASTARZKEVM" "BASE" "RARI" "CELO" "FIEF" "XAI" "KROMA" "ZKLINK" "OASYS" "QUAI" "ECLIPSE" "SAAKURU" "OASIS" "PALM" "MATCH" "FIVIRE" "SEI" "CAMP" "LISK" "MOONBEAM" "ETHERLINK"
Example: blockchains=ETHEREUM
owner
required
string (UnionAddress)

Owner of searching collections

Example: owner=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/collections/byOwner
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "collections": [ ]
}

Get all NFT Collections

Returns all NFT Collections in accordance with specified filters

SecurityApiKeyAuth
Request
query Parameters
blockchains
Array of strings (Blockchain)

Names of the blockchain networks. If no one specified, data from all blockchains will be returned

Items Enum: "APTOS" "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX" "MANTLE" "ARBITRUM" "CHILIZ" "LIGHTLINK" "ZKSYNC" "ASTARZKEVM" "BASE" "RARI" "CELO" "FIEF" "XAI" "KROMA" "ZKLINK" "OASYS" "QUAI" "ECLIPSE" "SAAKURU" "OASIS" "PALM" "MATCH" "FIVIRE" "SEI" "CAMP" "LISK" "MOONBEAM" "ETHERLINK"
Example: blockchains=ETHEREUM
continuation
string

Continuation token from the previous response

size
integer <int32>

The number of items to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/collections/all
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "collections": [ ]
}