Collections

List of NFT Base Collections API Endpoints.

All Collections

/collections

GET https://explorer.protokol.sh/api/nft/collections

Returns all Collections Registered

Query Parameters

Name
Type
Description

page

integer

The number of page that will be returned

limit

integer

The number of resources per page

orderBy

string

Order by specific parameter (asc or desc) Example: orderBy=id:asc

transform

boolean

It returns modified or raw data

{
  "meta": {
    "totalCountIsEstimate": true,
    "count": 2,
    "pageCount": 1,
    "totalCount": 2,
    "next": null,
    "previous": null,
    "self": "/nft/collections?transform=true&page=1&limit=100",
    "first": "/nft/collections?transform=true&page=1&limit=100",
    "last": "/nft/collections?transform=true&page=1&limit=100"
  },
  "data": [
    {
      "id": "8643026a0997dc9fe74ce4aa11f522ecff651fa72ecf0127a0665fd52535bc1b",
      "senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37",
      "name": "AREX Defense Handguns",
      "description": "AREX weapons sales",
      "maximumSupply": 1000,
      "jsonSchema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "name",
          "description",
          "serialNumber",
          "caliber",
          "length",
          "height",
          "width",
          "barrelLength"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 120,
            "minLength": 1
          },
          "description": {
            "type": "string",
            "maxLength": 3000,
            "minLength": 1
          },
          "serialNumber": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "caliber": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "length": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "height": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "width": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "barrelLength": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "weight": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "weightWithMag": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "frameColors": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1
          },
          "slide": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1
          },
          "slights": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1
          },
          "frame": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "firingPinSafety": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "triggerSafety": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "ambidextrousManualSafety": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1
          },
          "ipfsImageHash": {
            "type": "string",
            "maxLength": 255,
            "minLength": 1
          }
        }
      },
      "timestamp": {
        "epoch": 143237072,
        "unix": 1633338272,
        "human": "2021-10-04T09:04:32.000Z"
      }
    },
    ...
  ]
}

Examples

Collection By id

/collections/:id

GET https://explorer.protokol.sh/api/nft/collections/:id

Return collection by its id

Path Parameters

Name
Type
Description

id

string

The identifier of the collection

Query Parameters

Name
Type
Description

transform

boolean

It returns modified or raw data

Examples

Collection Schema

/collections/:id/schema

GET https://explorer.protokol.sh/api/nft/collections/:id/schema

Returns JSON schema registered by the collection

Path Parameters

Name
Type
Description

id

string

The identifier of the collection

Query Parameters

Name
Type
Description

transform

boolean

It returns modified or raw data

Examples

Collections Wallet

/collections/:id/wallets

GET https://explorer.protokol.sh/api/nft/collections/:id/wallets

Returns wallet of owned collection

Path Parameters

Name
Type
Description

id

string

The identifier of the collection

Examples

Search Collection

/collections/search

POST https://explorer.protokol.sh/api/nft/collections/search

Search collection by attributes

Query Parameters

Name
Type
Description

page

integer

The number of page that will be returned

limit

integer

The number of resources per page

orderBy

string

Order by specific parameter (asc or desc) Example: orderBy=id:asc

transform

boolean

It returns modified or raw data

Request Body

Name
Type
Description

attributeName

object

Attribute to search by

Examples

Collection Assets

/collections/:id/assets

GET https://explorer.protokol.sh/api/nft/collections/:id/assets

Returns assets belonging to specific collection

Path Parameters

Name
Type
Description

id

string

The identifier of the collection

Query Parameters

Name
Type
Description

page

integer

The number of the page that will be returned

limit

integer

The number of resources per page

orderBy

string

Order by specific parameter (asc or desc) Example: orderBy=id:asc

transform

boolean

It returns modified or raw data

Examples

PreviousBurnsNextTransfers

Last updated

Was this helpful?