Interface UniversalisRest

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

UniversalisRestImpl

public interface UniversalisRest
extends AutoCloseable

Class to access the universalis api.

Method Summary

Modifier and Type	Method	Description
static UniversalisRestBuilder	builder()	Get a builder to configure the api.
void	close()	Shuts down the underlying HTTP client and executor.
DataCentersRequest	dataCenters()	Returns all data centers supported by the API.
static UniversalisRest	defaultApi()	Get a api with default settings.
Extra	extra()	Allows requests on route of the extra route
BlankHistoryRequest	history()	Retrieves the history data for the requested item and world or data center.
MarketableRequest	marketable()	Returns the set of marketable item IDs.
BlankMarketBoardRequest	marketBoard()	Retrieves the data currently shown on the market board for the requested item and world or data center.
BlankTaxRatesRequest	taxRates()	Retrieves the current tax rate data for the specified world.
WorldsRequest	worlds()	Returns the IDs and names of all worlds supported by the API.

Method Details

defaultApi

@CheckReturnValue
static UniversalisRest defaultApi()

Get a api with default settings.

Returns:

api instance

builder

@CheckReturnValue
static UniversalisRestBuilder builder()

Get a builder to configure the api.

Returns:

builder

marketBoard

@CheckReturnValue
BlankMarketBoardRequest marketBoard()

Retrieves the data currently shown on the market board for the requested item and world or data center.

Returns:

request builder

worlds

@CheckReturnValue
WorldsRequest worlds()

Returns the IDs and names of all worlds supported by the API.

Returns:

request builder

dataCenters

@CheckReturnValue
DataCentersRequest dataCenters()

Returns all data centers supported by the API.

Returns:

request builder

history

@CheckReturnValue
BlankHistoryRequest history()

Retrieves the history data for the requested item and world or data center.

Returns:

request builder

taxRates

@CheckReturnValue
BlankTaxRatesRequest taxRates()

Retrieves the current tax rate data for the specified world. This data is provided by the Retainer Vocate in each major city.

Returns:

request builder

marketable

@CheckReturnValue
MarketableRequest marketable()

Returns the set of marketable item IDs.

Returns:

request builder

extra

@CheckReturnValue
Extra extra()

Allows requests on route of the extra route

Returns:

extra route

close

void close()

Shuts down the underlying HTTP client and executor. Any in-flight or queued asynchronous requests will be cancelled.

Specified by:

close in interface AutoCloseable