Sign in
auctions

Get auctions with filtering and pagination

  Retrieve auctions with optional filtering by state, slot range, and other criteria.
  Results are paginated and include metadata for navigation.
get/api/v1/auctions

Query parameters

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

Filter by auction state

fromSlotnumber
Example:1234567

Filter auctions from this slot number

toSlotnumber
Example:1234600

Filter auctions up to this slot number

limitnumber
Example:20

Number of results to return

offsetnumber

Number of results to skip

Response

Paginated list of auctions with metadata

Example response

{
  "data": [
    {
      "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
    }
  ],
  "meta": {
    "limit": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true,
    "currentPageItems": 20
  },
  "links": {
    "first": "/api/v1/bids?limit=20&offset=0",
    "self": "/api/v1/bids?limit=20&offset=0",
    "next": "/api/v1/bids?limit=20&offset=20",
    "last": "/api/v1/bids?limit=20&offset=140"
  }
}

Changes