auction-controller

getAuctionById

Returns the auction by id

Request
path Parameters
id
required
string (AuctionId)

Auction Id, has format ${blockchain}:${id}

Example: ${blockchain}:${id}
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/auctions/{id}
Response samples
application/json
{
  • "id": "${blockchain}:${id}",
  • "contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
  • "type": "RARIBLE_AUCTION_V1",
  • "seller": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
  • "sell": {
    },
  • "buy": {
    },
  • "endTime": "2019-08-24T14:15:22Z",
  • "minimalStep": 123456.789,
  • "minimalPrice": 123456.789,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdateAt": "2019-08-24T14:15:22Z",
  • "buyPrice": 123456.789,
  • "buyPriceUsd": 123456.789,
  • "pending": [
    ],
  • "status": "ACTIVE",
  • "ongoing": true,
  • "hash": "string",
  • "auctionId": 123456,
  • "lastBid": {
    },
  • "data": {
    }
}

getAuctionsAll

Returns all auctions by specified parameters

Request
query Parameters
blockchains
Array of strings (Blockchain)

Names of the blockchain networks. If no one specified, data from all blockchains will be returned

Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
sort
string (AuctionSort)

Sorting by target criteria

Enum: "LAST_UPDATE_ASC" "LAST_UPDATE_DESC" "BUY_PRICE_ASC"
status
Array of strings (AuctionStatus)

The auction statuses

Items Enum: "ACTIVE" "CANCELLED" "FINISHED"
origin
string (UnionAddress)

Address of the consumer to receive the commission for auction

Example: origin=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
platform
string (Platform)

The platform where the auction was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
continuation
string

Continuation token from the previous response

size
integer <int32> >= 1

The number of auctions to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/auctions/all
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "auctions": [ ]
}

getAuctionsBySeller

Returns all auctions by seller

Request
query Parameters
blockchains
Array of strings (Blockchain)
Items Enum: "ETHEREUM" "POLYGON" "FLOW" "TEZOS" "SOLANA" "IMMUTABLEX"
seller
required
string (ContractAddress)

The seller of the auction

Example: seller=ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
status
Array of strings (AuctionStatus)

The auction statuses

Items Enum: "ACTIVE" "CANCELLED" "FINISHED"
origin
string (UnionAddress)

Address of the consumer to receive the commission for auction

Example: origin=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
platform
string (Platform)

The platform where the auction was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
continuation
string

Continuation token from the previous response

size
integer <int32> >= 1

The number of items to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/auctions/bySeller
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "auctions": [ ]
}

getAuctionsByItem

Returns all auctions by item

Request
query Parameters
itemId
required
string (ItemId)

Item Id, has format ${blockchain}:${token}:${tokenId}

Example: itemId=ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
seller
string (UnionAddress)

The seller of the auction

Example: seller=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
sort
string (AuctionSort)

Sorting by target criteria

Enum: "LAST_UPDATE_ASC" "LAST_UPDATE_DESC" "BUY_PRICE_ASC"
origin
string (UnionAddress)

Address of the consumer to receive the commission for auction

Example: origin=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
status
Array of strings (AuctionStatus)

The auction statuses

Items Enum: "ACTIVE" "CANCELLED" "FINISHED"
platform
string (Platform)

The platform where the auction was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
continuation
string

Continuation token from the previous response

size
integer <int32> >= 1

The number of items to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/auctions/byItem
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "auctions": [ ]
}

getAuctionsByCollection

Returns all auctions by collection

Request
query Parameters
contract
required
string (ContractAddress)

Address of the NFT collection

Example: contract=ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430
seller
string (UnionAddress)

The seller of the auction

Example: seller=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
origin
string (UnionAddress)

Address of the consumer to receive the commission for auction

Example: origin=ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb
status
Array of strings (AuctionStatus)

The auctions statuses

Items Enum: "ACTIVE" "CANCELLED" "FINISHED"
platform
string (Platform)

The platform where the auction was created

Enum: "RARIBLE" "OPEN_SEA" "CRYPTO_PUNKS" "IMMUTABLEX" "HEN" "OBJKT" "VERSUM" "TEIA" "OTHER" "X2Y2" "LOOKSRARE" "SUDOSWAP" "FXHASH"
continuation
string

Continuation token from the previous response

size
integer <int32> >= 1

The number of items to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/auctions/byCollection
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "auctions": [ ]
}

getAuctionBidsById

Returns all auction bids by auction id

Request
path Parameters
id
required
string (AuctionId)

Auction Id, has format ${blockchain}:${id}

Example: ${blockchain}:${id}
query Parameters
continuation
string

Continuation token from the previous response

size
integer <int32> >= 1

The number of bids to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/auctions/{id}/bids
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "bids": [ ]
}