Package com.qtsurfer.api.client.model

Class LivePaperConfig

java.lang.Object
com.qtsurfer.api.client.model.LivePaperConfig
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class LivePaperConfig extends Object
Paper trading for this run: the same economics as a backtest's `baseConfig` (same fields, defaults and limits), plus `output`. An empty object takes every default. Each quote currency the run trades gets its own simulated account, opened with `initialFunding` in that currency; accounts are never added together. As returned on a run, the block is normalised: `feeRate` is resolved into `buyFeeRate`/`sellFeeRate` and defaults are filled in.

  • Field Details

  • Constructor Details

    • LivePaperConfig

      public LivePaperConfig()

  • Method Details

    • initialFunding

      public LivePaperConfig initialFunding(@Nullable Double initialFunding)

    • getInitialFunding

      @Nullable public Double getInitialFunding()
      Starting capital of each account, in that account's own quote currency. minimum: 0 maximum: 1000000000
      Returns:
      initialFunding

    • setInitialFunding

      public void setInitialFunding(@Nullable Double initialFunding)

    • feeRate

      public LivePaperConfig feeRate(@Nullable Double feeRate)

    • getFeeRate

      @Nullable public Double getFeeRate()
      Fee rate for both sides (0.001 = 0.1%). Accepted on start; returned resolved into the two fields below. minimum: 0
      Returns:
      feeRate

    • setFeeRate

      public void setFeeRate(@Nullable Double feeRate)

    • buyFeeRate

      public LivePaperConfig buyFeeRate(@Nullable Double buyFeeRate)

    • getBuyFeeRate

      @Nullable public Double getBuyFeeRate()
      Buy-side fee rate; overrides `feeRate`. minimum: 0
      Returns:
      buyFeeRate

    • setBuyFeeRate

      public void setBuyFeeRate(@Nullable Double buyFeeRate)

    • sellFeeRate

      public LivePaperConfig sellFeeRate(@Nullable Double sellFeeRate)

    • getSellFeeRate

      @Nullable public Double getSellFeeRate()
      Sell-side fee rate; overrides `feeRate`. minimum: 0
      Returns:
      sellFeeRate

    • setSellFeeRate

      public void setSellFeeRate(@Nullable Double sellFeeRate)

    • feeLeg

      public LivePaperConfig feeLeg(@Nullable LivePaperConfig.FeeLegEnum feeLeg)

    • getFeeLeg

      @Nullable public LivePaperConfig.FeeLegEnum getFeeLeg()
      Which asset fees are charged in. Case-insensitive on start.
      Returns:
      feeLeg

    • setFeeLeg

      public void setFeeLeg(@Nullable LivePaperConfig.FeeLegEnum feeLeg)

    • percentAmountToLock

      public LivePaperConfig percentAmountToLock(@Nullable Double percentAmountToLock)

    • getPercentAmountToLock

      @Nullable public Double getPercentAmountToLock()
      Share of the account's free balance each entry locks, in percent. Omitted, the strategy's own setting applies, and without one 10%. minimum: 0 maximum: 100
      Returns:
      percentAmountToLock

    • setPercentAmountToLock

      public void setPercentAmountToLock(@Nullable Double percentAmountToLock)

    • output

      public LivePaperConfig output(@Nullable LivePaperConfig.OutputEnum output)

    • getOutput

      @Nullable public LivePaperConfig.OutputEnum getOutput()
      `separate` keeps paper output out of the run's signals (read it with `GET /live/{runId}/paper`); `mix` also interleaves it into the run's signals as `type: paper`, right after the signal that caused it.
      Returns:
      output

    • setOutput

      public void setOutput(@Nullable LivePaperConfig.OutputEnum output)

    • equals

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