Package com.qtsurfer.api.client.model

Class PoolDetail

java.lang.Object
com.qtsurfer.api.client.model.PoolDetail
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class PoolDetail extends Object
A pool of a decentralized exchange that a live run can read. The listing is a place to start, not the whole market: a live run can read any pool of the protocol, listed or not.

  • Field Details

  • Constructor Details

    • PoolDetail

      public PoolDetail()

  • Method Details

    • id

      public PoolDetail id(@Nonnull String id)

    • getId

      @Nonnull public String getId()
      The pool's address, in lower case. It is the value to put in `instruments` of a live run's source.
      Returns:
      id

    • setId

      public void setId(@Nonnull String id)

    • symbol

      public PoolDetail symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      The pair written `BASE/QUOTE`, the way the signals of a run on this pool name it (`instrument`)
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • base

      public PoolDetail base(@Nonnull String base)

    • getBase

      @Nonnull public String getBase()
      Symbol of the base token
      Returns:
      base

    • setBase

      public void setBase(@Nonnull String base)

    • quote

      public PoolDetail quote(@Nonnull String quote)

    • getQuote

      @Nonnull public String getQuote()
      Symbol of the quote token
      Returns:
      quote

    • setQuote

      public void setQuote(@Nonnull String quote)

    • baseAddress

      public PoolDetail baseAddress(@Nonnull String baseAddress)

    • getBaseAddress

      @Nonnull public String getBaseAddress()
      Address of the base token, in lower case
      Returns:
      baseAddress

    • setBaseAddress

      public void setBaseAddress(@Nonnull String baseAddress)

    • quoteAddress

      public PoolDetail quoteAddress(@Nonnull String quoteAddress)

    • getQuoteAddress

      @Nonnull public String getQuoteAddress()
      Address of the quote token, in lower case
      Returns:
      quoteAddress

    • setQuoteAddress

      public void setQuoteAddress(@Nonnull String quoteAddress)

    • feePercent

      public PoolDetail feePercent(@Nonnull BigDecimal feePercent)

    • getFeePercent

      @Nonnull public BigDecimal getFeePercent()
      The pool's fee tier, in percent (`0.05` is a 0.05 % fee). A protocol can have several pools of the same pair, one per fee tier.
      Returns:
      feePercent

    • setFeePercent

      public void setFeePercent(@Nonnull BigDecimal feePercent)

    • lastPrice

      public PoolDetail lastPrice(@Nullable Double lastPrice)

    • getLastPrice

      @Nullable public Double getLastPrice()
      The price of one base token in the quote token, as the signals of a run on this pool name the pair. It is as of `meta.updatedAt`, so up to one hour old. Absent when there is no price for the pool.
      Returns:
      lastPrice

    • setLastPrice

      public void setLastPrice(@Nullable Double lastPrice)

    • volume24h

      public PoolDetail volume24h(@Nullable Double volume24h)

    • getVolume24h

      @Nullable public Double getVolume24h()
      What traded in the pool over the last 24 hours, in the quote token, the same meaning as `volume24h` of an instrument of a centralized exchange. Absent when the quote token has no dollar price to convert from.
      Returns:
      volume24h

    • setVolume24h

      public void setVolume24h(@Nullable Double volume24h)

    • tvlUsd

      public PoolDetail tvlUsd(@Nonnull BigDecimal tvlUsd)

    • getTvlUsd

      @Nonnull public BigDecimal getTvlUsd()
      The liquidity held by the pool, in US dollars
      Returns:
      tvlUsd

    • setTvlUsd

      public void setTvlUsd(@Nonnull BigDecimal tvlUsd)

    • volume24hUsd

      public PoolDetail volume24hUsd(@Nonnull BigDecimal volume24hUsd)

    • getVolume24hUsd

      @Nonnull public BigDecimal getVolume24hUsd()
      What traded in the pool over the last 24 hours, in US dollars
      Returns:
      volume24hUsd

    • setVolume24hUsd

      public void setVolume24hUsd(@Nonnull BigDecimal volume24hUsd)

    • createdAt

      public PoolDetail createdAt(@Nullable OffsetDateTime createdAt)

    • getCreatedAt

      @Nullable public OffsetDateTime getCreatedAt()
      When the pool was created. Absent when it is not known
      Returns:
      createdAt

    • setCreatedAt

      public void setCreatedAt(@Nullable OffsetDateTime createdAt)

    • equals

      public boolean equals(Object o)
      Return true if this PoolDetail object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string