Get Auctions
GET/public/NftAuctions
Get NFT auctions. Returns information about a specific auction. The auction can be retrieved by either the auction identifier or the NFT identifier.
Request
Query Parameters
Default value: 4294967295
Default value: 0
Possible values: [open
, closed
, expired
]
Responses
- 200
Response
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- Array [
- MOD1
- MOD2
- MOD3
- MOD1
- MOD2
- MOD3
- ]
- MOD1
- MOD2
- MOD3
- MOD4
- MOD1
- MOD2
- MOD3
- MOD4
- ]
result object[]nullable
Auction id
bids object[]required
Array of bids
amount object required
An amount, either as a string, and integer, or a decimal value
string
integer
number
Possible values: [Open
, Cancelled
, Filled
, PartialFilled
, Superceded
]
Possible values: [Sell
, Buy
, Offer
]
usd_equivalence object required
An amount, either as a string, and integer, or a decimal value
string
integer
number
buyout_price object
Optional buyout price (price at which an item can be immediately purchased)
string
integer
number
object
unix time (in seconds) defining the expiry time of the auction
Time in seconds defining the extension time
Array of NFT identifiers
Currency for sale
reserve_price object
Optional minimum price at which the item can be sold
string
integer
number
object
If auction was created to match an existing offer, offer id will be the auction's root id
unix time (in seconds) defining the start time of the auction
Possible values: [open
, closed
, expired
]
Auction status
Auction status detail
Possible values: [fixed
, ascending
]
Auction type
Social id of the selling user
{
"error": [
"EGeneral:Invalid arguments"
],
"result": [
{
"auction_id": "string",
"bids": [
{
"amount": "string",
"auction_id": "string",
"currency": "string",
"id": "string",
"lock_time": 0,
"nft_ids": [
"string"
],
"social_id": "string",
"status": "Open",
"status_detail": "string",
"time": 0,
"type": "Sell",
"usd_equivalence": "string",
"volume": 0
}
],
"buyout_price": "string",
"expiry_time": 0,
"extension_time": 0,
"nft_ids": [
"string"
],
"quote_currency": "string",
"reserve_price": "string",
"root_id": "string",
"start_time": 0,
"status": "open",
"status_detail": "string",
"type": "fixed",
"user": "string"
}
]
}
{
"error": [],
"result": [
{
"auction_id": "AJ4ZEP-7BC2W-AAK2P6",
"quote_currency": "SOL",
"user": "utility-oyster-kiwi",
"type": "fixed",
"bids": [],
"status": "open",
"start_time": 0,
"expiry_time": 0,
"extension_time": 0,
"reserve_price": "0.0000000000",
"buyout_price": "6.9500000000",
"nft_ids": [
"NTN63WS-PBAV3-FQDQDG"
],
"root_id": "",
"status_detail": "OPEN"
}
]
}