Package io.github.mainstringargs.polygon

Class PolygonAPI

java.lang.Object

io.github.mainstringargs.polygon.PolygonAPI

public class PolygonAPI
extends java.lang.Object

The Class PolygonAPI.

Constructor Summary

Constructors

Constructor	Description
PolygonAPI()	Instantiates a new polygon API.
PolygonAPI(java.lang.String keyId)	Instantiates a new polygon API.
PolygonAPI(java.lang.String keyId, java.lang.String... polygonNatsServers)	Instantiates a new polygon API.

Method Summary

Modifier and Type	Method	Description
void	addPolygonStreamListener(PolygonStreamListener streamListener)	Adds the polygon stream listener.
Aggregates	getAggregates(java.lang.String ticker, java.lang.Integer multiplier, Timespan timeSpan, java.time.LocalDate fromDate, java.time.LocalDate toDate, java.lang.Boolean unadjusted)	Get aggregates for a date range, in custom time window sizes
DailyOpenClose	getDailyOpenClose(java.lang.String symbol, java.time.LocalDate date)	Get the open, close and afterhours prices of a symbol on a certain date.
java.util.List<Exchange>	getExchanges()	List of stock exchanges which are supported by Polygon.io
Aggregates	getGroupedDaily(Locale locale, Market market, java.time.LocalDate date, java.lang.Boolean unadjusted)	Get the daily OHLC for entire markets.
Quotes	getHistoricQuotes(java.lang.String symbol, java.time.LocalDate date, java.lang.Integer offset, java.lang.Integer limit)	Get historic quotes for a symbol.
Trades	getHistoricTrades(java.lang.String symbol, java.time.LocalDate date, java.lang.Integer offset, java.lang.Integer limit)	Get historic trades for a symbol.
Quote	getLastQuote(java.lang.String symbol)	Get the last quote tick for a given stock.
Trade	getLastTrade(java.lang.String symbol)	Get the last trade for a given stock.
java.util.List<Locale>	getLocales()	Get the list of currently supported locales
java.util.List<Market>	getMarkets()	Get the list of currently supported markets
Aggregates	getPreviousClose(java.lang.String ticker, java.lang.Boolean unadjusted)	Get the previous day close for the specified ticker
Snapshot	getSnapshot(java.lang.String symbol)	See the current snapshot of a single ticker
java.util.List<Snapshot>	getSnapshotAllTickers()	Snapshot allows you to see all tickers current minute aggregate, daily aggregate and last trade.
java.util.List<Snapshot>	getSnapshotsGainers()	See the current snapshot of the top 20 gainers of the day at the moment.
java.util.List<Snapshot>	getSnapshotsLosers()	See the current snapshot of the top 20 losers of the day at the moment.
java.util.List<Split>	getSplits(java.lang.String symbol)	Get the historical splits for this symbol
SymbolAnalystRatings	getSymbolAnalystRatings(java.lang.String symbol)	Get the analyst ratings of the symbol company/entity.
SymbolDetails	getSymbolDetails(java.lang.String symbol)	Get the details of the symbol company/entity.
java.util.List<SymbolDividend>	getSymbolDividends(java.lang.String symbol)	Get the historical dividends for this symbol.
java.util.List<SymbolEarning>	getSymbolEarnings(java.lang.String symbol)	Get the historical earnings for a company
SymbolEndpoints	getSymbolEndpoints(java.lang.String symbol)	Get gets the endpoints that are supported for a symbol.
java.util.List<SymbolFinancial>	getSymbolFinancials(java.lang.String symbol)	Get the historical financials for a company
java.util.List<SymbolNews>	getSymbolNews(java.lang.String symbol)	Get news articles for this symbol.
java.util.List<SymbolNews>	getSymbolNews(java.lang.String symbol, java.lang.Integer perpage, java.lang.Integer page)	Get news articles for this symbol.
Tickers	getTickers(Sort sort, Type type, Market market, Locale locale, java.lang.String search, java.lang.Integer perpage, java.lang.Integer page, java.lang.Boolean active)	Query all ticker symbols which are supported by Polygon.io.
TypesMapping	getTypesMapping()	Get the mapping of ticker types to descriptions / long names
void	removePolygonStreamListener(PolygonStreamListener streamListener)	Removes the polygon stream listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolygonAPI

public PolygonAPI()

Instantiates a new polygon API.

PolygonAPI

public PolygonAPI(java.lang.String keyId)

Instantiates a new polygon API.

Parameters:

keyId - the key id

PolygonAPI

public PolygonAPI(java.lang.String keyId,
                  java.lang.String... polygonNatsServers)

Instantiates a new polygon API.

Parameters:

keyId - the key id

polygonNatsServers - the polygon nats servers

Method Detail

getSymbolEndpoints

public SymbolEndpoints getSymbolEndpoints(java.lang.String symbol)
                                   throws PolygonAPIException

