Sign in
auctions

Create a new auction

  Create a new auction for a specific slot. The auction will be initialized
  in 'pending' state and automatically transition through the 9-state lifecycle
  based on Ethereum slot timing.
post/api/v1/auctions

Request body

slotnumber required

Slot number for the auction

metadataobject

Auction metadata including reserve price and settlement method

Example request

{
  "slot": 1234567,
  "metadata": {
    "reservePrice": "1000000000000000000",
    "maxBidders": 100,
    "settlementMethod": "uniform_price"
  }
}

Response

Auction created successfully

idstring required

Unique auction identifier

slotnumber required

Slot number

state'pending' | 'bidding' | 'closing' | 'settling' | 'settled' | 'finalizing' | 'finalized' | 'disputed' | 'cancelled' required

Current auction state

createdAtstring date-time required

Auction creation timestamp

biddingDeadlinestring date-time required

Bidding deadline timestamp

settlementDeadlinestring date-time required

Settlement deadline timestamp

finalizedAtstring date-time

Finalization timestamp

metadataobject

Auction metadata

totalBidsnumber required

Total number of bids

clearingPricestring

Clearing price in wei

totalAllocatednumber

Total allocated quantity

Example response

{
  "id": "pfh0haxfpzowht3oi213cqos",
  "slot": 1234567,
  "state": "bidding",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "biddingDeadline": "2024-01-01T00:00:08.000Z",
  "settlementDeadline": "2024-01-01T00:00:12.000Z",
  "finalizedAt": "2024-01-01T00:00:20.000Z",
  "metadata": {
    "reservePrice": "1000000000000000000",
    "maxBidders": 100,
    "settlementMethod": "uniform_price"
  },
  "totalBids": 42,
  "clearingPrice": "1500000000000000000",
  "totalAllocated": 1000
}

Changes