Package org.xrpl.xrpl4j.model.client.oracle

Interface GetAggregatePriceRequestParams

All Superinterfaces:
XrplRequestParams
All Known Implementing Classes:
ImmutableGetAggregatePriceRequestParams
@Beta @Immutable public interface GetAggregatePriceRequestParams extends XrplRequestParams
Request parameters for the get_aggregate_price RPC method.

  • Method Details

    • builder

      static ImmutableGetAggregatePriceRequestParams.Builder builder()
      Construct a GetAggregatePriceRequestParams builder.
      Returns:
      An ImmutableGetAggregatePriceRequestParams.Builder.

    • ledgerSpecifier

      LedgerSpecifier ledgerSpecifier()
      Specifies the ledger version to request. A ledger version can be specified by ledger hash, numerical ledger index, or a shortcut value.
      Returns:
      A LedgerSpecifier specifying the ledger version to request.

    • baseAsset

      String baseAsset()
      The currency code of the asset to be priced.
      Returns:
      A String.

    • quoteAsset

      String quoteAsset()
      The currency code of the asset to quote the price of the base asset.
      Returns:
      A String.

    • trim

      Optional<com.google.common.primitives.UnsignedInteger> trim()
      The percentage of outliers to trim. Valid trim range is 1-25. If included, the API returns statistics for the trimmed mean.
      Returns:
      An Optional UnsignedInteger.

    • trimThreshold

      Optional<com.google.common.primitives.UnsignedInteger> trimThreshold()
      Defines a time range in seconds for filtering out older price data. Default value is 0, which doesn't filter any data.
      Returns:
      An Optional UnsignedInteger.

    • oracles

      List<OracleLedgerEntryParams> oracles()
      A list of oracle identifiers.
      Returns:
      A List of OracleLedgerEntryParams.