Tokens

get https://api.reservoir.tools/tokens/v5

Get a list of tokens with full metadata. This is useful for showing a single token page, or scenarios that require more metadata.

Query Params

collection

string

Filter to a particular collection with collection-id. Example: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63

collectionsSetId

string

Filter to a particular collection set.

community

string

Filter to a particular community. Example: artblocks

contract

string

Filter to a particular contract. Example: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63

tokenName

string

Filter to a particular token by name. Example: token #1

tokens

array of strings

length ≤ 50

Array of tokens. Example: tokens[0]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:704 tokens[1]: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:979

tokens

tokenSetId

string

Filter to a particular token set. Example: token:CONTRACT:TOKEN_ID representing a single token within contract, contract:CONTRACT representing a whole contract, range:CONTRACT:START_TOKEN_ID:END_TOKEN_ID representing a continuous token id range within a contract and list:CONTRACT:TOKEN_IDS_HASH representing a list of token ids within a contract.

attributes

string

Filter to a particular attribute. Note: Our docs do not support this parameter correctly. To test, you can use the following URL in your browser. Example: https://api.reservoir.tools/tokens/v5?collection=0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63&attributes[Type]=Original or https://api.reservoir.tools/tokens/v5?collection=0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63&attributes[Type]=Original&attributes[Type]=Sibling

source

string

Domain of the order source. Example opensea.io (Only listed tokens are returned when filtering by source)

nativeSource

string

Domain of the order source. Example www.apecoinmarketplace.com. For a native marketplace, return all tokens listed on this marketplace, even if better prices are available on other marketplaces.

minRarityRank

integer

≥ 1

Get tokens with a min rarity rank (inclusive)

maxRarityRank

integer

≥ 1

Get tokens with a max rarity rank (inclusive)

minFloorAskPrice

number

Get tokens with a min floor ask price (inclusive)

maxFloorAskPrice

number

Get tokens with a max floor ask price (inclusive)

flagStatus

number

Allowed only with collection and tokens filtering!
-1 = All tokens (default)
0 = Non flagged tokens
1 = Flagged tokens

sortBy

string

Order the items are returned in the response. defaults to floorAskPrice

sortDirection

string

currencies

array of strings

length ≤ 50

Filter to tokens with a listing in a particular currency. Example: currencies[0]: 0x0000000000000000000000000000000000000000

currencies

limit

integer

1 to 100

Amount of items returned in response. defaults to 20

includeTopBid

boolean

If true, top bid will be returned in the response. defaults to false

includeAttributes

boolean

If true, attributes will be returned in the response. defaults to false

includeQuantity

boolean

If true, quantity filled and quantity remaining will be returned in the response. defaults to false

includeDynamicPricing

boolean

If true, dynamic pricing data will be returned in the response. defaults to false

includeRoyaltiesPaid

boolean

If true, a boolean indicating whether royalties were paid on a token's last sale will be returned in the response. defaults to false

normalizeRoyalties

boolean

If true, prices will include missing royalties to be added on-top. defaults to false

continuation

string

Use continuation token to request next offset of items.

displayCurrency

string

Return result in given currency

Response

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.reservoir.tools/tokens/v5 \
3
     --header 'accept: */*' \
4
     --header 'x-api-key: demo-api-key'

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

*/*

200Successful