Skip to main content

Create Auction

POST 
/private/NftCreateAuction

Create NFT auction. Creates a new auction for a user owned NFT in Kraken's custody. This method accepts the auction details. In the response, the method returns the identifier of the auction.

Request​

Body

required
    auction_currency stringrequired

    Auction currency code

    auction_params objectrequired

    Auction parameters

    allow_bids booleannullable

    Whether users can make offers with different prices than ask

    ask_price object

    Only for Fixed price auction type Auction price set by the seller

    oneOf

    string

    expire_time uint32nullable

    Optional unix time (in seconds) defining the expiry time of the auction

    extension_times uint32[]nullable

    Only for Ascending auction type Optional array of seconds defining the extension times

    increment uint32nullable

    Only for Descending and Ascending auction types Minimum increment by which consecutive bids must differ

    min_price object

    Only for Descending and Ascending auction types Minimum auction price set by the seller

    oneOf

    string

    reserve_price object

    Only for Ascending auction type Optional minimum price at which the item can be sold

    oneOf

    string

    start_price object

    Only for Descending auction type Start auction price set by the seller

    oneOf

    string

    vickrey booleannullable

    An optional boolean indicating whether the auction is a Vickrey auction In a Vickrey auction, the highest bidder wins but pays the price bid by the second-highest bidder

    auction_type stringrequired

    Possible values: [ascending, descending, fixed]

    Auction type

    nft_id string[]required

    Array of NFT ids to put in auction

    nonce int64required

    Nonce used in construction of API-Sign header

    offer_id stringnullable

    Optional offer id linked to the auction

    otp stringnullable
    pay_creator_fee booleannullable

    Whether a user wants to pay a creator fee or not

    start_time uint32nullable

    Optional unix time (in seconds) defining the start time of the auction

Responses​

Response

Schema
    error string[]required
    result objectnullable
    auction_id stringrequired

    Auction id

Loading...