Create auction

Builds an auction listing for asset by seller.

reservePrice is the minimum accepted bid and duration is the auction length in seconds. When startTime is given the clock starts then; otherwise it starts at the first bid.

minBidIncrement is read as basis points of the current bid (minimum 10 bps) unless absoluteIncrement is set, in which case it is a flat amount in the bid currency's base units.

timeExtPeriod and timeExtDelta configure anti-sniping: a bid landing within the final timeExtPeriod seconds pushes the deadline out by timeExtDelta seconds. bidMint denominates bids in an SPL token instead of SOL, and enablePrimarySplit splits the primary-sale proceeds among the on-chain creators (omitted, the proceeds go to the seller).

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.

memo?string

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

targetPriorityFeeLamports?integer

Total priority fee to target for this transaction, in lamports. The builder derives the compute-unit price from it and the transaction's compute budget. Omit to let mallow pick a fee from current network conditions.

Formatuint64

blockhash?string

Recent blockhash to stamp onto the transaction, base58. Omit to let mallow supply one — mallow's is cached for up to 10 seconds, so two identical requests inside that window compile the same transaction, with the same signature once signed. Supply your own to control the expiry window, or when otherwise-identical requests must produce distinct transactions. Rejected with a 400 if it is not valid base58; a blockhash the cluster has already aged out builds fine and fails at send time.

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"  }}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`