Collections

get

https://api.reservoir.tools/collections/v7

Use this API to explore a collection's metadata and statistics (sales, volume, etc).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Filter to a particular collection with collection id. The id is immutable. For single contract collections, the id is the contract address e.g. 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63 Artblocks will follow this format with a token range: {artblocksContractAddress}:{startTokenId}:{endTokenId} Shared contracts will generally follow the format {contract}:{namespace}-{id}; The following shared contracts will follow this format: OpenSea, Sound, SuperRare, Foundation, Ordinals, & Courtyard

slug

string

Filter to a particular collection slug. We recommend to rely on collection id; slugs are dynamic and can change without warning. Example: boredapeyachtclub

collectionsSetId

string

Filter to a particular collection set. Example: 8daa732ebe5db23f267e58d52f1c9b1879279bcdf4f78b8fb563390e6946ea65

community

string

Filter to a particular community. Example: artblocks

contract

array of strings

length ≤ 20

contract

creator

string

Filter by creator

name

string

Search for collections that match a string. Example: bored

maxFloorAskPrice

number

Maximum floor price of the collection

minFloorAskPrice

number

Minumum floor price of the collection

includeAttributes

boolean

If true, attributes will be included in the response. Must filter by id or slug to a particular collection.

includeSalesCount

boolean

If true, sales count (1 day, 7 day, 30 day, all time) will be included in the response. Must filter by id or slug to a particular collection.

includeMintStages

boolean

If true, mint data for the collection will be included in the response. defaults to false

includeSecurityConfigs

boolean

If true, security configuration data (e.g. ERC721C or Operator Filter Registry configuration) will be included in the response. defaults to false

normalizeRoyalties

boolean

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

useNonFlaggedFloorAsk

boolean

If true, return the non flagged floor ask. Supported only when normalizeRoyalties is false. defaults to false

sortBy

string

enum

Order the items are returned in the response. Options are #DayVolume, createdAt, updatedAt, lastMintTimestamp, or floorAskPrice defaults to allTimeVolume

sortDirection

string

limit

integer

≥ 1

Amount of items returned in response. Default and max limit is 20, unless sorting by updatedAt which has a max limit of 1000. defaults to 20

excludeSpam

boolean

If true, will filter any collections marked as spam. defaults to false

excludeNsfw

boolean

If true, will filter any collections marked as nsfw. defaults to false

startTimestamp

number

When sorting by updatedAt, the start timestamp you want to filter on (UTC).

endTimestamp

number

When sorting by updatedAt, the end timestamp you want to filter on (UTC).

continuation

string

Use continuation token to request next offset of items.

displayCurrency

string

Input any ERC20 address to return result in given currency. Applies to topBid and floorAsk.

Response

200Successful