API Reference

Collection NFTs

get
https://api.poprank.io/nfts/

Get a collection's NFTs.

Path Params
string
required

Identifies the collection on PopRank and is used in the URL.

Query Params
double

The offset at which to start returning tokens (after filtering and sorting). Default is 0.

double

The number of tokens to return. Must be between 1-200, inclusive.

string
enum

The sorting mode, e.g. 'aesthetic', 'price', 'rarityTraitSum'. The default is 'aesthetic'.

Allowed:
boolean

If false, the tokens are sorted in descending order. Default is true.

string

The partial or full name of tokens to be returned.

traitFilters
array of strings

The IDs of required traits of tokens to be returned.

traitFilters
ids
array of strings

The IDs of specific NFTs to return.

ids
double

The minimum aesthetic rank of tokens to be returned.

double

The maximum aesthetic rank of tokens to be returned.

double

The minimum rarity rank of tokens to be returned.

double

The maximum rarity rank of tokens to be returned.

double

The minimum price (in ETH) of tokens to be returned.

double

The maximum price (in ETH) of tokens to be returned.

string

If true, only user's tokens will be returned.

string

The wallet address of the user to be used in tandem with onlyUserTokens.

Responses

NFT objects.

Updated over 3 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 3 years ago