Retrieve contract NFTs

get https://api.nftport.xyz/v0/nfts/{contract_address}

Returns all NFTs for a given contract address. Can be set to include the NFT metadata, file_information, rarity, last_sale_price or all which returns extra information. Ethereum, Polygon and Goerli are supported.

Useful for:

Importing all NFTs from a given contract to your application.

For a quick start, see the List of sample addresses to copy.
To get detailed information on the returned NFTs, see Retrieve NFT details.
To get NFTs that a given account owns, see Retrieve NFTs owned by an account.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

contract_address

string

required

Defaults to 0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d

Contract address from which to query NFTs also known as the collection address.

Query Params

chain

string

required

Defaults to ethereum

Blockchain from which to query NFTs.

page_number

integer

≥ 1

Defaults to 1

The page number of the results to return. The first page is 1.

page_size

integer

1 to 50

Defaults to 50

The number of results returned per page. Limit can range between 1 and 50, and the default is 50.

include

array of strings

required

Defaults to metadata

Include optional data in the response. default is the minimal response, metadata includes NFT metadata and cached_file_url, file_information includes extra information of the NFT’s file, rarity includes NFT rarity data and NFT attributes (traits), last_sale_price includes last sale price of an NFT and all includes full details like in Retrieve NFT details. Fields can be combined to get desired result.

include*

refresh_metadata

boolean

Defaults to false

Queues and refreshes all the NFTs metadata inside the contract (i.e. all tokens) if they have changed since the updated_date. Useful for example, when NFT collections are revealed.

Response

`nfts` property that contains an array of up to `page_size` NFTs. Each entry in the array is a separate NFT. If no more NFTs are available, the resulting array will be empty.

Response body

object

response

string

required

Response status, either OK or NOK.

nfts

array of objects

Details of the NFTs.

Nfts

object

chain

string

required

Defaults to ethereum

An enumeration.

ethereum polygon goerli

contract_address

string

required

The contract address of the NFT.

token_id

string

required

A unique uint256 ID inside the contract. The contract address and token ID pair is a globally unique and fully-qualified identifier for a specific NFT on chain.

metadata_url

string

Metadata URL inside the contract for a given token, also known as the token URI. For ERC-721 it is the token_uri() function and for ERC-1155 it is the uri() function in the smart contract.

metadata

object

Raw NFT metadata downloaded from the metadata_url i.e. token URI. It usually includes the name, description and attributes along with any other data added by the creator.

Has additional fields

file_information

object

Extra information of the NFT’s file.

file_url

string

Original file (image, video, etc) URL of the NFT.

animation_url

string

URL of multi-media file set in the NFT metadata. Most commonly used file types are GLTF, GLB, WEBM, MP4, M4V, OGV, OGG, along with audio MP3, WAV, and OGA. Also HTML pages, allowing to build rich experiences and interactive NFTs using JavaScript canvas, WebGL, and more.

cached_file_url

string

Cached file (image, video, etc) in NFTPort's cloud with no access restrictions, low latency and high availability.

cached_animation_url

string

Cached URL of animated file (video, gif, etc) as set in the NFT metadata. This URL points to a file cached in NFTPort's cloud storage with no access restrictions, low latency and high availability.

creator_address

string

NFT creator address.

mint_date

string

Date when the NFT was minted (ISO).

updated_date

string

Date when the NFT’s metadata was last downloaded or updated/refreshed.

owner

string

Current owner of the NFT.

rarity

object

Rarity data of the NFT. Included only if rarity value provided for the include parameter.

attributes

array of objects

A list of NFT attributes (traits). Included only if rarity value provided for the include parameter.

Attributes

object

trait_type

string

required

Trait type.

display_type

string

Display type.

value

string

required

Attribute value.

statistics

object

required

Attribute statistics.

last_sale_price

object

Price details of the latest sale.

contract

object

Information of the NFT’s contract.

name

string

Name of the contract.

symbol

string

Symbol of the contract.

type

string

Contract type.

ERC721 ERC1155 CRYPTO_PUNKS

metadata

object

Metadata about the collection.

total

integer

Total number of NFTs in the given contract address.

status

string

Status of the contract tokens in the metadata refresh queue.

ADDED PROCESSING PENDING REFRESHED_RECENTLY

status_message

string

Detailed description of the status.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.nftport.xyz/v0/nfts/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d?chain=ethereum&page_number=1&page_size=50&include=metadata&refresh_metadata=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A JSON object with an nfts property that contains an array of up to page_size NFTs. Each entry in the array is a separate NFT. If no more NFTs are available, the resulting array will be empty.

`nfts` property that contains an array of up to `page_size` NFTs. Each entry in the array is a separate NFT. If no more NFTs are available, the resulting array will be empty.