Bids (offers)

get

https://api.reservoir.tools/orders/bids/v6

Get a list of bids (offers), filtered by token, collection or maker. This API is designed for efficiently ingesting large volumes of orders, for external processing.

There are a different kind of bids than can be returned:

To get all orders unfiltered, select sortBy to updatedAt. No need to pass any other param. This will return any orders for any collections, token, attribute, etc.
Inputting a 'contract' will return token and attribute bids.
Inputting a 'collection-id' will return collection wide bids.
Please mark excludeEOA as true to exclude Blur orders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of strings

ids

token

string

Filter to a particular token. Example: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:123

tokenSetId

string

Filter to a particular 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.

maker

string

Filter to a particular user. Must set sources=blur.io to reveal maker's blur bids. Example: 0xF296178d553C8Ec21A2fBD2c5dDa8CA9ac905A00

community

string

Filter to a particular community. Example: artblocks

collectionsSetId

string

Filter to a particular collection set. Requires maker to be passed. Example: 8daa732ebe5db23f267e58d52f1c9b1879279bcdf4f78b8fb563390e6946ea65

contractsSetId

string

Filter to a particular contracts set.

collection

string

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

attribute

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/orders/bids/v5?collection=0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63&attribute[Type]=Original or https://api.reservoir.tools/orders/bids/v5?collection=0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63&attribute[Type]=Original&attribute[Type]=Sibling(Collection must be passed as well when filtering by attribute)

contracts

array of strings

length ≤ 80

Filter to an array of contracts. Example: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63

contracts

status

string

When only id is passed, orders with any status are returned. When passing id, status can be filtered using the possible values: active, inactive, expired, cancelled, or filled. When only maker is passed, orders with active statuses are returned. When passing maker, status can be filtered using the possible values: active, inactive, expired, cancelled, and filled. When only contracts is passed, orders with active statuses are returned. When contracts and sortBy=updatedAt are passed, orders with any status are returned. When passing contracts, status can be filtered using the possible value of active only.

sources

array of strings

length ≤ 80

sources

orderType

string

enum

Filter to a particular order type. Must be one of token, collection, attribute, custom. Only valid when a maker is specified.

Allowed:

native

boolean

If true, results will filter only Reservoir orders.

includePrivate

boolean

If true, private orders are included in the response.

includeCriteriaMetadata

boolean

If true, criteria metadata is included in the response. defaults to false

includeRawData

boolean

If true, raw data is included in the response. Set sources=blur.io and make this true to reveal individual blur bids. defaults to false

includeDepth

boolean

If true, the depth of each order is included in the response. defaults to false

startTimestamp

number

Get events after a particular unix timestamp (inclusive)

endTimestamp

number

Get events before a particular unix timestamp (inclusive)

excludeEOA

boolean

Exclude orders that can only be filled by EOAs, to support filling with smart contracts. defaults to false

excludeSources

array of strings

length ≤ 80

excludeSources

normalizeRoyalties

boolean

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

sortBy

string

enum

Order the items are returned in the response. Sorting by price defaults sorting direction to descending. defaults to createdAt

Allowed:

sortDirection

string

continuation

string

Use continuation token to request next offset of items.

limit

integer

1 to 1000

Amount of items returned in response. Max limit is 1000. defaults to 50

displayCurrency

string

Return result in given currency

Response

200Successful