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 and Description
PolygonAPI() Instantiates a new polygon API.
PolygonAPI(java.lang.String keyId) Instantiates a new polygon API.
PolygonAPI(java.lang.String baseAPIURL, java.lang.String websocketURL, java.lang.String keyID) Instantiates a new polygon API.

Method Summary

Modifier and Type	Method and Description
void	addPolygonStreamListener(PolygonStreamListener streamListener) Adds the polygon stream listener.
AggregatesResponse	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
ConditionsMapping	getConditionsMapping(ConditionMappingsType conditionMappingsType) The mappings for conditions on trades and quotes.
DailyOpenCloseResponse	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.ArrayList<Exchange>	getExchanges() List of stock exchanges which are supported by Polygon.io
GroupedDailyResponse	getGroupedDaily(java.lang.String locale, Market market, java.time.LocalDate date, java.lang.Boolean unadjusted) Get the daily OHLC for entire markets.
HistoricQuotesResponse	getHistoricQuotes(java.lang.String ticker, java.time.LocalDate date, java.lang.Long timestamp, java.lang.Long timestampLimit, java.lang.Boolean reverse, java.lang.Integer limit) Get historic NBBO quotes for a ticker.
HistoricTradesResponse	getHistoricTrades(java.lang.String ticker, java.time.LocalDate date, java.lang.Long timestamp, java.lang.Long timestampLimit, java.lang.Boolean reverse, java.lang.Integer limit) Get historic trades for a symbol.
LastQuoteResponse	getLastQuote(java.lang.String symbol) Get the last quote for a given stock.
LastTradeResponse	getLastTrade(java.lang.String symbol) Get the last trade for a given stock.
LocalesResponse	getLocales() Get the list of currently supported locales
java.util.ArrayList<MarketHoliday>	getMarketHolidays() Get upcoming market holidays and their open/close times.
MarketsResponse	getMarkets() Get the list of currently supported markets
MarketStatus	getMarketStatus() Current status of each market.
PreviousCloseResponse	getPreviousClose(java.lang.String ticker, java.lang.Boolean unadjusted) Get the previous day close for the specified ticker
SnapshotAllTickersResponse	getSnapshotAllTickers() Snapshot allows you to see all tickers current minute aggregate, daily aggregate and last trade.
SnapshotGainersLosersResponse	getSnapshotsGainersLosers(GainersLosersDirection gainersLosersDirection) See the current snapshot of the top 20 gainers of the day at the moment.
SnapshotSingleTickerResponse	getSnapshotSingleTicker(java.lang.String ticker) See the current snapshot of a single ticker
SnapshotTickerBook	getSnapshotTickerBook(java.lang.String locale, Market market, java.lang.String ticker) See the current snapshot of Level II data on IEX for the given ticker.
StockDividendsResponse	getStockDividends(java.lang.String symbol) Get the historical dividends for this symbol.
StockFinancialsResponse	getStockFinancials(java.lang.String symbol, java.lang.Integer limit, FinancialReportType financialReportType, FinancialSort financialSort) Get the historical financials for this ticker.
StockSplitsResponse	getStockSplits(java.lang.String symbol) Get the historical splits for this symbol
TickerDetails	getTickerDetails(java.lang.String symbol) Get the details of the symbol company/entity.
java.util.ArrayList<TickerNews>	getTickerNews(java.lang.String symbol, java.lang.Integer perpage, java.lang.Integer page) Get news articles for this symbol.
TickersResponse	getTickers(TickerSort tickerSort, StockType stockType, Market market, java.lang.String 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.
TickerTypes	getTickerTypes() Get the mapping of ticker types to descriptions / long names.
void	removePolygonStreamListener(PolygonStreamListener streamListener) Removes the polygon stream listener.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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 baseAPIURL,
                  java.lang.String websocketURL,
                  java.lang.String keyID)

Instantiates a new polygon API.

Parameters:

baseAPIURL - the base api url

websocketURL - the websocket url

keyID - the key id

Method Detail

getTickers

