1 of 6

Non-fungible token (NFT)

The NFTToken entity provides representation of an NFT on Casper Network. CSPR.cloud supports NFTs compatible with the CEP-47 and CEP-78 Casper Network standards.

Properties

The NFTToken entity has the following properties:

Property

Type

Description

contract_package_hash

string(64)

NFT contract package hash represented as a hexadecimal string. First of of token identifier

block_height

uint64

Height of the block in which the token was minted.

token_id

string

Token ID under the contract. Second part of token identifier

token_standard_id

uint8

owner_hash

string(64)

NFT token owner account or contract hash, represented as a hexadecimal string

owner_type

uint8

NFT owner type. 0 for account, 1 for contract

onchain_metadata

JSON

On-chain NFT metadata

offchain_metadata

JSON

Off-chain NFT metadata

offchain_metadata_status

uint8

is_burned

bool

true if the token was burn

tracking_id

uint32

timestamp

uint16

The timestamp of token creation

Example

{
  "contract_package_hash": "04682e17e5a86d594d9fd2bf37c766834bbaa412499bd6b5ac4ce76449708797",
  "block_height": 2404577,
  "is_burned": false,
  "offchain_metadata": {
    "attributes": [
      {
        "trait_type": "BG",
        "value": "Bg-1"
      },
      {
        "trait_type": "BG lines",
        "value": "Bg-Line-21"
      },
      {
        "trait_type": "Strpse",
        "value": "Card-stripse-01"
      }
    ],
    "description": "The first Tornado Master NFT minted by GuardianLink using Casper to announce the partnership with Casper.",
    "image": "https://arweave.net/H5RHizXPJez8zNMC07RVZxCApW42nSfF7FQk4jwyLHs",
    "name": "Tornado Master #0"
  },
  "offchain_metadata_status": 2,
  "onchain_metadata": {
    "name": "Tornado-Demo",
    "symbol": "TD",
    "token_uri": "https://yslkpbmdp345dabuwtvg65sqgd62lnpk2bp6mwha5hsrqxocw24q.arweave.net/xJanhYN--dGANLTqb3ZQMP2lterQX-ZY4OnlGF3Ctrk"
  },
  "owner_hash": "f41b57283a23958405373e8fbd9195ddbe71e8ea98fb2f4397ab09b2f63198af",
  "owner_type": 0,
  "timestamp": "2023-11-22T12:22:21Z",
  "token_id": "0",
  "token_standard_id": 2,
  "tracking_id": 258547
}

Optional properties

Depending on the endpoint some of the following optional properties may be included in the NFTToken entity:

Property

Type

Description

contract_package

NFT contract package

owner_public_key

string(68)

Owner public key if it's an account

Relations

Entity

Mapping property

Description

contract_package_hash

NFT tokens belong to a contract package

from_hash, to_hash

NFT token could have accounts as the token owner

tracking_id

NFT token actions are mapped by contract package hash and token id

Endpoints

The NFTToken entity has the following endpoints:

Get NFT
Get account NFTs
Get contract package NFTs

Relation endpoints

The NFTToken entity has the following relation endpoints:

Get NFT standards
Get off-chain NFT metadata statuses

Get NFT

Get NFT by contract package hash and token ID

GET /contract-packages/{contract_package_hash}/nft-tokens/{token_id}

Query params

None

Sorting

None

Default sorting is timestamp DESC

Optional properties

Property

Type

Description

contract_package

NFT contract package

owner_public_key

string(68)

Owner public key if it's an account

Response

<NFTToken>

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/contract-packages/006c68af5f767e406cccd326f8d8bba81dec20d2578f308d33e3bbf08ee5d383/nft-tokens/0' \
  -H 'accept: application/json' \
  -H 'authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": {
    "contract_package_hash": "006c68af5f767e406cccd326f8d8bba81dec20d2578f308d33e3bbf08ee5d383",
    "block_height": 1461592,
    "is_burned": false,
    "offchain_metadata": null,
    "offchain_metadata_status": 3,
    "onchain_metadata": {
      "token_uri": "{\"token_uri\":\"ipfs://QmZa1hrX5FJRxyNyEbYjTVPJ6mbQtA3wJu1RjQpv9am6n2\"}"
    },
    "owner_hash": "8e09f028baff4e3a851e70bb8a5dc02eae7f8cb7faf1b52d9c8dafa7f41fa55c",
    "owner_type": 1,
    "timestamp": "2022-10-18T15:22:06Z",
    "token_id": "0",
    "token_standard_id": 1,
    "tracking_id": 20458
  }
}

