Skip to main content
ReadCommitmentData 
curl --request POST \
  --url https://api.echo.xyz/sales.ReadCommitmentData \
  --header 'Content-Type: application/json' \
  --data '
{
  "SaleUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "Commitments": [
    {
      "Amounts": [
        {
          "Amount": "<string>",
          "TokenAddress": "<string>",
          "Wallet": "<string>"
        }
      ],
      "CommitmentID": "<string>",
      "CreatedAt": "2023-11-07T05:31:56Z",
      "ExtraDataParsed": {},
      "ExtraDataRaw": "aSDinaTvuI8gbWludGxpZnk=",
      "PriceDenominator": "<string>",
      "PriceNumerator": "<string>",
      "SaleSpecificEntityID": "<string>",
      "PriceMicroUSD": "<string>"
    }
  ],
  "PaymentTokenDecimals": 1,
  "TotalCommitmentAmount": "<string>",
  "UniqueCommitmentCount": 1,
  "ClearingPriceDenominator": "<string>",
  "ClearingPriceMicroUSD": "<string>",
  "ClearingPriceNumerator": "<string>",
  "OfferedTokenDecimals": 1
}

Body

application/json
​
SaleUUID
string<uuid>
required

Response

Success response

​
Commitments
Commitment · object[]
required

A list of commitments.

​
PaymentTokenDecimals
integer<int64>
required

The number of decimals of the payment token. For example, USDC has 6 decimals. If your sale supports multiple payment tokens with different decimals, this will return the "normalized payment token decimals" configured for the sale.

Required range: x >= 0
​
TotalCommitmentAmount
string
required

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

​
UniqueCommitmentCount
integer<int64>
required

The number of unique commitment count.

Required range: x >= 0
​
ClearingPriceDenominator
string

Set if the sale is using an auction pricing strategy. The current clearing price _denominator_ as a number string.

​
ClearingPriceMicroUSD
string

Set if the sale is using an auction pricing strategy and 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 ClearingPriceNumerator and ClearingPriceDenominator should be used as the machine-readable value.

​
ClearingPriceNumerator
string

Set if the sale is using an auction pricing strategy. The current clearing price _numerator_ as a number string. You can divide this by the ClearingPriceDenominator 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>

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

Required range: x >= 0