dns

Get DNS Auctions by Bidder

Returns DNS auctions where the address is the current leading bidder. Use bidding for open auctions and won for ended but unclaimed auctions. Claimed auctions are no longer returned. Ordering for bidding and all can change between pages as auctions update; prefer larger limits. Set include_nft_items to include NFT details. Available NFT and collection metadata is returned separately.

get/api/v3/dns/activeAuctions

Request

  • Base URL: https://toncenter.com (the document declares no server; this is the origin it was published from)
  • URL: https://toncenter.com/api/v3/dns/activeAuctions
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in query parameter api_key

Query parameters

bidderstring required

Address of the current leading bidder.

state'all' | 'won' | 'bidding'

Filter by auction state.

include_nft_itemsboolean

Include NFT item details.

afterstring

Opaque pagination cursor from next_cursor of the previous page. Returns rows strictly after it; preferred over offset.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip. Not allowed together with after.

Response

OK

address_bookAddressBook
metadataMetadata
next_cursorstring

Example response

{
  "auctions": [
    {
      "auction_end_time": "0",
      "last_fill_up_time": "0",
      "nft_item": {
        "collection": {
          "last_transaction_lt": "0"
        },
        "last_transaction_lt": "0"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.