Get gets the endpoints that are supported for a symbol. Note: The endpoints object is key/values of the endpoint name and url. These will almost always be the same of all symbols.

Parameters:

symbol - we want the endpoint list for.

Returns:

the symbol endpoints

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol

getSymbolDetails

public SymbolDetails getSymbolDetails(java.lang.String symbol)
                               throws PolygonAPIException

Get the details of the symbol company/entity. These are important details which offer an overview of the entity. Things like name, sector, description, logo and similar companies.

Parameters:

symbol - we want details for

Returns:

the symbol details

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol_company

getSymbolAnalystRatings

public SymbolAnalystRatings getSymbolAnalystRatings(java.lang.String symbol)
                                             throws PolygonAPIException

Get the analyst ratings of the symbol company/entity. Ratings are from current date, up to 5months into the future.

Parameters:

symbol - we want analyst ratings for

Returns:

the symbol analyst ratings

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol_analysts

getSymbolDividends

public java.util.List<SymbolDividend> getSymbolDividends(java.lang.String symbol)
                                                  throws PolygonAPIException

Get the historical dividends for this symbol.

Parameters:

symbol - we want details for

Returns:

the symbol dividends

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol_dividends

getSymbolEarnings

public java.util.List<SymbolEarning> getSymbolEarnings(java.lang.String symbol)
                                                throws PolygonAPIException

Get the historical earnings for a company

Parameters:

symbol - we want details for

Returns:

the symbol earnings

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol_earnings

getSymbolFinancials

public java.util.List<SymbolFinancial> getSymbolFinancials(java.lang.String symbol)
                                                    throws PolygonAPIException

Get the historical financials for a company

Parameters:

symbol - we want details for

Returns:

the symbol financials

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol_financials

getSymbolNews

public java.util.List<SymbolNews> getSymbolNews(java.lang.String symbol)
                                         throws PolygonAPIException

Get news articles for this symbol.

Parameters:

symbol - the symbol we want details for

Returns:

the symbol news

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol_news

getSymbolNews

public java.util.List<SymbolNews> getSymbolNews(java.lang.String symbol,
                                                java.lang.Integer perpage,
                                                java.lang.Integer page)
                                         throws PolygonAPIException

Get news articles for this symbol.

Parameters:

symbol - the symbol we want details for

perpage - How many items to be on each page during pagination. Max 50

page - Which page of results to return

Returns:

the symbol news

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Meta-Data/get_v1_meta_symbols_symbol_news

getTickers

public Tickers getTickers(Sort sort,
                          Type type,
                          Market market,
                          Locale locale,
                          java.lang.String search,
                          java.lang.Integer perpage,
                          java.lang.Integer page,
                          java.lang.Boolean active)
                   throws PolygonAPIException

Query all ticker symbols which are supported by Polygon.io.

Parameters:

sort - Which field to sort by.

type - If you want the results to only container a certain type.

market - Get tickers for a specific market

locale - Get tickers for a specific region/locale

search - Search the name of tickers

perpage - How many items to be on each page during pagination. Max 50

page - Which page of results to return

active - Filter for only active or inactive symbols

Returns:

the tickers

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Reference/get_v2_reference_tickers

getMarkets

public java.util.List<Market> getMarkets()
                                  throws PolygonAPIException

Get the list of currently supported markets

Returns:

the markets

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Reference/get_v2_reference_markets

getLocales

public java.util.List<Locale> getLocales()
                                  throws PolygonAPIException

Get the list of currently supported locales

Returns:

the locales

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Reference/get_v2_reference_locales

getTypesMapping

public TypesMapping getTypesMapping()
                             throws PolygonAPIException

Get the mapping of ticker types to descriptions / long names

Returns:

the types mapping

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Reference/get_v2_reference_types

getSplits

public java.util.List<Split> getSplits(java.lang.String symbol)
                                throws PolygonAPIException

Get the historical splits for this symbol

Parameters:

symbol - we want details for

Returns:

the splits

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Reference/get_v2_reference_splits_symbol

getExchanges

public java.util.List<Exchange> getExchanges()
                                      throws PolygonAPIException

List of stock exchanges which are supported by Polygon.io

Returns:

the exchange

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v1_meta_exchanges

getHistoricTrades

public Trades getHistoricTrades(java.lang.String symbol,
                                java.time.LocalDate date,
                                java.lang.Integer offset,
                                java.lang.Integer limit)
                         throws PolygonAPIException

Get historic trades for a symbol.

Parameters:

symbol - the symbol of the company to retrieve

date - Date/Day of the historic ticks to retreive

offset - Timestamp offset, used for pagination. This is the offset at which to start the results. Using the timestamp of the last result as the offset will give you the next page of results.

limit - Limit the size of response, Max 50000

Returns:

the historic trades

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v1_historic_trades_symbol_date

getHistoricQuotes