public TickersResponse getTickers(TickerSort tickerSort,
                                  StockType stockType,
                                  Market market,
                                  java.lang.String locale,
                                  java.lang.String search,
                                  java.lang.Integer perpage,
                                  java.lang.Integer page,
                                  java.lang.Boolean active)
                           throws PolygonAPIRequestException

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

Parameters:

tickerSort - Which field to sort by.

stockType - 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:

PolygonAPIRequestException - the polygon API exception

See Also:

Tickers

getTickerTypes

public TickerTypes getTickerTypes()
                           throws PolygonAPIRequestException

Get the mapping of ticker types to descriptions / long names.

Returns:

the ticker types

Throws:

PolygonAPIRequestException

See Also:

Ticker Types

getTickerDetails

public TickerDetails getTickerDetails(java.lang.String symbol)
                               throws PolygonAPIRequestException

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 - symbol we want details for

Returns:

the ticker details

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Ticker Details

getTickerNews

public java.util.ArrayList<TickerNews> getTickerNews(java.lang.String symbol,
                                                     java.lang.Integer perpage,
                                                     java.lang.Integer page)
                                              throws PolygonAPIRequestException

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 ticker news

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Ticker News

getMarkets

public MarketsResponse getMarkets()
                           throws PolygonAPIRequestException

Get the list of currently supported markets

Returns:

the markets

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Markets

getLocales

public LocalesResponse getLocales()
                           throws PolygonAPIRequestException

Get the list of currently supported locales

Returns:

the locales

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Locales

getStockSplits

public StockSplitsResponse getStockSplits(java.lang.String symbol)
                                   throws PolygonAPIRequestException

Get the historical splits for this symbol

Parameters:

symbol - symbol we want details for

Returns:

the stock splits

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Stock Splits

getStockDividends

public StockDividendsResponse getStockDividends(java.lang.String symbol)
                                         throws PolygonAPIRequestException

Get the historical dividends for this symbol.

Parameters:

symbol - symbol we want details for

Returns:

the stock dividends

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Stock Dividends

getStockFinancials

public StockFinancialsResponse getStockFinancials(java.lang.String symbol,
                                                  java.lang.Integer limit,
                                                  FinancialReportType financialReportType,
                                                  FinancialSort financialSort)
                                           throws PolygonAPIRequestException

Get the historical financials for this ticker.

Parameters:

symbol - symbol we want details for

limit - limit the number of results

financialReportType - type of reports

financialSort - sort direction

Returns:

the symbol financials

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Stock Financials

getMarketStatus

public MarketStatus getMarketStatus()
                             throws PolygonAPIRequestException

Current status of each market.

Returns:

the market status

Throws:

PolygonAPIRequestException - the polygon api request exception

See Also:

Market Status

getMarketHolidays

public java.util.ArrayList<MarketHoliday> getMarketHolidays()
                                                     throws PolygonAPIRequestException

Get upcoming market holidays and their open/close times.

Returns:

the market holidays

Throws:

PolygonAPIRequestException - the polygon api request exception

See Also:

Market Holidays

getExchanges

public java.util.ArrayList<Exchange> getExchanges()
                                           throws PolygonAPIRequestException

List of stock exchanges which are supported by Polygon.io

Returns:

the exchanges

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Exchanges

getHistoricTrades

public HistoricTradesResponse getHistoricTrades(java.lang.String ticker,
                                                java.time.LocalDate date,
                                                java.lang.Long timestamp,
                                                java.lang.Long timestampLimit,
                                                java.lang.Boolean reverse,
                                                java.lang.Integer limit)
                                         throws PolygonAPIRequestException

Get historic trades for a symbol.

Parameters:

ticker - Ticker symbol we want ticks for

date - Date/Day of the historic ticks to retrieve

timestamp - 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.

timestampLimit - Maximum timestamp allowed in the results.

reverse - Reverse the order of the results. This is useful in combination with timestamp param.

limit - Limit the size of response, Max 50000

Returns:

the historic trades

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Historic Trades

getHistoricQuotes

