xga.fyi
API Endpoints/Auctions

Get auction overview with current, next, and latest information

Consolidated endpoint providing a complete auction system overview:

Current Auction

  • Active auction details and real-time progress
  • Live bidding status and market metrics
  • Timing information and phase tracking

Next Auction

  • Upcoming auction details and timing
  • Auto-creation status and slot scheduling

Latest Results

  • Most recent completed auction results
  • Final metrics and settlement data

Quick Bid Suggestions

  • Market-based bid recommendations
  • Competitive analysis and positioning
  • Gas fee estimates and bidding windows

System Status

  • Current Ethereum slot and system health
  • Rate limiting and operational status

This endpoint is optimized for dashboard displays and provides all essential auction information in a single request with 5-second caching.

GET
/api/v1/auctions/overview

Response Body

curl -X GET "http://localhost:3000/api/v1/auctions/overview"
fetch("http://localhost:3000/api/v1/auctions/overview")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "http://localhost:3000/api/v1/auctions/overview"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "http://localhost:3000/api/v1/auctions/overview"

response = requests.request("GET", url)

print(response.text)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("http://localhost:3000/api/v1/auctions/overview"))
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}
using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
var response = await client.GetAsync("http://localhost:3000/api/v1/auctions/overview");
var responseBody = await response.Content.ReadAsStringAsync();
{
  "current": {
    "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
  },
  "next": {
    "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
  },
  "latest": {
    "slot": 1234567,
    "state": "finalized",
    "clearingPrice": "1500000000000000000",
    "totalBids": 42,
    "totalAllocated": 1000,
    "winningBidders": 15,
    "finalizedAt": "2024-01-01T00:00:20.000Z",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "duration": 300,
    "autoCreated": false,
    "successRate": 0.85,
    "totalRevenue": "1500000000000000000000"
  },
  "timing": {
    "startsInMs": 48000,
    "biddingEndsInMs": 12000,
    "settlementEndsInMs": 0,
    "currentPhase": "bidding",
    "progressPercent": 75.5
  },
  "quickBid": {
    "suggestedValue": "1750000000000000000",
    "minCompetitive": "1500000000000000000",
    "currentHighest": "3000000000000000000",
    "suggestedGasCap": "50000000000",
    "biddingAllowed": true
  },
  "marketMetrics": {
    "totalVolume": 1000000,
    "uniqueBidders": 25,
    "averageBidSize": "1500000000000000000",
    "highestBid": "5000000000000000000",
    "marketConcentration": 2500,
    "priceVolatility": 0.15,
    "bidRate": 12.5
  },
  "recentBids": [
    {
      "id": "tz4a98xxat96iws9zmbrgj3a",
      "slot": 1234567,
      "entityId": "entity-123",
      "value": "1000000000000000000",
      "quantity": 100,
      "gasFeeCap": "20000000000",
      "gasTipCap": "2000000000",
      "builderPublicKey": "0x1234567890abcdef...",
      "status": "pending",
      "submittedAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "validatedAt": "2024-01-01T00:00:05.000Z",
      "validFrom": "2024-01-01T00:00:00.000Z",
      "validUntil": "2024-01-01T00:00:12.000Z",
      "version": 1,
      "nonce": "1234567890",
      "metadata": {
        "priority": "high",
        "source": "api"
      },
      "isActive": true,
      "isModifiable": true,
      "hasExpired": false
    }
  ],
  "currentSlot": 1234567,
  "systemStatus": "operational",
  "generatedAt": "2024-01-01T12:00:00.000Z"
}