Create auction

Builds an auction of asset by seller.

reservePrice is the lowest accepted bid, and duration is in seconds. The auction starts at startTime, or at the first bid when omitted. timeExtPeriod and timeExtDelta extend the auction when a bid arrives near the end. Bids are in SOL unless bidMint is set.

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Opens an auction for an artwork.

seller*string

Wallet auctioning the artwork (base58). Must own it and signs the transaction.

asset*string

Mint address of the artwork to auction (base58).

reservePrice*integer

Minimum accepted bid, in the bid currency's base units.

Formatuint64

duration*integer

Auction length in seconds, measured from the start.

Formatuint32

minBidIncrement*integer

How much each bid must exceed the current one. Read as basis points of the current bid (minimum 10) unless absoluteIncrement is set, in which case it is a flat amount in the bid currency's base units.

Formatuint64

absoluteIncrement?boolean

Treat minBidIncrement as a flat amount rather than basis points.

enablePrimarySplit?boolean

Split the primary-sale proceeds among the on-chain creators by their shares. Omitted or false pays the seller instead, with royalties still going to the creators.

startTime?integer

Unix timestamp in seconds when the auction clock starts. When omitted, the clock starts at the first bid instead.

Formatint64

timeExtPeriod?integer

Anti-sniping window in seconds. A bid landing within this many seconds of the deadline extends it by timeExtDelta.

Formatuint32

timeExtDelta?integer

Seconds the deadline is pushed out by when a bid lands inside timeExtPeriod.

Formatuint32

bidMint?string

SPL token mint bids are denominated in (base58). Defaults to SOL when omitted.

Default"So11111111111111111111111111111111111111112"

memo?string

Free-form note written on-chain alongside the auction.

targetPriorityFeeLamports?integer

Priority fee per transaction, in lamports. By default it is a cap: mallow pays what the network currently needs, up to this amount (50,000 when omitted). Set exactPriorityFee to pay exactly this amount instead. The fee is never less than 15,000 lamports.

Formatuint64

exactPriorityFee?boolean

Pay targetPriorityFeeLamports exactly instead of treating it as a cap. Defaults to false.

blockhash?string

Recent blockhash to build the transaction with (base58). Omit it to let mallow supply one; identical requests a few seconds apart then return the same transaction.

Response Body

`application/json`

curl -X POST "https://example.com/v2/tx/auctions/create" \  -H "Content-Type: application/json" \  -d '{    "seller": "string",    "asset": "string",    "reservePrice": 0,    "duration": 0,    "minBidIncrement": 0  }'

{  "result": {    "tx": "string",    "setupTx": "string"  }}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`