public HistoricQuotesResponse getHistoricQuotes(java.lang.String ticker,
                                                java.time.LocalDate date,
                                                java.lang.Long timestamp,
                                                java.lang.Long timestampLimit,
                                                java.lang.Boolean reverse,
                                                java.lang.Integer limit)
                                         throws PolygonAPIRequestException

Get historic NBBO quotes for a ticker.

Parameters:

ticker - Ticker symbol we want ticks for

date - Date/Day of the historic ticks to retrieve

timestamp - 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.

timestampLimit - Maximum timestamp allowed in the results.

reverse - Reverse the order of the results. This is useful in combination with timestamp param.

limit - Limit the size of response, Max 50000

Returns:

the historic quotes

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Historic Quotes

getLastTrade

public LastTradeResponse getLastTrade(java.lang.String symbol)
                               throws PolygonAPIRequestException

Get the last trade for a given stock.

Parameters:

symbol - Symbol of the stock to get

Returns:

the last trade

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Last Trade

getLastQuote

public LastQuoteResponse getLastQuote(java.lang.String symbol)
                               throws PolygonAPIRequestException

Get the last quote for a given stock.

Parameters:

symbol - Symbol of the stock to get

Returns:

the last quote

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Last Quote

getDailyOpenClose

public DailyOpenCloseResponse getDailyOpenClose(java.lang.String symbol,
                                                java.time.LocalDate date)
                                         throws PolygonAPIRequestException

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:

PolygonAPIRequestException - the polygon API exception

See Also:

Daily Open/Close

getConditionsMapping

public ConditionsMapping getConditionsMapping(ConditionMappingsType conditionMappingsType)
                                       throws PolygonAPIRequestException

The mappings for conditions on trades and quotes.

Parameters:

conditionMappingsType - Ticker type we want mappings for

Returns:

the conditions mapping

Throws:

PolygonAPIRequestException - the polygon api request exception

See Also:

Condition Mappings

getSnapshotAllTickers

public SnapshotAllTickersResponse getSnapshotAllTickers()
                                                 throws PolygonAPIRequestException

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:

PolygonAPIRequestException - the polygon API exception

See Also:

Snapshot - All Tickers

getSnapshotSingleTicker

public SnapshotSingleTickerResponse getSnapshotSingleTicker(java.lang.String ticker)
                                                     throws PolygonAPIRequestException

See the current snapshot of a single ticker

Parameters:

ticker - Ticker of the snapshot

Returns:

the snapshot single ticker

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Snapshot - Single Ticker

getSnapshotsGainersLosers

public SnapshotGainersLosersResponse getSnapshotsGainersLosers(GainersLosersDirection gainersLosersDirection)
                                                        throws PolygonAPIRequestException

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

Parameters:

gainersLosersDirection - the gainers losers direction

Returns:

the snapshots gainers

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Snapshot - Gainers / Losers

getSnapshotTickerBook

public SnapshotTickerBook getSnapshotTickerBook(java.lang.String locale,
                                                Market market,
                                                java.lang.String ticker)
                                         throws PolygonAPIRequestException

See the current snapshot of Level II data on IEX for the given ticker.

Parameters:

locale - the locale

market - the market

ticker - the ticker

Returns:

the snapshot ticker book

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Docs not public yet

getPreviousClose

public PreviousCloseResponse getPreviousClose(java.lang.String ticker,
                                              java.lang.Boolean unadjusted)
                                       throws PolygonAPIRequestException

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:

PolygonAPIRequestException - the polygon API exception

See Also:

Previous Close

getAggregates

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

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 - From date

toDate - To date

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

Returns:

the aggregates

Throws:

PolygonAPIRequestException - the polygon API exception

See Also:

Aggregates

getGroupedDaily

public GroupedDailyResponse getGroupedDaily(java.lang.String locale,
                                            Market market,
                                            java.time.LocalDate date,
                                            java.lang.Boolean unadjusted)
                                     throws PolygonAPIRequestException

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:

PolygonAPIRequestException - the polygon API exception

See Also:

Grouped Daily

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object