Skip to main content
POST
/
externalsales.ReadBidData
ReadBidData 
curl --request POST \
  --url https://api.echo.xyz/externalsales.ReadBidData \
  --header 'Content-Type: application/json' \
  --data '
{
  "SaleUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "Bids": [
    {
      "Address": [
        127
      ],
      "Amount": "<string>",
      "CreatedAt": "2023-11-07T05:31:56Z",
      "ExtraDataParsed": {},
      "ExtraDataRaw": "aSDinaTvuI8gbWludGxpZnk=",
      "PriceDenominator": "<string>",
      "PriceNumerator": "<string>",
      "MaximumPriceWTPMicros": 1,
      "PriceMicroUSD": "<string>"
    }
  ],
  "CurrentClearingPriceDenominator": "<string>",
  "CurrentClearingPriceNumerator": "<string>",
  "OfferedTokenDecimals": 1,
  "PaymentTokenDecimals": 1,
  "TotalBidAmount": "<string>",
  "UniqueBidderCount": 1,
  "CurrentClearingPriceMicroUSD": "<string>"
}

Body

application/json
​
SaleUUID
string<uuid>
required

Response

Success response

​
Bids
Bid · object[]
required

A list of bids.

​
CurrentClearingPriceDenominator
string
required

The current clearing price _denominator_ as a number string.

​
CurrentClearingPriceNumerator
string
required

The current clearing price _numerator_ as a number string. You can divide this by the CurrentClearingPriceDenominator to get the current price, but you might lose precision. The clearing price is in smallest units of the payment token per smallest unit of the offered token.

​
OfferedTokenDecimals
integer<int64>
required

The number of decimals of the offered token. For example, a token with 18 decimals has 18 decimal places.

Required range: x >= 0
​
PaymentTokenDecimals
integer<int64>
required

The number of decimals of the payment token. For example, USDC has 6 decimals.

Required range: x >= 0
​
TotalBidAmount
string
required

The total bid amount in the smallest payment token units as a number string.

​
UniqueBidderCount
integer<int64>
required

The number of unique bidders.

Required range: x >= 0
​
CurrentClearingPriceMicroUSD
string

Set if the payment token is a USD stablecoin and the offered token decimals are configured. It contains the current clearing price in micro-USD (1 USD = 1,000,000 micro-USD) for one human-readable offered token (1 human-readable token = 10^OfferedTokenDecimals smallest units). Warning: this could lose precision, so CurrentClearingPriceNumerator and CurrentClearingPriceDenominator should be used as the machine-readable value.