Package de.chojo.universalis.rest.routes.api

Interface MarketBoardRequest

All Superinterfaces:
BlankMarketBoardRequest, DataCenterScope<RegionMarketBoardRequest>, ItemScope<MarketBoardRequest>, RegionMarketBoardRequest, RegionScope<RegionMarketBoardRequest>, Request<MarketBoardResponse>, WorldScope<RegionMarketBoardRequest>
All Known Implementing Classes:
MarketBoardRequestImpl
public interface MarketBoardRequest extends Request<MarketBoardResponse>, RegionMarketBoardRequest
Base implementation for a MarketBoardRequestImpl

  • Method Details

    • listingsLimit

      @CheckReturnValue MarketBoardRequest listingsLimit(int limit)
      The number of entries to return. By default, all listings will be returned.
      Parameters:
      limit - limit
      Returns:
      request

    • historyLimit

      @CheckReturnValue MarketBoardRequest historyLimit(int limit)
      The number of entries to return. By default, a maximum of 5 entries will be returned.
      Parameters:
      limit - limit
      Returns:
      request

    • noGst

      @CheckReturnValue @Deprecated(forRemoval=true) MarketBoardRequest noGst()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tax is no longer included in pricing. Tax is provided via Listing.tax()
      If the result should not have Gil sales tax (GST) factored in. GST is applied to all consumer purchases in-game, and is separate from the retainer city tax that impacts what sellers receive. By default, GST is factored in.
      Returns:
      request

    • noGst

      @CheckReturnValue @Deprecated(forRemoval=true) MarketBoardRequest noGst(boolean noGst)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tax is no longer included in pricing. Tax is provided via Listing.tax()
      If the result should not have Gil sales tax (GST) factored in. GST is applied to all consumer purchases in-game, and is separate from the retainer city tax that impacts what sellers receive. By default, GST is factored in.
      Parameters:
      noGst - set to true to disable GST
      Returns:
      request

    • highQuality

      @CheckReturnValue default MarketBoardRequest highQuality()
      Filter for HQ listings and entries. By default, both HQ and NQ listings and entries will be returned.
      Returns:
      request

    • normalQuality

      @CheckReturnValue default MarketBoardRequest normalQuality()
      Filter for NQ listings and entries. By default, both HQ and NQ listings and entries will be returned.
      Returns:
      request

    • highQuality

      @CheckReturnValue MarketBoardRequest highQuality(boolean highQuality)
      Filter for HQ listings and entries. By default, both HQ and NQ listings and entries will be returned.
      Parameters:
      highQuality - set to true to only receive hq listings
      Returns:
      request

    • historyTime

      @CheckReturnValue MarketBoardRequest historyTime(Duration duration)
      The amount of time before now to take entries within the history data returned by MarketBoardResponse.recentHistory().
      Parameters:
      duration - duration
      Returns:
      request

    • statsTime

      @CheckReturnValue MarketBoardRequest statsTime(Duration duration)
      The amount of time before now to calculate stats over. By default, this is 7 days.

      Affects MarketBoardResponse.saleVelocity()

      Parameters:
      duration - duration
      Returns:
      request