Auctions

Get currently active auction

get

Responses

200

Successful response

application/json

idnumberRequired

creatorAddressstringRequired

nftContractstringRequired

nftTokenIdnumberRequired

tokenURIstring · nullableRequired

startPriceinteger · int64Required

reservePriceinteger · int64Required

durationnumberRequired

paymentRecipientstringRequired

paymentTokenstringRequired

startTimestringRequired

statusstring · enumRequiredPossible values:

buyerAddressstring · nullableRequired

pricePaidinteger · int64 · nullableRequired

soldTimestring · nullableRequired

createdAtstringRequired

updatedAtstringRequired

prevIdnumber · nullableOptional

nextIdnumber · nullableOptional

500

Internal server error

application/json

get

/auctions/active

HTTPcURLJavaScriptPython

GET /api/v2/auctions/active HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "creatorAddress": "text",
  "nftContract": "text",
  "nftTokenId": 1,
  "tokenURI": "text",
  "startPrice": 1,
  "reservePrice": 1,
  "duration": 1,
  "paymentRecipient": "text",
  "paymentToken": "text",
  "startTime": "text",
  "status": "DISABLED",
  "buyerAddress": "text",
  "pricePaid": 1,
  "soldTime": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "prevId": 1,
  "nextId": 1
}

Get auction details by ID

get

Path parameters

auctionIdintegerRequired

Responses

200

Successful response

application/json

idnumberRequired

creatorAddressstringRequired

nftContractstringRequired

nftTokenIdnumberRequired

tokenURIstring · nullableRequired

startPriceinteger · int64Required

reservePriceinteger · int64Required

durationnumberRequired

paymentRecipientstringRequired

paymentTokenstringRequired

startTimestringRequired

statusstring · enumRequiredPossible values:

buyerAddressstring · nullableRequired

pricePaidinteger · int64 · nullableRequired

soldTimestring · nullableRequired

createdAtstringRequired

updatedAtstringRequired

prevIdnumber · nullableOptional

nextIdnumber · nullableOptional

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/auctions/{auctionId}

HTTPcURLJavaScriptPython

GET /api/v2/auctions/{auctionId} HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "id": 1,
  "creatorAddress": "text",
  "nftContract": "text",
  "nftTokenId": 1,
  "tokenURI": "text",
  "startPrice": 1,
  "reservePrice": 1,
  "duration": 1,
  "paymentRecipient": "text",
  "paymentToken": "text",
  "startTime": "text",
  "status": "DISABLED",
  "buyerAddress": "text",
  "pricePaid": 1,
  "soldTime": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "prevId": 1,
  "nextId": 1
}

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

totalnumberRequired

limitnumberRequired

offsetnumberRequired

400

Invalid input data

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/auctions

HTTPcURLJavaScriptPython

GET /api/v2/auctions HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "id": 1,
      "creatorAddress": "text",
      "nftContract": "text",
      "nftTokenId": 1,
      "tokenURI": "text",
      "startPrice": 1,
      "reservePrice": 1,
      "duration": 1,
      "paymentRecipient": "text",
      "paymentToken": "text",
      "startTime": "text",
      "status": "DISABLED",
      "buyerAddress": "text",
      "pricePaid": 1,
      "soldTime": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "prevId": 1,
      "nextId": 1
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}