Auctions
List of NFT Exchange Auction Endpoints.
All Auctions
/auctions
GET
https://explorer.protokol.sh/api/nft/exchange/auctions
Returns all active auctions that have not been canceled or closed with succesfull NFTAcceptTrade transaction.
Query Parameters
Name | Type | Description |
---|---|---|
page | integer | The number of the page that will be returned |
limit | integer | The number of resources per page |
orderBy | string | Order by specific parameter (asc or desc) Example: orderBy=id:asc |
transform | boolean | Returns modified or raw data |
expired | boolean | If true include expired (not canceled or accapted) auctions |
Examples
Auction By Id
/auctions/:id
GET
https://explorer.protokol.sh/api/nft/exchange/auctions/:id
Returns auction by id
Path Parameters
Name | Type | Description |
---|---|---|
id | string | The identifier of the auction to be retrieved |
Query Parameters
Name | Type | Description |
---|---|---|
transform | boolean | Returns modified or raw data |
Examples
Auctions Wallet
/auctions/:id/wallets
GET
https://explorer.protokol.sh/api/nft/exchange/auctions/:id/wallets
Returns wallet owning the auction
Path Parameters
Name | Type | Description |
---|---|---|
id | string | The identifier of the auction |
Examples
Search Auctions
/auctions/search
POST
https://explorer.protokol.sh/api/nft/exchange/auctions/search
Search auctions
Query Parameters
Name | Type | Description |
---|---|---|
page | integer | The number of the page that will be returned |
limit | integer | The number of resources per page |
orderBy | string | Order by specific parameter (asc or desc) Example: orderBy=id:asc |
transform | boolean | Returns modified or raw data |
onlyActive | boolean | Only returns not canceled or not closed auctions |
expired | boolean | Extends onlyActive, if true include expired auctions |
includeBids | boolean | If true includes auction bids |
canceledBids | boolean | Extends includeBids, if true include canceled bids |
Request Body
Name | Type | Description |
---|---|---|
senderPublicKey | string | Public key of a sender |
nftIds | array | Ids of nfts |
startAmount | string | Start amount of auctions |
expiration: { blockHeight} | object | Block height expiration |
Examples
Canceled Auctions
/auctions/canceled
GET
https://explorer.protokol.sh/api/nft/exchange/auctions/canceled
Returns canceled auctions transactions
Query Parameters
Name | Type | Description |
---|---|---|
page | integer | The number of the page that will be returned |
limit | integer | The number of resources per page |
orderBy | string | Order by specific parameter (asc or desc) Example: orderBy=id:asc |
transform | boolean | Returns modified or raw data |
Examples
Canceled Auctions By Id
/auctions/canceled/:id
GET
https://explorer.protokol.sh/api/nft/exchange/auctions/canceled/:id
Returns canceled auction transaction by id
Path Parameters
Name | Type | Description |
---|---|---|
id | string | The identifer of canceled auction to be retrieved |
Query Parameters
Name | Type | Description |
---|---|---|
transform | boolean | Returns modified or raw data |
Examples
Last updated