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 Transfers
  • /transfers
  • Examples
  • Transfer By Id
  • /transfers/:id
  • Examples

Was this helpful?

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

Transfers

List of NFT Base Transfer Endpoints.

All Transfers

/transfers

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

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

Returns modified or raw data

{
  "meta": {
    "totalCountIsEstimate": true,
    "count": 1,
    "pageCount": 1,
    "totalCount": 1,
    "next": null,
    "previous": null,
    "self": "/nft/transfers?transform=true&page=1&limit=100",
    "first": "/nft/transfers?transform=true&page=1&limit=100",
    "last": "/nft/transfers?transform=true&page=1&limit=100"
  },
  "data": [
    {
      "id": "606aceccbb930f4a1e694ba876d0574a4dbf39cb8437d7c5f2dc1b7c9fa3ba23",
      "senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37",
      "nftTransfer": {
        "nftIds": [
          "b612cdce4e127bbf2393261100bfb4b1866684de2df1dd0d0bbcdb2eaa7b55b8"
        ],
        "recipientId": "AMfyf9iRjXiKNcLQVTUE9oCESUPzmQ6iUT"
      },
      "timestamp": {
        "epoch": 143495632,
        "unix": 1633596832,
        "human": "2021-10-07T08:53:52.000Z"
      }
    }
  ]
}

Examples

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

>>> Promise<ApiResponseWithPagination<TransfersResource[]>>

Transfer By Id

/transfers/:id

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

Returns Transfer transaction by id

Path Parameters

Name
Type
Description

id

string

The identifer to be retrieved

Query Parameters

Name
Type
Description

transform

boolean

Returns modified or raw data

{
  "data": {
    "id": "606aceccbb930f4a1e694ba876d0574a4dbf39cb8437d7c5f2dc1b7c9fa3ba23",
    "senderPublicKey": "03287bfebba4c7881a0509717e71b34b63f31e40021c321f89ae04f84be6d6ac37",
    "nftTransfer": {
      "nftIds": [
        "b612cdce4e127bbf2393261100bfb4b1866684de2df1dd0d0bbcdb2eaa7b55b8"
      ],
      "recipientId": "AMfyf9iRjXiKNcLQVTUE9oCESUPzmQ6iUT"
    },
    "timestamp": {
      "epoch": 143495632,
      "unix": 1633596832,
      "human": "2021-10-07T08:53:52.000Z"
    }
  }
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "NTF Transfer Transaction not found"
}
{
  "statusCode": 422,
  "error": "Unprocessable Entity",
  "message": "\"id\" length must be 64 characters long"
}

Examples

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

>>> Promise<ApiResponse<TransfersResource>>
PreviousCollectionsNextBase Configurations

Last updated 3 years ago

Was this helpful?