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

auction_id string

Optional auction id filter

end_time uint32

Default value: 4294967295

unix time (in seconds) defining the latest auction start time

nft_id string[]

Optional identifier of the NFT

offset uint32
pos uint32

Paging offset

start_time uint32

Default value: 0

unix time (in seconds) defining the earliest auction start time

status stringrequired

Possible values: [open, closed, expired]

Auction status filter

Responses

200

Response

application/json

Schema

Schema

error string[]required
result object[]nullable
Array [
auction_id stringrequired
Auction id
bids object[]required
Array of bids
Array [
amount object required
An amount, either as a string, and integer, or a decimal value
oneOf
MOD1
string
MOD2
integer
MOD3
number
auction_id stringnullable
currency stringrequired
id stringrequired
lock_time uint64required
nft_ids string[]required
social_id stringrequired
status stringrequired
Possible values: [Open, Cancelled, Filled, PartialFilled, Superceded]
status_detail stringrequired
time uint64required
type stringrequired
Possible values: [Sell, Buy, Offer]
usd_equivalence object required
An amount, either as a string, and integer, or a decimal value
oneOf
MOD1
string
MOD2
integer
MOD3
number
volume uint64required
]
buyout_price object
Optional buyout price (price at which an item can be immediately purchased)
oneOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
object
expiry_time uint32nullable
unix time (in seconds) defining the expiry time of the auction
extension_time uint32nullable
Time in seconds defining the extension time
nft_ids string[]required
Array of NFT identifiers
quote_currency stringrequired
Currency for sale
reserve_price object
Optional minimum price at which the item can be sold
oneOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
object
root_id stringrequired
If auction was created to match an existing offer, offer id will be the auction's root id
start_time uint32nullable
unix time (in seconds) defining the start time of the auction
status stringrequired
Possible values: [open, closed, expired]
Auction status
status_detail stringrequired
Auction status detail
type stringrequired
Possible values: [fixed, ascending]
Auction type
user stringrequired
Social id of the selling user
]

Example (from schema)

{
  "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"
    }
  ]
}

Example

{
  "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"
    }
  ]
}

Loading...