NFTs

NFTs the latest buzz in the crypto world and Unmarshal is there to support with the data needs around NFTs as well.

NFT assets by Address with offset based pagination

NFT assets API gives the information about all the NFT assets held by a address with pagination (offset based pagination). In this endpoint instead of navigating with page parameter we can navigate using offset, where the next offset is provided in the response.

For solana pagination and contract address filtering is not supported at the moment.

Filters: 

  •     Get Nft assets of an address for a specified contract
    Contract Address Filtering, returns assets which belongs to the specified contract.(contract query parameter accepts any valid ERC721 or Erc1155 contract address)
Request
Security:
auth_key
path Parameters
address
required
string
Default: "demo.eth"

Any valid address or ENS

Example: demo.eth
chain
required
string
Enum: "ethereum" "bsc" "matic" "avalanche" "solana" "bsc-testnet" "matic-testnet"
Example: bsc
query Parameters
offset
string

The offset to start with, this is returned in the previous response.

pageSize
number
Default: 25

Number of records to be fetched per page

Example: pageSize=5
contract
string

Valid contract address

Responses
200
401
get/v3/{chain}/address/{address}/nft-assets
Request samples
    4 more
    JavaScript
    PHP
    Ruby
    C#
curl -i -X GET \
  'https://api.unmarshal.com/v3/:chain/address/:address/nft-assets?offset=string&pageSize=5&contract=string&auth_key=YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "items_on_page": 14,
  • "next_offset": 16,
  • "nft_assets": [
    ]
}

NFT Transactions by Address

NFT transactions API gives the list of transaction being made on given wallet address.

Request
Security:
auth_key
path Parameters
chain
required
string
Enum: "ethereum" "bsc" "matic" "avalanche" "bsc-testnet" "matic-testnet"
Example: bsc
address
required
string
Default: "demo.eth"

Any valid address or ENS

Example: demo.eth
Responses
200

Example response

401
get/v1/{chain}/address/{address}/nft-transactions
Request samples
    4 more
    JavaScript
    PHP
    Ruby
    C#
curl -i -X GET \
  'https://api.unmarshal.com/v1/:chain/address/:address/nft-transactions?auth_key=YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "contract_address": "0x3a3e2aef7e44fd0bb3f0e2330c5b8f078816cbf6",
  • "token_id": "6470",
  • "transaction_hash": "0x550ab896bad15a82e2a0c3458f86929dd79b924732cfe875d5f6d192c5ee2c4b",
  • "block_number": 11703141,
  • "block_hash": "",
  • "transaction_idx": 0,
  • "log_idx": 512,
  • "sender": "0x0000000000000000000000000000000000000000",
  • "to": "0x6877654e79119a7f9a8182bb2389e797ca421d24"
}

NFT Transactions by Address with pagination

NFT transactions API gives the list of transaction being made on given wallet address with pagination.

Request
Security:
auth_key
path Parameters
chain
required
string
Enum: "ethereum" "bsc" "matic" "avalanche" "bsc-testnet" "matic-testnet"
Example: bsc
address
required
string
Default: "demo.eth"

Any valid address or ENS

Example: demo.eth
query Parameters
page
number >= 1
Default: 1

Page you want to query

pageSize
number
Default: 25

Number of records to be fetched per page

Example: pageSize=5
Responses
200

Example response

401
get/v2/{chain}/address/{address}/nft-transactions
Request samples
    4 more
    JavaScript
    PHP
    Ruby
    C#
curl -i -X GET \
  'https://api.unmarshal.com/v2/:chain/address/:address/nft-transactions?page=1&pageSize=5&auth_key=YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "page": 1,
  • "total_pages": 1,
  • "items_on_page": 18,
  • "total_txs": 18,
  • "transactions": [
    ]
}

NFT details of all tokenIds of a contract

