Auction API

Manage auction rounds, track bids, and handle token sales with comprehensive auction system APIs

Overview

The Auction API enables you to manage auction rounds within the NYYU platform, including details about timing, tokens, status, and associated avatars.

Core Types

Auction

🏛️

Auction Type

Represents an auction round with comprehensive details

type Auction {
  id: Int!
  regDate: Float
  updateDate: Float
  deleted: Int
  round: Int
  startedAt: Float
  endedAt: Float
  totalToken: Float
  minPrice: Float
  avatar: [AvatarSet]
  token: Float
  sold: Float
  stats: AuctionStats
  status: Int
}

Core Fields

id - Unique identifier

round - Round number

status - Current status (0-3)

deleted - Deletion flag

Timing Fields

regDate - Registration timestamp

updateDate - Last update timestamp

startedAt - Start time

endedAt - End time

Token Fields

totalToken - Total tokens available

minPrice - Minimum token price

token - Avatar bonus tokens

sold - Tokens sold

Related Data

avatar - Avatar sets array

stats - Auction statistics

AvatarSet

🎭

AvatarSet Type

Avatar components associated with an auction

type AvatarSet {
  id: Int!
  regDate: Float
  updateDate: Float
  deleted: Int
  groupId: String
  compId: Int
}

groupId

Component category

compId

Component unique ID

AvatarSetInput

📝AvatarSetInput (Input Type)

input AvatarSetInput {
  groupId: String
  compId: Int
}

Used when setting avatar components in auction creation or updates

AuctionStats

📊

AuctionStats Type

Statistical information about auction performance

type AuctionStats {
  qty: Float
  win: Float
  fail: Float
}

qty

Token quantity

win

Winning bids

fail

Failed bids

CurrentRound

🔄CurrentRound Type

type CurrentRound {
  status: String
  auction: Auction
  presale: PreSale
}

Represents the current auction or presale round in the system

Auction Status

🚦

Status Constants

Auction lifecycle states

PENDING

Auction created but not yet started

COUNTDOWN

Counting down, will start automatically when timer reaches zero

STARTED

Auction is currently active and accepting bids

ENDED

Auction has concluded, no longer accepting bids

Key Features

⏱️

Real-time Tracking

Monitor auction rounds with Unix timestamps for precise timing control

🎨

Avatar Integration

Associate avatar components with auctions for enhanced user rewards

📈

Performance Stats

Track auction performance with win/fail bid statistics

🔄

Status Management

Automatic status transitions from pending through countdown to active

🚀

Ready to integrate?

Explore our mutation and query documentation to start managing auction rounds

Auction API Overview