public Quotes getHistoricQuotes(java.lang.String symbol,
                                java.time.LocalDate date,
                                java.lang.Integer offset,
                                java.lang.Integer limit)
                         throws PolygonAPIException

Get historic quotes for a symbol.

Parameters:

symbol - the symbol of the company to retrieve

date - Date/Day of the historic ticks to retreive

offset - Timestamp offset, used for pagination. This is the offset at which to start the results. Using the timestamp of the last result as the offset will give you the next page of results.

limit - Limit the size of response, Max 50000

Returns:

the historic quotes

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v1_historic_quotes_symbol_date

getLastTrade

public Trade getLastTrade(java.lang.String symbol)
                   throws PolygonAPIException

Get the last trade for a given stock.

Parameters:

symbol - Symbol of the stock to get

Returns:

the last trade

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v1_last_stocks_symbol

getLastQuote

public Quote getLastQuote(java.lang.String symbol)
                   throws PolygonAPIException

Get the last quote tick for a given stock.

Parameters:

symbol - Symbol of the quote to get

Returns:

the last quote

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v1_last_quote_stocks_symbol

getDailyOpenClose

public DailyOpenClose getDailyOpenClose(java.lang.String symbol,
                                        java.time.LocalDate date)
                                 throws PolygonAPIException

Get the open, close and afterhours prices of a symbol on a certain date.

Parameters:

symbol - Symbol of the stock to get

date - Date of the requested open/close

Returns:

the daily open close

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v1_open_close_symbol_date

getSnapshotAllTickers

public java.util.List<Snapshot> getSnapshotAllTickers()
                                               throws PolygonAPIException

Snapshot allows you to see all tickers current minute aggregate, daily aggregate and last trade. As well as previous days aggregate and calculated change for today.

Returns:

the snapshot all tickers

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v2_snapshot_locale_us_markets_stocks_tickers

getSnapshot

public Snapshot getSnapshot(java.lang.String symbol)
                     throws PolygonAPIException

See the current snapshot of a single ticker

Parameters:

symbol - Ticker of the snapshot

Returns:

the snapshot

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v2_snapshot_locale_us_markets_stocks_tickers_ticker

getSnapshotsGainers

public java.util.List<Snapshot> getSnapshotsGainers()
                                             throws PolygonAPIException

See the current snapshot of the top 20 gainers of the day at the moment.

Returns:

the snapshots gainers

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v2_snapshot_locale_us_markets_stocks_gainers

getSnapshotsLosers

public java.util.List<Snapshot> getSnapshotsLosers()
                                            throws PolygonAPIException

See the current snapshot of the top 20 losers of the day at the moment.

Returns:

the snapshots losers

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v2_snapshot_locale_us_markets_stocks_losers

getPreviousClose

public Aggregates getPreviousClose(java.lang.String ticker,
                                   java.lang.Boolean unadjusted)
                            throws PolygonAPIException

Get the previous day close for the specified ticker

Parameters:

ticker - Ticker symbol of the request

unadjusted - Set to true if the results should NOT be adjusted for splits.

Returns:

the previous close

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v2_aggs_ticker_ticker_prev

getAggregates

public Aggregates getAggregates(java.lang.String ticker,
                                java.lang.Integer multiplier,
                                Timespan timeSpan,
                                java.time.LocalDate fromDate,
                                java.time.LocalDate toDate,
                                java.lang.Boolean unadjusted)
                         throws PolygonAPIException

Get aggregates for a date range, in custom time window sizes

Parameters:

ticker - Ticker symbol of the request

multiplier - Size of the timespan multiplier

timeSpan - Size of the time window

fromDate - the from date

toDate - the to date

unadjusted - Set to true if the results should NOT be adjusted for splits

Returns:

the aggregates

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v2_aggs_ticker_ticker_range_multiplier_timespan_from_to

getGroupedDaily

public Aggregates getGroupedDaily(Locale locale,
                                  Market market,
                                  java.time.LocalDate date,
                                  java.lang.Boolean unadjusted)
                           throws PolygonAPIException

Get the daily OHLC for entire markets.

Parameters:

locale - Locale of the aggregates ( See 'Locales' API )

market - Market of the aggregates ( See 'Markets' API )

date - to date

unadjusted - Set to true if the results should NOT be adjusted for splits.

Returns:

the grouped daily

Throws:

PolygonAPIException - the polygon API exception

See Also:

https://polygon.io/docs/#!/Stocks--Equities/get_v2_aggs_grouped_locale_locale_market_market_date

addPolygonStreamListener

public void addPolygonStreamListener(PolygonStreamListener streamListener)

Adds the polygon stream listener.

Parameters:

streamListener - the stream listener

removePolygonStreamListener

public void removePolygonStreamListener(PolygonStreamListener streamListener)

Removes the polygon stream listener.

Parameters:

streamListener - the stream listener