Class LivePaperAccount

java.lang.Object
com.qtsurfer.api.client.model.LivePaperAccount

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class LivePaperAccount extends Object
One simulated account — one per quote currency the run trades.
  • Field Details

  • Constructor Details

    • LivePaperAccount

      public LivePaperAccount()
  • Method Details

    • currency

      public LivePaperAccount currency(@Nonnull String currency)
    • getCurrency

      @Nonnull public String getCurrency()
      The account's quote currency; every amount below is in it.
      Returns:
      currency
    • setCurrency

      public void setCurrency(@Nonnull String currency)
    • initialFunding

      public LivePaperAccount initialFunding(@Nonnull Double initialFunding)
    • getInitialFunding

      @Nonnull public Double getInitialFunding()
      Get initialFunding
      Returns:
      initialFunding
    • setInitialFunding

      public void setInitialFunding(@Nonnull Double initialFunding)
    • equity

      public LivePaperAccount equity(@Nonnull Double equity)
    • getEquity

      @Nonnull public Double getEquity()
      Latest recorded equity — see `equityKind`.
      Returns:
      equity
    • setEquity

      public void setEquity(@Nonnull Double equity)
    • equityAtMs

      public LivePaperAccount equityAtMs(@Nullable Long equityAtMs)
    • getEquityAtMs

      @Nullable public Long getEquityAtMs()
      Market time of that value. Absent while the account holds its starting capital.
      Returns:
      equityAtMs
    • setEquityAtMs

      public void setEquityAtMs(@Nullable Long equityAtMs)
    • equityKind

      public LivePaperAccount equityKind(@Nullable LivePaperAccount.EquityKindEnum equityKind)
    • getEquityKind

      @Nullable public LivePaperAccount.EquityKindEnum getEquityKind()
      `equity` at a closed trade, `mark` at a periodic mark-to-market (includes open positions at market price).
      Returns:
      equityKind
    • setEquityKind

      public void setEquityKind(@Nullable LivePaperAccount.EquityKindEnum equityKind)
    • realisedPnl

      public LivePaperAccount realisedPnl(@Nonnull Double realisedPnl)
    • getRealisedPnl

      @Nonnull public Double getRealisedPnl()
      Sum of the PnL of the closed trades.
      Returns:
      realisedPnl
    • setRealisedPnl

      public void setRealisedPnl(@Nonnull Double realisedPnl)
    • trades

      public LivePaperAccount trades(@Nonnull Long trades)
    • getTrades

      @Nonnull public Long getTrades()
      Closed trades.
      Returns:
      trades
    • setTrades

      public void setTrades(@Nonnull Long trades)
    • gaps

      public LivePaperAccount gaps(@Nonnull Integer gaps)
    • getGaps

      @Nonnull public Integer getGaps()
      Times open positions were lost because the run was restarted with them open.
      Returns:
      gaps
    • setGaps

      public void setGaps(@Nonnull Integer gaps)
    • openPositions

      public LivePaperAccount openPositions(@Nonnull List<LivePaperPosition> openPositions)
    • addOpenPositionsItem

      public LivePaperAccount addOpenPositionsItem(LivePaperPosition openPositionsItem)
    • getOpenPositions

      @Nonnull public List<LivePaperPosition> getOpenPositions()
      Get openPositions
      Returns:
      openPositions
    • setOpenPositions

      public void setOpenPositions(@Nonnull List<LivePaperPosition> openPositions)
    • kpi

      public LivePaperAccount kpi(@Nullable LivePaperKpi kpi)
    • getKpi

      @Nullable public LivePaperKpi getKpi()
      Get kpi
      Returns:
      kpi
    • setKpi

      public void setKpi(@Nullable LivePaperKpi kpi)
    • equals

      public boolean equals(Object o)
      Return true if this LivePaperAccount 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