Get account NFTs

Get account NFTs by its identifier (public key or account hash)

GET /accounts/{account_identifier}/nft-tokens

Query params

Query param

Description

from_block_height

From block height range

to_block_height

To block height range

is_burned

Filters tokens by their is_burned status: false to get active NFTs, true to get the burned ones. By default all tokens are returned.

Sorting

Property

Description

token_id

Sort tokens by token_id

timestamp

Sort tokens by timestamp

Default sorting is timestamp DESC

Optional properties

Property

Type

Description

contract_package

NFT contract package

owner_public_key

string(68)

Owner public key if it's an account

Response

PaginatedResponse<NFTToken>

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/accounts/8E09F028BAFF4E3A851E70BB8A5DC02EAE7F8CB7FAF1B52D9C8DAFA7F41FA55C/nft-tokens' \
  -H 'accept: application/json' \
  -H 'authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": [
    {
      "contract_package_hash": "006c68af5f767e406cccd326f8d8bba81dec20d2578f308d33e3bbf08ee5d383",
      "block_height": 1461592,
      "is_burned": false,
      "offchain_metadata": null,
      "offchain_metadata_status": 3,
      "onchain_metadata": {
        "token_uri": "{\"token_uri\":\"ipfs://QmZa1hrX5FJRxyNyEbYjTVPJ6mbQtA3wJu1RjQpv9am6n2\"}"
      },
      "owner_hash": "8e09f028baff4e3a851e70bb8a5dc02eae7f8cb7faf1b52d9c8dafa7f41fa55c",
      "owner_type": 1,
      "timestamp": "2022-10-18T15:22:06Z",
      "token_id": "0",
      "token_standard_id": 1,
      "tracking_id": 20458
    }
  ],
  "item_count": 1,
  "page_count": 1
}

Get contract package NFTs

Get NFT contract package tokens by its hash

GET /contract-packages/{contract_package_hash}/nft-tokens

Query params

Query param

Description

from_block_height

From block height range

to_block_height

To block height range

is_burned

Filters tokens by their is_burned status: false to get active NFTs, true to get the burned ones. By default all tokens are returned.

Sorting

Property

Description

token_id

Sort tokens by token_id

timestamp

Sort tokens by timestamp

Default sorting is timestamp DESC

Optional properties

Property

Type

Description

owner_public_key

string(68)

Owner public key if it's an account

Response

PaginatedResponse<NFTToken>

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/contract-packages/006c68af5f767e406cccd326f8d8bba81dec20d2578f308d33e3bbf08ee5d383/nft-tokens' \
  -H 'accept: application/json' \
  -H 'authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": [
    {
      "contract_package_hash": "006c68af5f767e406cccd326f8d8bba81dec20d2578f308d33e3bbf08ee5d383",
      "block_height": 1461592,
      "is_burned": false,
      "offchain_metadata": null,
      "offchain_metadata_status": 3,
      "onchain_metadata": {
        "token_uri": "{\"token_uri\":\"ipfs://QmZa1hrX5FJRxyNyEbYjTVPJ6mbQtA3wJu1RjQpv9am6n2\"}"
      },
      "owner_hash": "8e09f028baff4e3a851e70bb8a5dc02eae7f8cb7faf1b52d9c8dafa7f41fa55c",
      "owner_type": 1,
      "timestamp": "2022-10-18T15:22:06Z",
      "token_id": "0",
      "token_standard_id": 1,
      "tracking_id": 20458
    }
  ],
  "item_count": 1,
  "page_count": 1
}

Get NFT standards

