Auctions

Get currently active auction

get
Responses
200
Successful response
application/json
get
GET /api/v2/auctions/active HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "id": 1,
  "creatorAddress": "text",
  "nftContract": "text",
  "nftTokenId": 1,
  "tokenURI": "text",
  "startPrice": "text",
  "reservePrice": "text",
  "duration": 1,
  "paymentRecipient": "text",
  "paymentToken": "text",
  "startTime": "text",
  "status": "DISABLED",
  "buyerAddress": "text",
  "pricePaid": "text",
  "soldTime": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

Get auction details by ID

get
Path parameters
auctionIdintegerRequired
Responses
200
Successful response
application/json
get
GET /api/v2/auctions/{auctionId} HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "id": 1,
  "creatorAddress": "text",
  "nftContract": "text",
  "nftTokenId": 1,
  "tokenURI": "text",
  "startPrice": "text",
  "reservePrice": "text",
  "duration": 1,
  "paymentRecipient": "text",
  "paymentToken": "text",
  "startTime": "text",
  "status": "DISABLED",
  "buyerAddress": "text",
  "pricePaid": "text",
  "soldTime": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

List auctions with optional filters and sorting

get
Query parameters
limitinteger · max: 50OptionalDefault: 50
offsetnumberOptionalDefault: 0
statusstring · enumOptionalPossible values:
nftContractstringOptional
nftTokenIdintegerOptional
orderBystring · enumOptionalDefault: idPossible values:
orderDirectionstring · enumOptionalDefault: descPossible values:
Responses
200
Successful response
application/json
get
GET /api/v2/auctions HTTP/1.1
Host: api.ethos.network
Accept: */*
{
  "values": [
    {
      "id": 1,
      "creatorAddress": "text",
      "nftContract": "text",
      "nftTokenId": 1,
      "tokenURI": "text",
      "startPrice": "text",
      "reservePrice": "text",
      "duration": 1,
      "paymentRecipient": "text",
      "paymentToken": "text",
      "startTime": "text",
      "status": "DISABLED",
      "buyerAddress": "text",
      "pricePaid": "text",
      "soldTime": "text",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}