Protokol
  • Introduction To Digital Assets
  • Tutorials
    • How To Create Digital Assets
    • How To Trade Digital Assets
  • ARK CORE MODULES
    • NFT
      • Development
      • Complementary Examples
        • Base
        • Exchange
      • API Endpoints
        • Assets
        • Burns
        • Collections
        • Transfers
        • Base Configurations
        • Auctions
        • Bids
        • Trades
        • Exchange Configurations
    • Guardian
      • Development
      • Complementary Examples
      • API Endpoints
        • Configurations
        • Groups
        • Users
    • Nameservice
      • Development
      • Complementary Examples
      • API Endpoints
        • Configurations
        • Nameservice
    • Voting
      • Development
      • Complementary Examples
      • API Endpoints
        • Configurations
        • Create Proposal
        • Cast Vote
        • Statistics
  • Protokol Templates
    • Core Starter Kit
    • Solidity Typescript Hardhat
    • Nestjs
Powered by GitBook
On this page
  • All Burns
  • /burns
  • Examples
  • Burn By Id
  • /burns/:id
  • Examples

Was this helpful?

  1. ARK CORE MODULES
  2. NFT
  3. API Endpoints

Burns

List of NFT Base Burns API Endpoints.

All Burns

/burns

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

Return all burn transactions

Query Parameters

Name
Type
Description

page

integer

The number of page to 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

Returns modified or raw data

{
  "meta": {
    "totalCountIsEstimate": true,
    "count": 1,
    "pageCount": 1,
    "totalCount": 1,
    "next": null,
    "previous": null,
    "self": "/nft/burns?transform=true&page=1&limit=100",
    "first": "/nft/burns?transform=true&page=1&limit=100",
    "last": "/nft/burns?transform=true&page=1&limit=100"
  },
  "data": [
    {
      "id": "a6664c2d2e26e4c7a7548850f0f820d755c0cad1287a21be2582ab039f6d5c2f",
      "senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37",
      "nftBurn": {
        "nftId": "f811518958861d4c1e72943f646b1bd848f606e6cc9bd6300480e6a0b501cf47"
      },
      "timestamp": {
        "epoch": 143493208,
        "unix": 1633594408,
        "human": "2021-10-07T08:13:28.000Z"
      }
    }
  ]
}

Examples

curl https://explorer.protokol.sh/api/nft/burns
const response = connection.NFTBaseApi("burns").all();

>>> Promise<ApiResponseWithPagination<BurnsResource[]>>

Burn By Id

/burns/:id

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

Returns burn transaction by id

Path Parameters

Name
Type
Description

id

string

The identifier to be retrieved

Query Parameters

Name
Type
Description

transform

boolean

Returns modified or raw data

{
  "data": {
    "id": "a6664c2d2e26e4c7a7548850f0f820d755c0cad1287a21be2582ab039f6d5c2f",
    "senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37",
    "nftBurn": {
      "nftId": "f811518958861d4c1e72943f646b1bd848f606e6cc9bd6300480e6a0b501cf47"
    },
    "timestamp": {
      "epoch": 143493208,
      "unix": 1633594408,
      "human": "2021-10-07T08:13:28.000Z"
    }
  }
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Burn Transaction not found"
}
{
  "statusCode": 422,
  "error": "Unprocessable Entity",
  "message": "\"id\" length must be 64 characters long"
}

Examples

curl https://explorer.protokol.sh/api/nft/burns/f2c47694e32cdb7cae7e3ca8726836fac323a3175559277469faf541ae49c5b4
const response = connection.NFTBaseApi("burns").get("VALID_ID");

>>> Promise<ApiResponse<BurnsResource>>
PreviousAssetsNextCollections

Last updated 3 years ago

Was this helpful?