Package com.qtsurfer.api.client.model

Class LiveSource

java.lang.Object
com.qtsurfer.api.client.model.LiveSource
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.24.0") public class LiveSource extends Object
One market feed a live run consumes. Exactly one entry per run today.

  • Field Details

  • Constructor Details

    • LiveSource

      public LiveSource()

  • Method Details

    • venueType

      public LiveSource venueType(@Nonnull LiveSource.VenueTypeEnum venueType)

    • getVenueType

      @Nonnull public LiveSource.VenueTypeEnum getVenueType()
      Venue category. `cex` is a centralized exchange and `dex` is one pool on a decentralized exchange, which takes its own `exchange`, `segment`, `type` and `instruments` (see \"Sources\" in the Live execution guide). `cx` and `dx`, the spellings used before, are still read as `cex` and `dex`; the run always reports the new ones.
      Returns:
      venueType

    • setVenueType

      public void setVenueType(@Nonnull LiveSource.VenueTypeEnum venueType)

    • exchange

      public LiveSource exchange(@Nonnull String exchange)

    • getExchange

      @Nonnull public String getExchange()
      The exchange id, as `GET /exchanges` lists it. For a `dex` source, the chain the pool is on; `robinhood` is the only one today.
      Returns:
      exchange

    • setExchange

      public void setExchange(@Nonnull String exchange)

    • segment

      public LiveSource segment(@Nonnull String segment)

    • getSegment

      @Nonnull public String getSegment()
      The segment, as `GET /exchanges` lists it for that exchange, among its `liveSegments` (a segment with no live data is refused with `400`). For a `cex` source, the market segment (`spot` today); for a `dex` source, the protocol of the pool, `uniswap-v3` the only one today.
      Returns:
      segment

    • setSegment

      public void setSegment(@Nonnull String segment)

    • type

      public LiveSource type(@Nonnull LiveSource.TypeEnum type)

    • getType

      @Nonnull public LiveSource.TypeEnum getType()
      Both `ticker` and `kline` connect to the lightest (fastest) cadence available for the exchange — today, 1 tick/second on every supported exchange. Choosing a specific cadence is not offered yet. A `dex` source supports only `kline`: one candle per second of the pool's trades.
      Returns:
      type

    • setType

      public void setType(@Nonnull LiveSource.TypeEnum type)

    • instruments

      public LiveSource instruments(@Nonnull List<String> instruments)

    • addInstrumentsItem

      public LiveSource addInstrumentsItem(String instrumentsItem)

    • getInstruments

      @Nonnull public List<String> getInstruments()
      The instruments the run reads. For a run started with a list, that list as sent; for one started without `instruments`, or with `[\"*\"]`, what the start resolved: the list of pairs the compilation of the strategy records as the instruments it accepts, when it records one, or `[\"*\"]` for every instrument the exchange/segment offers (tier-gated). An entry is written `BASE/QUOTE` and either side can be `*` to mean any, such as any base paired with USDT. Symbols are not case-sensitive and spaces around them are ignored, so `btc/usdt` and `BTC/USDT` are the same instrument. A `dex` source holds exactly one entry, the address of its pool.
      Returns:
      instruments

    • setInstruments

      public void setInstruments(@Nonnull List<String> instruments)

    • equals

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