This NFT gives more details about a specific NFT based on NFT id(if token Id not provided returns all token .Basically the metadata of an NFT which is currently most sought after

Request
Security:
auth_key
path Parameters
chain
required
string
Enum: "ethereum" "bsc" "matic" "avalanche" "bsc-testnet" "matic-testnet"
Example: bsc
address
required
string

Any valid Nft Contract address

query Parameters
tokenId
string

Valid nft token Id of a requested nft contract

page
number >= 1
Default: 1

Page you want to query

pageSize
number
Default: 25

Number of records to be fetched per page

Example: pageSize=5
Responses
200

Example response

401
get/v2/{chain}/address/{address}/details
Request samples
    4 more
    JavaScript
    PHP
    Ruby
    C#
curl -i -X GET \
  'https://api.unmarshal.com/v2/:chain/address/:address/details?tokenId=string&page=1&pageSize=5&auth_key=YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "page": 1,
  • "total_pages": 1,
  • "items_on_page": 1,
  • "total_token_ids": 1,
  • "nft_token_details": [
    ]
}

Get Nft Contract Transactions

Get all the contract transactions of an nft, also filter all the transactions of a particular token Id of the contract (optional)

Request
Security:
auth_key
path Parameters
chain
required
string
Enum: "ethereum" "bsc" "matic" "avalanche" "bsc-testnet" "matic-testnet"
Example: bsc
address
required
string

Any valid Nft Contract address

query Parameters
tokenId
string

Valid nft token Id of a requested nft contract

page
number >= 1
Default: 1

Page you want to query

pageSize
number
Default: 25

Number of records to be fetched per page

Example: pageSize=5
Responses
200

Example response

401
get/v1/{chain}/contract/{address}/nft-transactions
Request samples
    4 more
    JavaScript
    PHP
    Ruby
    C#
curl -i -X GET \
  'https://api.unmarshal.com/v1/:chain/contract/:address/nft-transactions?tokenId=string&page=1&pageSize=5&auth_key=YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "contract_address": "0x3a3e2aef7e44fd0bb3f0e2330c5b8f078816cbf6",
  • "token_id": "6470",
  • "transaction_hash": "0x550ab896bad15a82e2a0c3458f86929dd79b924732cfe875d5f6d192c5ee2c4b",
  • "block_number": 11703141,
  • "block_hash": "",
  • "transaction_idx": 0,
  • "log_idx": 512,
  • "sender": "0x0000000000000000000000000000000000000000",
  • "to": "0x6877654e79119a7f9a8182bb2389e797ca421d24"
}

Get all token ids available for a nft contract

This Endpoint returns all token Ids available for the specified contract

Request
Security:
auth_key
path Parameters
chain
required
string
Enum: "ethereum" "bsc" "matic" "avalanche" "bsc-testnet" "matic-testnet"
Example: bsc
address
required
string

Any valid Nft Contract address

Responses
200
401
get/v1/{chain}/contract/{address}/tokenIds
Request samples
    4 more
    JavaScript
    PHP
    Ruby
    C#
curl -i -X GET \
  'https://api.unmarshal.com/v1/:chain/contract/:address/tokenIds?auth_key=YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "contract_address": "0x06012c8cf97bead5deae237070f9587f8e7a266d",
  • "token_id": "1137603",
  • "token_uri": "https://www.cryptokitties.co/kitty/1137603",
  • "actual_owner": "0xfC43f5F9dd45258b3AFf31Bdbe6561D97e8B71de",
  • "image_url": "https://img.cryptokitties.co/0x06012c8cf97bead5deae237070f9587f8e7a266d/1137603.shadow.png",
  • "name": "cryptokitties",
  • "type": "721",
  • "price": "0.277582534582129187",
  • "animation_url": "",
  • "description": "CryptoKitties is a game centered around breedable, collectible, and oh-so-adorable creatures we call CryptoKitties! Each cat is one-of-a-kind and 100% owned by you; it cannot be replicated, taken away, or destroyed.",
  • "creator": "0x09191d18729da57a83a9afc8ace0c8d7d104e118"
}

NFT holders by id

This api gives history of owners for a given NFT.

Request
Security:
auth_key
path Parameters
address
required
string

Any valid Nft Contract address

chain
required
string
Enum: "ethereum" "bsc" "matic" "avalanche" "bsc-testnet" "matic-testnet"
Example: bsc
query Parameters
tokenId
required
string

Valid nft token Id of a requested nft contract

Responses
200

Example response

401
get/v1/{chain}/address/{address}/nftholders
Request samples
    4 more
    JavaScript
    PHP
    Ruby
    C#
curl -i -X GET \
  'https://api.unmarshal.com/v1/:chain/address/:address/nftholders?tokenId=string&auth_key=YOUR_API_KEY_HERE'
Response samples
application/json
No sample