Buy tokens

post deprecated

https://api.reservoir.tools/execute/buy/v6

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderIds

array of strings

orderIds

rawOrders

array of objects

rawOrders

tokens

array of strings

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

tokens

quantity

integer

Quantity of tokens user is buying. Only compatible when buying a single ERC1155 token. Example: 5

taker

string

required

^0x[a-fA-F0-9]{40}$

Address of wallet filling the order. Example: 0xF296178d553C8Ec21A2fBD2c5dDa8CA9ac905A00

relayer

string

^0x[a-fA-F0-9]{40}$

Address of wallet relaying the filling transaction

onlyPath

boolean

Defaults to false

If true, only the path will be returned.

forceRouter

boolean

If true, all fills will be executed through the router.

currency

string

enum

Currency to buy all listings in.

Allowed:

normalizeRoyalties

boolean

Defaults to false

preferredOrderSource

string

^[a-zA-Z0-9.-]+\.[a-zA-Z0-9]{2,}$|localhost

If there are multiple listings with equal best price, prefer this source over others.
NOTE: if you want to fill a listing that is not the best priced, you need to pass a specific order ID.

source

string

^[a-zA-Z0-9.-]+\.[a-zA-Z0-9]{2,}$|localhost

Filling source used for attribution. Example: reservoir.market

feesOnTop

array of strings

List of fees (formatted as feeRecipient:feeAmount) to be taken when filling.
Unless overridden via the currency param, the currency used for any fees on top matches the buy-in currency detected by the backend.
Example: 0xF296178d553C8Ec21A2fBD2c5dDa8CA9ac905A00:1000000000000000

feesOnTop

partial

boolean

Defaults to false

If true, any off-chain or on-chain errors will be skipped.

maxFeePerGas

string

^[0-9]+$

Optional. Set custom gas price.

maxPriorityFeePerGas

string

^[0-9]+$

Optional. Set custom gas price.

skipBalanceCheck

boolean

Defaults to false

If true, balance check will be skipped.

allowInactiveOrderIds

boolean

Defaults to false

If true, do not filter out inactive orders (only relevant for order id filtering).

excludeEOA

boolean

Defaults to false

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

x2y2ApiKey

string

Override the X2Y2 API key used for filling.

Response

Language

Credentials

Header

URL

Loading…

Response

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

*/*

200Successful