APIBid
Bid API Introduction
Complete overview of bid types, constants, and data structures
Bid API Overview
Comprehensive guide to bid management and auction participation
Constants
Payment Methods
💳
Payment Options
Available payment methods for bids
1
CREDITCredit card payment
2
CRYPTOCryptocurrency payment
3
WALLETNYYU wallet balance
Bid Status
📊
Bid Status Constants
Possible states of a bid
0
NOT_CONFIRMEDBid pending confirmation
1
WINNERWinning bid
2
FAILEDFailed or rejected bid
Types
Bid Type
📋
Bid Object Structure
Complete bid data model
type Bid {
userId: String
roundId: String
tokenAmount: Float
totalPrice: Float
tokenPrice: Float
tempTokenAmount: Float
tempTokenPrice: Float
delta: Float
pendingIncrease: Boolean
holdings: [BidHoldings]
payType: Int
cryptoType: String
placedAt: Float
updatedAt: Float
status: Int
}Bid Fields Reference
Identity & Round
userId - User placing the bidroundId - Auction round IDToken Information
tokenAmount - Total tokens to purchasetokenPrice - Price per tokentotalPrice - Total cost of bidTemporary Values
tempTokenAmount - Temp token amounttempTokenPrice - Temp token pricedelta - Price differencependingIncrease - Pending increase flagPayment Details
payType - Payment method (1-3)cryptoType - Crypto type (BTC, ETH, etc.)holdings - Payment holdings arrayTimestamps
placedAt - Bid placement timeupdatedAt - Last update timeStatus
status - Bid status (0-2)BidHoldings Type
💰
Bid Holdings Structure
Payment breakdown by cryptocurrency
type BidHoldings {
key: String
value: BidHolding
}
type BidHolding {
crypto: Float
usd: Float
}key
Cryptocurrency identifier (e.g., "BTC", "ETH")
value.crypto
Amount in cryptocurrency
value.usd
Equivalent value in USD
Bid Workflow
🔄
Typical Bid Lifecycle
From placement to resolution
1
Place Bid
User submits bid with status: 0 (NOT_CONFIRMED)
2
Optional Increase
User can increase token amount or price before round ends
3
Round Closes
Auction round ends and winning bids are determined
4
Status Update
Bid status becomes WINNER (1) or FAILED (2)
💡
Important Note
Crypto payments must be placed at least 10 minutes before round end to allow transaction confirmation time