Query params

None

Sorting

None

Optional properties

None

Response

List of value objects describing the available NFT standards

Example

Get off-chain NFT metadata statuses

GET /nft-token-offchain-metadata-statuses

Query params

None

Sorting

None

Optional properties

None

Response

List of value objects describing the available off-chain NFT metadata statuses

Example

curl -X 'GET' \
  'https://api.testnet.cspr.cloud/nft-token-offchain-metadata-statuses' \
  -H 'accept: application/json' \
  -H 'authorization: 55f79117-fc4d-4d60-9956-65423f39a06a'

{
  "data": [
    {
      "id": 0,
      "name": "None"
    },
    {
      "id": 1,
      "name": "Pending"
    },
    {
      "id": 2,
      "name": "Synced"
    },
    {
      "id": 3,
      "name": "Failed"
    }
  ]
}

Non-fungible token (NFT)

The NFTToken entity provides representation of an NFT on Casper Network. CSPR.cloud supports NFTs compatible with the CEP-47 and CEP-78 Casper Network standards.

Properties

The NFTToken entity has the following properties:

Property

Type

Description

contract_package_hash

string(64)

NFT contract package hash represented as a hexadecimal string. First of of token identifier

block_height

uint64

Height of the block in which the token was minted.

token_id

string

Token ID under the contract. Second part of token identifier

token_standard_id

uint8

identifier

owner_hash

string(64)

NFT token owner account or contract hash, represented as a hexadecimal string

owner_type

uint8

NFT owner type. 0 for account, 1 for contract

onchain_metadata

JSON

On-chain NFT metadata

offchain_metadata

JSON

Off-chain NFT metadata

offchain_metadata_status

uint8

identifier

is_burned

bool

true if the token was burn

tracking_id

uint32

Unique ID describes relation with corresponded .

timestamp

uint16

The timestamp of token creation

Example

{
  "contract_package_hash": "04682e17e5a86d594d9fd2bf37c766834bbaa412499bd6b5ac4ce76449708797",
  "block_height": 2404577,
  "is_burned": false,
  "offchain_metadata": {
    "attributes": [
      {
        "trait_type": "BG",
        "value": "Bg-1"
      },
      {
        "trait_type": "BG lines",
        "value": "Bg-Line-21"
      },
      {
        "trait_type": "Strpse",
        "value": "Card-stripse-01"
      }
    ],
    "description": "The first Tornado Master NFT minted by GuardianLink using Casper to announce the partnership with Casper.",
    "image": "https://arweave.net/H5RHizXPJez8zNMC07RVZxCApW42nSfF7FQk4jwyLHs",
    "name": "Tornado Master #0"
  },
  "offchain_metadata_status": 2,
  "onchain_metadata": {
    "name": "Tornado-Demo",
    "symbol": "TD",
    "token_uri": "https://yslkpbmdp345dabuwtvg65sqgd62lnpk2bp6mwha5hsrqxocw24q.arweave.net/xJanhYN--dGANLTqb3ZQMP2lterQX-ZY4OnlGF3Ctrk"
  },
  "owner_hash": "f41b57283a23958405373e8fbd9195ddbe71e8ea98fb2f4397ab09b2f63198af",
  "owner_type": 0,
  "timestamp": "2023-11-22T12:22:21Z",
  "token_id": "0",
  "token_standard_id": 2,
  "tracking_id": 258547
}

Optional properties

Depending on the endpoint some of the following optional properties may be included in the NFTToken entity:

Property

Type

Description

contract_package

NFT contract package

owner_public_key

string(68)

Owner public key if it's an account

Relations

Entity

Mapping property

Description

contract_package_hash

NFT tokens belong to a contract package

from_hash, to_hash

NFT token could have accounts as the token owner

tracking_id

NFT token actions are mapped by contract package hash and token id

Endpoints

The NFTToken entity has the following endpoints:

Get NFT
Get account NFTs
Get contract package NFTs

Relation endpoints

The NFTToken entity has the following relation endpoints:

Get NFT standards
Get off-chain NFT metadata statuses