Create Bids

post

https://api.reservoir.tools/execute/bid/v5

Generate bids and submit them to multiple marketplaces.

Notes:

Please use the /cross-posting-orders/v1 to check the status on cross posted bids.
We recommend using Reservoir SDK as it abstracts the process of iterating through steps, and returning callbacks that can be used to update your UI.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
We recommend using Reservoir SDK
Reservoir SDK includes helpers that abstract the process of using the Trading API such as iterating through execution steps and returning callbacks that can be used to update your UI. The SDK can reduce the chance of errors. If you are developing in TS/JS we recommend using the ReservoirSDK.

Body Params

maker

string

required

Address of wallet making the order. Example: 0xF296178d553C8Ec21A2fBD2c5dDa8CA9ac905A00

source

string

Domain of your app that is creating the order, e.g. myapp.xyz. This is used for filtering, and to attribute the "order source" of sales in on-chain analytics, to help your app get discovered. Lean more here

blurAuth

string

Advanced use case to pass personal blurAuthToken; the API will generate one if left empty.

params

array of objects

length ≥ 1

params

token

string

Bid on a particular token. Example: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63:123

tokenSetId

string

Bid on a particular token set. Cannot be used with cross-posting to OpenSea. 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.

collection

string

Bid on a particular collection with collection-id. Example: 0x8d04a8c79ceb0889bdd12acdf3fa9d207ed3ff63

attributeKey

string

Bid on a particular attribute key. This is case sensitive. Example: Composition

attributeValue

string

Bid on a particular attribute value. This is case sensitive. Example: Teddy (#33)

quantity

number

Quantity of tokens to bid on.

weiPrice

string

required

Amount bidder is willing to offer in the smallest denomination for the specific currency. Example: 1000000000000000000

orderKind

string

enum

Defaults to seaport-v1.5

Exchange protocol used to create order. Example: seaport-v1.5

options

object

Additional options.

orderbook

string

enum

Defaults to reservoir

Orderbook where order is placed. Example: Reservoir

Allowed:

orderbookApiKey

string

Optional API key for the target orderbook

automatedRoyalties

boolean

Defaults to true

If true, royalty amounts and recipients will be set automatically.

royaltyBps

number

Set a maximum amount of royalties to pay, rather than the full amount. Only relevant when using automated royalties. 1 BPS = 0.01% Note: OpenSea does not support values below 50 bps.

fees

array of strings

Deprecated, use marketplaceFees and/or customRoyalties

fees

marketplaceFees

array of strings

List of marketplace fees (formatted as feeRecipient:feeBps) to be bundled within the order. 1 BPS = 0.01% Example: 0xF296178d553C8Ec21A2fBD2c5dDa8CA9ac905A00:100

marketplaceFees

marketplaceFlatFees

array of strings

List of marketplace flat fees (formatted as feeRecipient:weiAmount) to be bundled within the order.

marketplaceFlatFees

customRoyalties

array of strings

List of custom royalties (formatted as feeRecipient:feeBps) to be bundled within the order. 1 BPS = 0.01% Example: 0xF296178d553C8Ec21A2fBD2c5dDa8CA9ac905A00:100

customRoyalties

excludeFlaggedTokens

boolean

Defaults to false

If true flagged tokens will be excluded

listingTime

string

Unix timestamp (seconds) indicating when listing will be listed. Example: 1656080318

expirationTime

string

Unix timestamp (seconds) indicating when listing will expire. Example: 1656080318

salt

string

Optional. Random string to make the order unique

nonce

string

Optional. Set a custom nonce

currency

string

Defaults to 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2

usePermit

boolean

When true, will use permit to avoid approvals.

checkMakerOutstandingBalance

boolean

Check if the maker has enough balance to cover all open bid orders (of the current token / collection / attribute type)

We recommend using Reservoir SDK

200Successful