import { AxiosInstance, RawAxiosRequestConfig } from 'axios'; import * as websocket from 'websocket'; /** * Polygon API * The future of fintech. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); basePath?: string; serverIndex?: number; baseOptions?: any; formDataCtor?: new () => any; } declare class Configuration { /** * parameter for apiKey security * @param name security name * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security * * @type {string} * @memberof Configuration */ username?: string; /** * parameter for basic security * * @type {string} * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path * * @type {string} * @memberof Configuration */ basePath?: string; /** * override server index * * @type {number} * @memberof Configuration */ serverIndex?: number; /** * base options for axios calls * * @type {any} * @memberof Configuration */ baseOptions?: any; /** * The FormData constructor that will be used to create multipart form data * requests. You can inject this here so that execution environments that * do not support the FormData class can still run the generated client. * * @type {new () => FormData} */ formDataCtor?: new () => any; constructor(param?: ConfigurationParameters); /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ isJsonMime(mime: string): boolean; } /** * Polygon API * The future of fintech. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface RequestArgs */ interface RequestArgs { url: string; options: RawAxiosRequestConfig; } /** * * @export * @class BaseAPI */ declare class BaseAPI { protected basePath: string; protected axios: AxiosInstance; protected configuration: Configuration | undefined; constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance); } /** * Polygon API * The future of fintech. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Company */ interface Company { /** * Indicates if the security is actively listed. If false, this means the company is no longer listed and cannot be traded. * @type {boolean} * @memberof Company */ 'active'?: boolean; /** * The Bloomberg guid for the symbol. * @type {string} * @memberof Company */ 'bloomberg'?: string; /** * The name of the company\'s current CEO. * @type {string} * @memberof Company */ 'ceo'?: string; /** * The official CIK guid used for SEC database/filings. * @type {string} * @memberof Company */ 'cik'?: string; /** * The country in which the company is registered. * @type {string} * @memberof Company */ 'country'?: string; /** * A description of the company and what they do/offer. * @type {string} * @memberof Company */ 'description'?: string; /** * The approximate number of employees for the company. * @type {number} * @memberof Company */ 'employees'?: number; /** * The symbol\'s primary exchange. * @type {string} * @memberof Company */ 'exchange'?: string; /** * The exchange code (id) of the symbol\'s primary exchange. * @type {string} * @memberof Company */ 'exchangeSymbol'?: string; /** * The OpenFigi project guid for the symbol. (https://openfigi.com/) * @type {string} * @memberof Company */ 'figi'?: string; /** * The street address for the company\'s headquarters. * @type {string} * @memberof Company */ 'hq_address'?: string; /** * The country in which the company\'s headquarters is located. * @type {string} * @memberof Company */ 'hq_country'?: string; /** * The state in which the company\'s headquarters is located. * @type {string} * @memberof Company */ 'hq_state'?: string; /** * The industry in which the company operates. * @type {string} * @memberof Company */ 'industry'?: string; /** * The Legal Entity Identifier (LEI) guid for the symbol. (https://en.wikipedia.org/wiki/Legal_Entity_Identifier) * @type {string} * @memberof Company */ 'lei'?: string; /** * The date that the symbol was listed on the exchange. * @type {string} * @memberof Company */ 'listdate'?: string; /** * The URL of the entity\'s logo. * @type {string} * @memberof Company */ 'logo'?: string; /** * The current market cap for the company. * @type {number} * @memberof Company */ 'marketcap'?: number; /** * The name of the company/entity. * @type {string} * @memberof Company */ 'name'?: string; /** * The phone number for the company. This is usually a corporate contact number. * @type {string} * @memberof Company */ 'phone'?: string; /** * The sector of the indsutry in which the symbol operates. * @type {string} * @memberof Company */ 'sector'?: string; /** * Standard Industrial Classification (SIC) id for the symbol. (https://en.wikipedia.org/wiki/Legal_Entity_Identifier) * @type {number} * @memberof Company */ 'sic'?: number; /** * A list of ticker symbols for similar companies. * @type {Array} * @memberof Company */ 'similar'?: Array; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof Company */ 'symbol'?: string; /** * * @type {Array} * @memberof Company */ 'tags'?: Array; /** * The type or class of the security. (Full List of Ticker Types) * @type {string} * @memberof Company */ 'type'?: string; /** * The last time this company record was updated. * @type {string} * @memberof Company */ 'updated'?: string; /** * The URL of the company\'s website * @type {string} * @memberof Company */ 'url'?: string; } /** * * @export * @interface ConditionTypeMap */ interface ConditionTypeMap { /** * Polygon.io\'s mapping for condition codes. For more information, see our Trade Conditions Glossary. * @type {string} * @memberof ConditionTypeMap */ 'condition'?: string; } /** * * @export * @interface CryptoExchangeInner */ interface CryptoExchangeInner { /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof CryptoExchangeInner */ 'id': number; /** * Market data type this exchange contains ( crypto only currently ) * @type {string} * @memberof CryptoExchangeInner */ 'market': string; /** * Name of the exchange * @type {string} * @memberof CryptoExchangeInner */ 'name': string; /** * Type of exchange feed * @type {string} * @memberof CryptoExchangeInner */ 'type': string; /** * URL of this exchange * @type {string} * @memberof CryptoExchangeInner */ 'url': string; } /** * * @export * @interface CryptoGroupedResults */ interface CryptoGroupedResults { /** * An array of results containing the requested data. * @type {Array} * @memberof CryptoGroupedResults */ 'results'?: Array; } /** * * @export * @interface CryptoHistoricTrades */ interface CryptoHistoricTrades { /** * The date that was evaluated from the request. * @type {string} * @memberof CryptoHistoricTrades */ 'day': string; /** * A map for shortened result keys. * @type {object} * @memberof CryptoHistoricTrades */ 'map': object; /** * The milliseconds of latency for the query results. * @type {number} * @memberof CryptoHistoricTrades */ 'msLatency': number; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof CryptoHistoricTrades */ 'symbol': string; /** * * @type {Array} * @memberof CryptoHistoricTrades */ 'ticks': Array; } /** * * @export * @interface CryptoLastTrade */ interface CryptoLastTrade { /** * * @type {CryptoLastTradeLast} * @memberof CryptoLastTrade */ 'last'?: CryptoLastTradeLast; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof CryptoLastTrade */ 'symbol': string; } /** * * @export * @interface CryptoLastTradeLast */ interface CryptoLastTradeLast { /** * A list of condition codes. * @type {Array} * @memberof CryptoLastTradeLast */ 'conditions': Array; /** * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof CryptoLastTradeLast */ 'exchange': number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof CryptoLastTradeLast */ 'price': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof CryptoLastTradeLast */ 'size': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof CryptoLastTradeLast */ 'timestamp': number; } /** * * @export * @interface CryptoOpenClose */ interface CryptoOpenClose { /** * The close price for the symbol in the given time period. * @type {number} * @memberof CryptoOpenClose */ 'close': number; /** * An array of results containing the requested data. * @type {Array} * @memberof CryptoOpenClose */ 'closingTrades': Array; /** * The date requested. * @type {string} * @memberof CryptoOpenClose */ 'day': string; /** * Whether or not the timestamps are in UTC timezone. * @type {boolean} * @memberof CryptoOpenClose */ 'isUTC': boolean; /** * The open price for the symbol in the given time period. * @type {number} * @memberof CryptoOpenClose */ 'open': number; /** * An array of results containing the requested data. * @type {Array} * @memberof CryptoOpenClose */ 'openTrades': Array; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof CryptoOpenClose */ 'symbol': string; } /** * * @export * @interface CryptoSnapshotMinute */ interface CryptoSnapshotMinute { /** * The close price for the symbol in the given time period. * @type {number} * @memberof CryptoSnapshotMinute */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof CryptoSnapshotMinute */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof CryptoSnapshotMinute */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof CryptoSnapshotMinute */ 'n': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof CryptoSnapshotMinute */ 'o': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof CryptoSnapshotMinute */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof CryptoSnapshotMinute */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof CryptoSnapshotMinute */ 'vw': number; } /** * * @export * @interface CryptoSnapshotTicker */ interface CryptoSnapshotTicker { /** * * @type {GetCryptoSnapshotTicker200ResponseAllOfTicker} * @memberof CryptoSnapshotTicker */ 'ticker'?: GetCryptoSnapshotTicker200ResponseAllOfTicker; } /** * * @export * @interface CryptoSnapshotTickerFullBook */ interface CryptoSnapshotTickerFullBook { /** * * @type {DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData} * @memberof CryptoSnapshotTickerFullBook */ 'data'?: DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData; } /** * * @export * @interface CryptoSnapshotTickers */ interface CryptoSnapshotTickers { /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof CryptoSnapshotTickers */ 'tickers'?: Array; } /** * * @export * @interface CryptoTick */ interface CryptoTick { /** * A list of condition codes. * @type {Array} * @memberof CryptoTick */ 'c': Array; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof CryptoTick */ 'i': string; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof CryptoTick */ 'p': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof CryptoTick */ 's': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof CryptoTick */ 't': number; /** * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof CryptoTick */ 'x': number; } /** * * @export * @interface DeprecatedGetCryptoSnapshotTickerBook200Response */ interface DeprecatedGetCryptoSnapshotTickerBook200Response { /** * * @type {DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData} * @memberof DeprecatedGetCryptoSnapshotTickerBook200Response */ 'data'?: DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData; } /** * * @export * @interface DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ interface DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData { /** * The combined total number of asks in the book. * @type {number} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ 'askCount': number; /** * * @type {Array} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ 'asks': Array; /** * The combined total number of bids in the book. * @type {number} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ 'bidCount': number; /** * * @type {Array} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ 'bids': Array; /** * The difference between the best bid and the best ask price across exchanges. * @type {number} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ 'spread': number; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ 'ticker': string; /** * The last updated timestamp. * @type {number} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData */ 'updated': number; } /** * * @export * @interface DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfDataAsksInner */ interface DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfDataAsksInner { /** * The price of this book level. * @type {number} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfDataAsksInner */ 'p': number; /** * A map of the exchange ID to number of shares at this price level.

**Example:**
`{ \"p\": 16302.94, \"x\": { \"1\": 0.02859424, \"6\": 0.023455 } }`

In this example, exchange ID 1 has 0.02859424 shares available at $16,302.94, and exchange ID 6 has 0.023455 shares at the same price level. * @type {object} * @memberof DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfDataAsksInner */ 'x': object; } /** * * @export * @interface DeprecatedGetHistoricCryptoTrades200Response */ interface DeprecatedGetHistoricCryptoTrades200Response { /** * The date that was evaluated from the request. * @type {string} * @memberof DeprecatedGetHistoricCryptoTrades200Response */ 'day': string; /** * A map for shortened result keys. * @type {object} * @memberof DeprecatedGetHistoricCryptoTrades200Response */ 'map': object; /** * The milliseconds of latency for the query results. * @type {number} * @memberof DeprecatedGetHistoricCryptoTrades200Response */ 'msLatency': number; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof DeprecatedGetHistoricCryptoTrades200Response */ 'symbol': string; /** * * @type {Array} * @memberof DeprecatedGetHistoricCryptoTrades200Response */ 'ticks': Array; } /** * * @export * @interface DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ interface DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner { /** * A list of condition codes. * @type {Array} * @memberof DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ 'c': Array; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ 'i': string; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ 'p': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ 's': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ 't': number; /** * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ 'x': number; } /** * * @export * @interface DeprecatedGetHistoricForexQuotes200Response */ interface DeprecatedGetHistoricForexQuotes200Response { /** * The status of this request\'s response. * @type {string} * @memberof DeprecatedGetHistoricForexQuotes200Response */ 'status': string; /** * The date that was evaluated from the request. * @type {string} * @memberof DeprecatedGetHistoricForexQuotes200Response */ 'day': string; /** * A map for shortened result keys. * @type {object} * @memberof DeprecatedGetHistoricForexQuotes200Response */ 'map': object; /** * The milliseconds of latency for the query results. * @type {number} * @memberof DeprecatedGetHistoricForexQuotes200Response */ 'msLatency': number; /** * The currency pair that was evaluated from the request. * @type {string} * @memberof DeprecatedGetHistoricForexQuotes200Response */ 'pair': string; /** * * @type {Array} * @memberof DeprecatedGetHistoricForexQuotes200Response */ 'ticks': Array; } /** * * @export * @interface DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner */ interface DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner { /** * The ask price. * @type {number} * @memberof DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner */ 'a': number; /** * The bid price. * @type {number} * @memberof DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner */ 'b': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner */ 't': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner */ 'x': number; } /** * * @export * @interface DeprecatedGetHistoricStocksQuotes200Response */ interface DeprecatedGetHistoricStocksQuotes200Response { /** * Latency in milliseconds for the query results from the database. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200Response */ 'db_latency'?: number; /** * The total number of results for this request. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200Response */ 'results_count'?: number; /** * Whether or not this query was executed successfully. * @type {boolean} * @memberof DeprecatedGetHistoricStocksQuotes200Response */ 'success'?: boolean; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof DeprecatedGetHistoricStocksQuotes200Response */ 'ticker'?: string; /** * * @type {Array} * @memberof DeprecatedGetHistoricStocksQuotes200Response */ 'results'?: Array; } /** * * @export * @interface DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ interface DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'T': string; /** * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'f': number; /** * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'q': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 't': number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'y': number; /** * The ask price. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'P': number; /** * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'S': number; /** * The ask exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'X': number; /** * A list of condition codes. * @type {Array} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'c': Array; /** * The indicators. For more information, see our glossary of [Conditions and Indicators](https://polygon.io/glossary/us/stocks/conditions-indicators). * @type {Array} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'i': Array; /** * The bid price. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'p': number; /** * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 's': number; /** * The bid exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'x': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ 'z': number; } /** * * @export * @interface DeprecatedGetHistoricStocksTrades200Response */ interface DeprecatedGetHistoricStocksTrades200Response { /** * Latency in milliseconds for the query results from the database. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200Response */ 'db_latency'?: number; /** * The total number of results for this request. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200Response */ 'results_count'?: number; /** * Whether or not this query was executed successfully. * @type {boolean} * @memberof DeprecatedGetHistoricStocksTrades200Response */ 'success'?: boolean; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof DeprecatedGetHistoricStocksTrades200Response */ 'ticker'?: string; /** * * @type {Array} * @memberof DeprecatedGetHistoricStocksTrades200Response */ 'results'?: Array; } /** * * @export * @interface DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ interface DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'T': string; /** * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'f': number; /** * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'q': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 't': number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'y': number; /** * A list of condition codes. * @type {Array} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'c': Array; /** * The trade correction indicator. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'e': number; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'i': string; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'p': number; /** * The ID for the Trade Reporting Facility where the trade took place. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'r': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 's': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'x': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ 'z': number; } /** * * @export * @interface ExchangeInner */ interface ExchangeInner { /** * A unique identifier for the exchange internal to Polygon.io. This is not an industry code or ISO standard. * @type {string} * @memberof ExchangeInner */ 'code'?: string; /** * The ID of the exchange. * @type {number} * @memberof ExchangeInner */ 'id'?: number; /** * The market data type that this exchange contains. * @type {string} * @memberof ExchangeInner */ 'market'?: string; /** * The Market Identification Code or MIC as defined in ISO 10383 (https://en.wikipedia.org/wiki/Market_Identifier_Code). * @type {string} * @memberof ExchangeInner */ 'mic'?: string; /** * The name of the exchange. * @type {string} * @memberof ExchangeInner */ 'name'?: string; /** * The tape id of the exchange. * @type {string} * @memberof ExchangeInner */ 'tape'?: string; /** * The type of exchange. - TRF = Trade Reporting Facility - exchange = Reporting exchange on the tape * @type {string} * @memberof ExchangeInner */ 'type'?: string; } /** * * @export * @interface Financial */ interface Financial { /** * * @type {number} * @memberof Financial */ 'cashChange'?: number; /** * * @type {number} * @memberof Financial */ 'cashFlow'?: number; /** * * @type {number} * @memberof Financial */ 'costOfRevenue'?: number; /** * * @type {number} * @memberof Financial */ 'currentAssets'?: number; /** * * @type {number} * @memberof Financial */ 'currentCash'?: number; /** * * @type {number} * @memberof Financial */ 'currentDebt'?: number; /** * * @type {number} * @memberof Financial */ 'grossProfit'?: number; /** * * @type {number} * @memberof Financial */ 'netIncome'?: number; /** * * @type {number} * @memberof Financial */ 'operatingExpense'?: number; /** * * @type {number} * @memberof Financial */ 'operatingGainsLosses'?: number; /** * * @type {number} * @memberof Financial */ 'operatingIncome'?: number; /** * * @type {number} * @memberof Financial */ 'operatingRevenue'?: number; /** * Report Date * @type {string} * @memberof Financial */ 'reportDate': string; /** * Report date as non date format * @type {string} * @memberof Financial */ 'reportDateStr': string; /** * * @type {number} * @memberof Financial */ 'researchAndDevelopment'?: number; /** * * @type {number} * @memberof Financial */ 'shareholderEquity'?: number; /** * Stock Symbol * @type {string} * @memberof Financial */ 'symbol': string; /** * * @type {number} * @memberof Financial */ 'totalAssets'?: number; /** * * @type {number} * @memberof Financial */ 'totalCash'?: number; /** * * @type {number} * @memberof Financial */ 'totalDebt'?: number; /** * * @type {number} * @memberof Financial */ 'totalLiabilities'?: number; /** * * @type {number} * @memberof Financial */ 'totalRevenue'?: number; } /** * Financials * @export * @interface Financials */ interface Financials { /** * * @type {number} * @memberof Financials */ 'EBITDAMargin'?: number; /** * * @type {number} * @memberof Financials */ 'accumulatedOtherComprehensiveIncome'?: number; /** * * @type {number} * @memberof Financials */ 'accumulatedRetainedEarningsDeficit'?: number; /** * * @type {number} * @memberof Financials */ 'assetTurnover'?: number; /** * * @type {number} * @memberof Financials */ 'assets'?: number; /** * * @type {number} * @memberof Financials */ 'assetsAverage'?: number; /** * * @type {number} * @memberof Financials */ 'assetsCurrent'?: number; /** * * @type {number} * @memberof Financials */ 'assetsNonCurrent'?: number; /** * * @type {number} * @memberof Financials */ 'averageEquity'?: number; /** * * @type {number} * @memberof Financials */ 'bookValuePerShare'?: number; /** * * @type {string} * @memberof Financials */ 'calendarDate'?: string; /** * * @type {number} * @memberof Financials */ 'capitalExpenditure'?: number; /** * * @type {number} * @memberof Financials */ 'cashAndEquivalents'?: number; /** * * @type {number} * @memberof Financials */ 'cashAndEquivalentsUSD'?: number; /** * * @type {number} * @memberof Financials */ 'consolidatedIncome'?: number; /** * * @type {number} * @memberof Financials */ 'costOfRevenue'?: number; /** * * @type {number} * @memberof Financials */ 'currentLiabilities'?: number; /** * * @type {number} * @memberof Financials */ 'currentRatio'?: number; /** * * @type {number} * @memberof Financials */ 'debt'?: number; /** * * @type {number} * @memberof Financials */ 'debtCurrent'?: number; /** * * @type {number} * @memberof Financials */ 'debtNonCurrent'?: number; /** * * @type {number} * @memberof Financials */ 'debtToEquityRatio'?: number; /** * * @type {number} * @memberof Financials */ 'debtUSD'?: number; /** * * @type {number} * @memberof Financials */ 'deferredRevenue'?: number; /** * * @type {number} * @memberof Financials */ 'deposits'?: number; /** * * @type {number} * @memberof Financials */ 'depreciationAmortizationAndAccretion'?: number; /** * * @type {number} * @memberof Financials */ 'dividendYield'?: number; /** * * @type {number} * @memberof Financials */ 'dividendsPerBasicCommonShare'?: number; /** * * @type {number} * @memberof Financials */ 'earningBeforeInterestTaxes'?: number; /** * * @type {number} * @memberof Financials */ 'earningBeforeInterestTaxesUSD'?: number; /** * * @type {number} * @memberof Financials */ 'earningsBeforeInterestTaxesDepreciationAmortization'?: number; /** * * @type {number} * @memberof Financials */ 'earningsBeforeInterestTaxesDepreciationAmortizationUSD'?: number; /** * * @type {number} * @memberof Financials */ 'earningsBeforeTax'?: number; /** * * @type {number} * @memberof Financials */ 'earningsPerBasicShare'?: number; /** * * @type {number} * @memberof Financials */ 'earningsPerBasicShareUSD'?: number; /** * * @type {number} * @memberof Financials */ 'earningsPerDilutedShare'?: number; /** * * @type {number} * @memberof Financials */ 'effectOfExchangeRateChangesOnCash'?: number; /** * * @type {number} * @memberof Financials */ 'enterpriseValue'?: number; /** * * @type {number} * @memberof Financials */ 'enterpriseValueOverEBIT'?: number; /** * * @type {number} * @memberof Financials */ 'enterpriseValueOverEBITDA'?: number; /** * * @type {number} * @memberof Financials */ 'foreignCurrencyUSDExchangeRate'?: number; /** * * @type {number} * @memberof Financials */ 'freeCashFlow'?: number; /** * * @type {number} * @memberof Financials */ 'freeCashFlowPerShare'?: number; /** * * @type {number} * @memberof Financials */ 'goodwillAndIntangibleAssets'?: number; /** * * @type {number} * @memberof Financials */ 'grossMargin'?: number; /** * * @type {number} * @memberof Financials */ 'grossProfit'?: number; /** * * @type {number} * @memberof Financials */ 'incomeTaxExpense'?: number; /** * * @type {number} * @memberof Financials */ 'interestExpense'?: number; /** * * @type {number} * @memberof Financials */ 'inventory'?: number; /** * * @type {number} * @memberof Financials */ 'investedCapital'?: number; /** * * @type {number} * @memberof Financials */ 'investedCapitalAverage'?: number; /** * * @type {number} * @memberof Financials */ 'investments'?: number; /** * * @type {number} * @memberof Financials */ 'investmentsCurrent'?: number; /** * * @type {number} * @memberof Financials */ 'investmentsNonCurrent'?: number; /** * * @type {number} * @memberof Financials */ 'issuanceDebtSecurities'?: number; /** * * @type {number} * @memberof Financials */ 'issuanceEquityShares'?: number; /** * * @type {number} * @memberof Financials */ 'liabilitiesNonCurrent'?: number; /** * * @type {number} * @memberof Financials */ 'marketCapitalization'?: number; /** * * @type {number} * @memberof Financials */ 'netCashFlow'?: number; /** * * @type {number} * @memberof Financials */ 'netCashFlowBusinessAcquisitionsDisposals'?: number; /** * * @type {number} * @memberof Financials */ 'netCashFlowFromFinancing'?: number; /** * * @type {number} * @memberof Financials */ 'netCashFlowFromInvesting'?: number; /** * * @type {number} * @memberof Financials */ 'netCashFlowFromOperations'?: number; /** * * @type {number} * @memberof Financials */ 'netCashFlowInvestmentAcquisitionsDisposals'?: number; /** * * @type {number} * @memberof Financials */ 'netIncome'?: number; /** * * @type {number} * @memberof Financials */ 'netIncomeCommonStock'?: number; /** * * @type {number} * @memberof Financials */ 'netIncomeCommonStockUSD'?: number; /** * * @type {number} * @memberof Financials */ 'netIncomeToNonControllingInterests'?: number; /** * * @type {number} * @memberof Financials */ 'netLossIncomeFromDiscontinuedOperations'?: number; /** * * @type {number} * @memberof Financials */ 'operatingExpenses'?: number; /** * * @type {number} * @memberof Financials */ 'operatingIncome'?: number; /** * * @type {number} * @memberof Financials */ 'paymentDividendsOtherCashDistributions'?: number; /** * * @type {number} * @memberof Financials */ 'payoutRatio'?: number; /** * Reporting period. * @type {string} * @memberof Financials */ 'period'?: FinancialsPeriodEnum; /** * * @type {number} * @memberof Financials */ 'preferredDividendsIncomeStatementImpact'?: number; /** * * @type {number} * @memberof Financials */ 'priceEarnings'?: number; /** * * @type {number} * @memberof Financials */ 'priceSales'?: number; /** * * @type {number} * @memberof Financials */ 'priceToBookValue'?: number; /** * * @type {number} * @memberof Financials */ 'priceToEarningsRatio'?: number; /** * * @type {number} * @memberof Financials */ 'priceToSalesRatio'?: number; /** * * @type {number} * @memberof Financials */ 'profitMargin'?: number; /** * * @type {number} * @memberof Financials */ 'propertyPlantEquipmentNet'?: number; /** * * @type {string} * @memberof Financials */ 'reportPeriod'?: string; /** * * @type {number} * @memberof Financials */ 'researchAndDevelopmentExpense'?: number; /** * * @type {number} * @memberof Financials */ 'returnOnAverageAssets'?: number; /** * * @type {number} * @memberof Financials */ 'returnOnAverageEquity'?: number; /** * * @type {number} * @memberof Financials */ 'returnOnInvestedCapital'?: number; /** * * @type {number} * @memberof Financials */ 'returnOnSales'?: number; /** * * @type {number} * @memberof Financials */ 'revenues'?: number; /** * * @type {number} * @memberof Financials */ 'revenuesUSD'?: number; /** * * @type {number} * @memberof Financials */ 'salesPerShare'?: number; /** * * @type {number} * @memberof Financials */ 'sellingGeneralAndAdministrativeExpense'?: number; /** * * @type {number} * @memberof Financials */ 'shareBasedCompensation'?: number; /** * * @type {number} * @memberof Financials */ 'shareFactor'?: number; /** * * @type {number} * @memberof Financials */ 'sharePriceAdjustedClose'?: number; /** * * @type {number} * @memberof Financials */ 'shareholdersEquity'?: number; /** * * @type {number} * @memberof Financials */ 'shareholdersEquityUSD'?: number; /** * * @type {number} * @memberof Financials */ 'shares'?: number; /** * * @type {number} * @memberof Financials */ 'tangibleAssetValue'?: number; /** * * @type {number} * @memberof Financials */ 'tangibleAssetsBookValuePerShare'?: number; /** * * @type {number} * @memberof Financials */ 'taxAssets'?: number; /** * * @type {number} * @memberof Financials */ 'taxLiabilities'?: number; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof Financials */ 'ticker': string; /** * * @type {number} * @memberof Financials */ 'totalLiabilities'?: number; /** * * @type {number} * @memberof Financials */ 'tradeAndNonTradePayables'?: number; /** * * @type {number} * @memberof Financials */ 'tradeAndNonTradeReceivables'?: number; /** * * @type {string} * @memberof Financials */ 'updated'?: string; /** * * @type {number} * @memberof Financials */ 'weightedAverageShares'?: number; /** * * @type {number} * @memberof Financials */ 'weightedAverageSharesDiluted'?: number; /** * * @type {number} * @memberof Financials */ 'workingCapital'?: number; } /** * @export * @enum {string} */ declare enum FinancialsPeriodEnum { Q = "Q", T = "T", Qa = "QA", Ta = "TA", Y = "Y", Ya = "YA" } /** * * @export * @interface ForexConversion */ interface ForexConversion { /** * The result of the conversion. * @type {number} * @memberof ForexConversion */ 'converted': number; /** * The \"from\" currency symbol. * @type {string} * @memberof ForexConversion */ 'from': string; /** * The amount to convert. * @type {number} * @memberof ForexConversion */ 'initialAmount': number; /** * * @type {ForexConversionLast} * @memberof ForexConversion */ 'last'?: ForexConversionLast; /** * The \"to\" currency symbol. * @type {string} * @memberof ForexConversion */ 'to': string; } /** * * @export * @interface ForexConversionLast */ interface ForexConversionLast { /** * The ask price. * @type {number} * @memberof ForexConversionLast */ 'ask': number; /** * The bid price. * @type {number} * @memberof ForexConversionLast */ 'bid': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof ForexConversionLast */ 'exchange': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof ForexConversionLast */ 'timestamp': number; } /** * * @export * @interface ForexGroupedResults */ interface ForexGroupedResults { /** * An array of results containing the requested data. * @type {Array} * @memberof ForexGroupedResults */ 'results'?: Array; } /** * * @export * @interface ForexHistoricTrades */ interface ForexHistoricTrades { /** * The date that was evaluated from the request. * @type {string} * @memberof ForexHistoricTrades */ 'day': string; /** * A map for shortened result keys. * @type {object} * @memberof ForexHistoricTrades */ 'map': object; /** * The milliseconds of latency for the query results. * @type {number} * @memberof ForexHistoricTrades */ 'msLatency': number; /** * The currency pair that was evaluated from the request. * @type {string} * @memberof ForexHistoricTrades */ 'pair': string; /** * * @type {Array} * @memberof ForexHistoricTrades */ 'ticks': Array; } /** * * @export * @interface ForexPairLastQuote */ interface ForexPairLastQuote { /** * * @type {ForexConversionLast} * @memberof ForexPairLastQuote */ 'last'?: ForexConversionLast; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof ForexPairLastQuote */ 'symbol': string; } /** * * @export * @interface ForexPreviousClose */ interface ForexPreviousClose { /** * An array of results containing the requested data. * @type {Array} * @memberof ForexPreviousClose */ 'results'?: Array; } /** * * @export * @interface ForexSnapshotLastQuote */ interface ForexSnapshotLastQuote { /** * The ask price. * @type {number} * @memberof ForexSnapshotLastQuote */ 'a': number; /** * The bid price. * @type {number} * @memberof ForexSnapshotLastQuote */ 'b': number; /** * The millisecond accuracy timestamp of the quote. * @type {number} * @memberof ForexSnapshotLastQuote */ 't': number; /** * The exchange ID on which this quote happened. * @type {number} * @memberof ForexSnapshotLastQuote */ 'x': number; } /** * * @export * @interface ForexSnapshotPrevDay */ interface ForexSnapshotPrevDay { /** * The close price for the symbol in the given time period. * @type {number} * @memberof ForexSnapshotPrevDay */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof ForexSnapshotPrevDay */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof ForexSnapshotPrevDay */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof ForexSnapshotPrevDay */ 'o': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof ForexSnapshotPrevDay */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof ForexSnapshotPrevDay */ 'vw': number; } /** * * @export * @interface ForexSnapshotTicker */ interface ForexSnapshotTicker { /** * * @type {GetForexSnapshotTicker200ResponseAllOfTicker} * @memberof ForexSnapshotTicker */ 'ticker'?: GetForexSnapshotTicker200ResponseAllOfTicker; } /** * * @export * @interface ForexSnapshotTickers */ interface ForexSnapshotTickers { /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof ForexSnapshotTickers */ 'tickers'?: Array; } /** * * @export * @interface ForexTickerResults */ interface ForexTickerResults { /** * An array of results containing the requested data. * @type {Array} * @memberof ForexTickerResults */ 'results'?: Array; } /** * * @export * @interface GetBenzingaV1AnalystInsights200Response */ interface GetBenzingaV1AnalystInsights200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1AnalystInsights200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1AnalystInsights200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1AnalystInsights200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1AnalystInsights200Response */ 'status': GetBenzingaV1AnalystInsights200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1AnalystInsights200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1AnalystInsights200ResponseResultsInner */ interface GetBenzingaV1AnalystInsights200ResponseResultsInner { /** * The identifer used by Benzinga for the firm record. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'benzinga_firm_id'?: string; /** * The identifer used by Benzinga for this record. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'benzinga_id'?: string; /** * The identifier used by Benzinga for the rating record. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'benzinga_rating_id'?: string; /** * The name of the company being rated. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'company_name'?: string; /** * The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'date'?: string; /** * The name of the research firm or investment bank issuing the rating. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'firm'?: string; /** * Narrative commentary or reasoning provided by the analyst or firm to explain the rating or price target. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'insight'?: string; /** * The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'last_updated'?: string; /** * The current price target set by the analyst. * @type {number} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'price_target'?: number; /** * The current rating set by the analyst. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'rating'?: string; /** * The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'rating_action'?: string; /** * The stock symbol of the company being rated. * @type {string} * @memberof GetBenzingaV1AnalystInsights200ResponseResultsInner */ 'ticker'?: string; } /** * * @export * @interface GetBenzingaV1AnalystInsights400Response */ interface GetBenzingaV1AnalystInsights400Response { /** * A message describing the source of the error. * @type {string} * @memberof GetBenzingaV1AnalystInsights400Response */ 'error': string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1AnalystInsights400Response */ 'request_id': string; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1AnalystInsights400Response */ 'status': GetBenzingaV1AnalystInsights400ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1AnalystInsights400ResponseStatusEnum { Error = "ERROR" } /** * * @export * @interface GetBenzingaV1Analysts200Response */ interface GetBenzingaV1Analysts200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1Analysts200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1Analysts200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1Analysts200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1Analysts200Response */ 'status': GetBenzingaV1Analysts200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1Analysts200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1Analysts200ResponseResultsInner */ interface GetBenzingaV1Analysts200ResponseResultsInner { /** * The unique identifier assigned by Benzinga to the research firm or investment bank. * @type {string} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'benzinga_firm_id'?: string; /** * The identifier used by Benzinga for this record. * @type {string} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'benzinga_id'?: string; /** * The name of the research firm or investment bank issuing the ratings. * @type {string} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'firm_name'?: string; /** * The full name of the analyst associated with the ratings. * @type {string} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'full_name'?: string; /** * The timestamp (formatted as an ISO 8601 timestamp) when the analyst record was last updated in the system. * @type {string} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'last_updated'?: string; /** * The average percent price difference per rating since the date of recommendation. * @type {number} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'overall_avg_return'?: number; /** * The analyst\'s percentile rank based on average return, relative to other analysts. * @type {number} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'overall_avg_return_percentile'?: number; /** * The percentage of gain/loss ratings that resulted in a gain overall. * @type {number} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'overall_success_rate'?: number; /** * A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate. * @type {number} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'smart_score'?: number; /** * The total number of ratings issued by the analyst included in the performance calculation. * @type {number} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'total_ratings'?: number; /** * The analyst\'s percentile rank based on the total number of ratings issued, relative to other analysts. * @type {number} * @memberof GetBenzingaV1Analysts200ResponseResultsInner */ 'total_ratings_percentile'?: number; } /** * * @export * @interface GetBenzingaV1ConsensusRatings200Response */ interface GetBenzingaV1ConsensusRatings200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1ConsensusRatings200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1ConsensusRatings200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1ConsensusRatings200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1ConsensusRatings200Response */ 'status': GetBenzingaV1ConsensusRatings200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1ConsensusRatings200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1ConsensusRatings200ResponseResultsInner */ interface GetBenzingaV1ConsensusRatings200ResponseResultsInner { /** * The count of \'Buy\' ratings from contributing analysts. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'buy_ratings': number; /** * The average price target across all analysts, rounded to 2 decimal places. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'consensus_price_target'?: number; /** * The overall rating category determined by the average consensus weight. Possible values: \'strong_buy\', \'buy\', \'hold\', \'sell\', \'strong_sell\'. * @type {string} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'consensus_rating'?: string; /** * The numerical average of all consensus weights, rounded to 2 decimal places. Scale ranges from 1 (Strong Sell) to 5 (Strong Buy). * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'consensus_rating_value'?: number; /** * The highest price target among all contributing analysts. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'high_price_target'?: number; /** * The count of \'Hold\' ratings from contributing analysts. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'hold_ratings': number; /** * The lowest price target among all contributing analysts. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'low_price_target'?: number; /** * The number of unique analysts contributing price targets. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'price_target_contributors': number; /** * The number of unique analysts contributing to the overall ratings consensus. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'ratings_contributors': number; /** * The count of \'Sell\' ratings from contributing analysts. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'sell_ratings': number; /** * The count of \'Strong Buy\' ratings from contributing analysts. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'strong_buy_ratings': number; /** * The count of \'Strong Sell\' ratings from contributing analysts. * @type {number} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'strong_sell_ratings': number; /** * The requested ticker. * @type {string} * @memberof GetBenzingaV1ConsensusRatings200ResponseResultsInner */ 'ticker'?: string; } /** * * @export * @interface GetBenzingaV1Earnings200Response */ interface GetBenzingaV1Earnings200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1Earnings200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1Earnings200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1Earnings200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1Earnings200Response */ 'status': GetBenzingaV1Earnings200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1Earnings200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1Earnings200ResponseResultsInner */ interface GetBenzingaV1Earnings200ResponseResultsInner { /** * The actual earnings per share (EPS) reported by the company for the given period. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'actual_eps'?: number; /** * The actual revenue reported by the company for the given fiscal period. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'actual_revenue'?: number; /** * The identifer used by Benzinga for this record. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'benzinga_id'?: string; /** * The name of the company releasing earnings. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'company_name'?: string; /** * The ISO 4217 currency code indicating the denomination in which the figures are reported. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'currency'?: string; /** * The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'date'?: string; /** * Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'date_status'?: string; /** * The methodology of the EPS figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles), ffo (Funds From Operations, a non-GAAP metric commonly used to assess the operating performance of REITs), and adj (adjusted, non-GAAP). * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'eps_method'?: string; /** * The difference between the actual and estimated EPS. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'eps_surprise'?: number; /** * The percentage difference between the actual and estimated EPS. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'eps_surprise_percent'?: number; /** * The analyst consensus estimate for earnings per share (EPS) for the given period. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'estimated_eps'?: number; /** * The analyst consensus estimate for the company\'s revenue in the given period. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'estimated_revenue'?: number; /** * The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'fiscal_period'?: string; /** * The fiscal year in which the earnings period falls. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'fiscal_year'?: number; /** * A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'importance'?: number; /** * The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'last_updated'?: string; /** * Additional context, commentary, or clarifying notes related to the earnings event. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'notes'?: string; /** * The company\'s reported earnings per share (EPS) for the previous comparable period. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'previous_eps'?: number; /** * The company\'s revenue for the previous comparable fiscal period. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'previous_revenue'?: number; /** * The methodology of the revenue figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles), adj (adjusted, non-GAAP figures that exclude certain items like one-time charges or divestitures), and rental (revenue specifically derived from rental operations, typically used by REITs, leasing companies, or businesses with a rental-based model). * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'revenue_method'?: string; /** * The difference between the actual and estimated revenue. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'revenue_surprise'?: number; /** * The percentage difference between the actual and estimated revenue. * @type {number} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'revenue_surprise_percent'?: number; /** * The stock symbol of the company reporting earnings. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'ticker'?: string; /** * The time (formatted as 24-hour HH:MM:SS UTC) when the earnings are scheduled or were reported. * @type {string} * @memberof GetBenzingaV1Earnings200ResponseResultsInner */ 'time'?: string; } /** * * @export * @interface GetBenzingaV1Firms200Response */ interface GetBenzingaV1Firms200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1Firms200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1Firms200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1Firms200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1Firms200Response */ 'status': GetBenzingaV1Firms200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1Firms200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1Firms200ResponseResultsInner */ interface GetBenzingaV1Firms200ResponseResultsInner { /** * The identifer used by Benzinga for this record. * @type {string} * @memberof GetBenzingaV1Firms200ResponseResultsInner */ 'benzinga_id'?: string; /** * Primary currency used by the financial firm, with some entries having null values. * @type {string} * @memberof GetBenzingaV1Firms200ResponseResultsInner */ 'currency'?: string; /** * Timestamp indicating when the firm\'s information was last modified or verified in the database. * @type {string} * @memberof GetBenzingaV1Firms200ResponseResultsInner */ 'last_updated'?: string; /** * The name of a research firm or investment bank which issues ratings. * @type {string} * @memberof GetBenzingaV1Firms200ResponseResultsInner */ 'name'?: string; } /** * * @export * @interface GetBenzingaV1Guidance200Response */ interface GetBenzingaV1Guidance200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1Guidance200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1Guidance200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1Guidance200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1Guidance200Response */ 'status': GetBenzingaV1Guidance200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1Guidance200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1Guidance200ResponseResultsInner */ interface GetBenzingaV1Guidance200ResponseResultsInner { /** * A unique identifier assigned by Benzinga to the guidance record. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'benzinga_id'?: string; /** * The name of the company issuing guidance. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'company_name'?: string; /** * The ISO 4217 code representing the currency in which the company issued its guidance figures. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'currency'?: string; /** * The calendar date (formatted as YYYY-MM-DD) when the guidance was issued. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'date'?: string; /** * The methodology of the EPS figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles), ffo (Funds From Operations, a non-GAAP metric commonly used to assess the operating performance of REITs), and adj (adjusted, non-GAAP). * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'eps_method'?: string; /** * The midpoint or central earnings per share (EPS) value the company expects for the given fiscal period. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'estimated_eps_guidance'?: number; /** * The midpoint or central revenue figure the company expects for the given fiscal period. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'estimated_revenue_guidance'?: number; /** * The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'fiscal_period'?: string; /** * The fiscal year corresponding to the period for which the guidance is issued. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'fiscal_year'?: number; /** * A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'importance'?: number; /** * The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'last_updated'?: string; /** * The highest EPS value the company expects for the fiscal period if a range was provided. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'max_eps_guidance'?: number; /** * The highest revenue figure the company expects for the fiscal period if a range was provided. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'max_revenue_guidance'?: number; /** * The lowest EPS value the company expects for the fiscal period if a range was provided. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'min_eps_guidance'?: number; /** * The lowest revenue figure the company expects for the fiscal period if a range was provided. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'min_revenue_guidance'?: number; /** * Additional descriptive text or commentary provided about the guidance record. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'notes'?: string; /** * Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are \'primary\' (the emphasized figure) and \'secondary\' (a supporting or alternate figure) * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'positioning'?: string; /** * The highest EPS value issued in a previous guidance record for the same fiscal period. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'previous_max_eps_guidance'?: number; /** * The highest revenue value issued in a previous guidance record for the same fiscal period. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'previous_max_revenue_guidance'?: number; /** * The lowest EPS value issued in a previous guidance record for the same fiscal period. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'previous_min_eps_guidance'?: number; /** * The lowest revenue value issued in a previous guidance record for the same fiscal period. * @type {number} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'previous_min_revenue_guidance'?: number; /** * Indicates whether the guidance was issued as part of a scheduled earnings release (\'official\') or as an unscheduled update (\'preliminary\'). * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'release_type'?: string; /** * The methodology of the revenue figure. Possible values are gaap (standardized financials under Generally Accepted Accounting Principles) and adj (adjusted, non-GAAP). * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'revenue_method'?: string; /** * The stock symbol of the company issuing guidance. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'ticker'?: string; /** * The time of day the guidance was announced, in HH:mm:ss format. * @type {string} * @memberof GetBenzingaV1Guidance200ResponseResultsInner */ 'time'?: string; } /** * * @export * @interface GetBenzingaV1News200Response */ interface GetBenzingaV1News200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1News200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1News200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1News200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1News200Response */ 'status': GetBenzingaV1News200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1News200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1News200ResponseResultsInner */ interface GetBenzingaV1News200ResponseResultsInner { /** * The name of the journalist or entity that authored the news article. * @type {string} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'author'?: string; /** * The identifer used by Benzinga for this record. * @type {number} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'benzinga_id'?: number; /** * The full text content of the news article. * @type {string} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'body'?: string; /** * A list of categories or topics that the article belongs to (e.g., \'News\', \'Price Target\'). * @type {Array} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'channels'?: Array; /** * A list of images associated with the article. * @type {Array} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'images'?: Array; /** * The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. * @type {string} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'last_updated'?: string; /** * The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. * @type {string} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'published'?: string; /** * A list of tags that describe the themes or content of the article. * @type {Array} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'tags'?: Array; /** * A short summary or lead-in to the news article\'s content. * @type {string} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'teaser'?: string; /** * A list of stock or crypto tickers mentioned in the article. * @type {Array} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'tickers'?: Array; /** * The headline of the news article. * @type {string} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'title'?: string; /** * The direct link to the source of the news article. * @type {string} * @memberof GetBenzingaV1News200ResponseResultsInner */ 'url'?: string; } /** * * @export * @interface GetBenzingaV1Ratings200Response */ interface GetBenzingaV1Ratings200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetBenzingaV1Ratings200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetBenzingaV1Ratings200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetBenzingaV1Ratings200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetBenzingaV1Ratings200Response */ 'status': GetBenzingaV1Ratings200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetBenzingaV1Ratings200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetBenzingaV1Ratings200ResponseResultsInner */ interface GetBenzingaV1Ratings200ResponseResultsInner { /** * The current price target adjusted for stock splits and dividends. * @type {number} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'adjusted_price_target'?: number; /** * The name of the individual analyst who issued the rating. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'analyst'?: string; /** * The identifer used by Benzinga for this analyst. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'benzinga_analyst_id'?: string; /** * A link to the Benzinga calendar page for this ticker * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'benzinga_calendar_url'?: string; /** * The identifer used by Benzinga for this firm. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'benzinga_firm_id'?: string; /** * The identifer used by Benzinga for this record. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'benzinga_id'?: string; /** * A link to the Benzinga articles page for this ticker * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'benzinga_news_url'?: string; /** * The name of the company being rated. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'company_name'?: string; /** * The ISO 4217 currency code in which the price target is denominated. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'currency'?: string; /** * The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'date'?: string; /** * The name of the research firm or investment bank issuing the rating. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'firm'?: string; /** * A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). * @type {number} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'importance'?: number; /** * The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'last_updated'?: string; /** * Additional context or commentary. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'notes'?: string; /** * The previous price target adjusted for stock splits and dividends. * @type {number} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'previous_adjusted_price_target'?: number; /** * The previous price target set by the analyst. * @type {number} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'previous_price_target'?: number; /** * The previous rating set by the analyst. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'previous_rating'?: string; /** * The percentage change in price target if price target and previous price target exists * @type {number} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'price_percent_change'?: number; /** * The current price target set by the analyst. * @type {number} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'price_target'?: number; /** * The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'price_target_action'?: string; /** * The current rating set by the analyst. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'rating'?: string; /** * The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'rating_action'?: string; /** * The stock symbol of the company being rated. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'ticker'?: string; /** * The time (formatted as 24-hour HH:MM:SS UTC) when the rating was issued. * @type {string} * @memberof GetBenzingaV1Ratings200ResponseResultsInner */ 'time'?: string; } /** * * @export * @interface GetCryptoAggregates200Response */ interface GetCryptoAggregates200Response { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetCryptoAggregates200Response */ 'ticker': string; /** * Whether or not this response was adjusted for splits. * @type {boolean} * @memberof GetCryptoAggregates200Response */ 'adjusted': boolean; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof GetCryptoAggregates200Response */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof GetCryptoAggregates200Response */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof GetCryptoAggregates200Response */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoAggregates200Response */ 'status': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetCryptoAggregates200Response */ 'results'?: Array; } /** * * @export * @interface GetCryptoAggregates200ResponseAllOfResultsInner */ interface GetCryptoAggregates200ResponseAllOfResultsInner { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 'n'?: number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 'o': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetCryptoAggregates200ResponseAllOfResultsInner */ 'vw'?: number; } /** * * @export * @interface GetCryptoEMA200Response */ interface GetCryptoEMA200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetCryptoEMA200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetCryptoEMA200Response */ 'request_id'?: string; /** * * @type {GetCryptoEMA200ResponseResults} * @memberof GetCryptoEMA200Response */ 'results'?: GetCryptoEMA200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoEMA200Response */ 'status'?: string; } /** * * @export * @interface GetCryptoEMA200ResponseResults */ interface GetCryptoEMA200ResponseResults { /** * * @type {GetCryptoEMA200ResponseResultsUnderlying} * @memberof GetCryptoEMA200ResponseResults */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** * * @type {Array} * @memberof GetCryptoEMA200ResponseResults */ 'values'?: Array; } /** * * @export * @interface GetCryptoEMA200ResponseResultsUnderlying */ interface GetCryptoEMA200ResponseResultsUnderlying { /** * * @type {Array} * @memberof GetCryptoEMA200ResponseResultsUnderlying */ 'aggregates'?: Array; /** * The URL which can be used to request the underlying aggregates used in this request. * @type {string} * @memberof GetCryptoEMA200ResponseResultsUnderlying */ 'url'?: string; } /** * * @export * @interface GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ interface GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'n': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'otc'?: boolean; /** * The Unix Msec timestamp for the start of the aggregate window. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner */ 'vw': number; } /** * * @export * @interface GetCryptoEMA200ResponseResultsValuesInner */ interface GetCryptoEMA200ResponseResultsValuesInner { /** * The Unix Msec timestamp from the last aggregate used in this calculation. * @type {number} * @memberof GetCryptoEMA200ResponseResultsValuesInner */ 'timestamp'?: number; /** * The indicator value for this period. * @type {number} * @memberof GetCryptoEMA200ResponseResultsValuesInner */ 'value'?: number; } /** * * @export * @interface GetCryptoMACD200Response */ interface GetCryptoMACD200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetCryptoMACD200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetCryptoMACD200Response */ 'request_id'?: string; /** * * @type {GetCryptoMACD200ResponseResults} * @memberof GetCryptoMACD200Response */ 'results'?: GetCryptoMACD200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoMACD200Response */ 'status'?: string; } /** * * @export * @interface GetCryptoMACD200ResponseResults */ interface GetCryptoMACD200ResponseResults { /** * * @type {GetCryptoEMA200ResponseResultsUnderlying} * @memberof GetCryptoMACD200ResponseResults */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** * * @type {Array} * @memberof GetCryptoMACD200ResponseResults */ 'values'?: Array; } /** * * @export * @interface GetCryptoMACD200ResponseResultsValuesInner */ interface GetCryptoMACD200ResponseResultsValuesInner { /** * The indicator value for this period. * @type {number} * @memberof GetCryptoMACD200ResponseResultsValuesInner */ 'histogram'?: number; /** * The indicator value for this period. * @type {number} * @memberof GetCryptoMACD200ResponseResultsValuesInner */ 'signal'?: number; /** * The Unix Msec timestamp from the last aggregate used in this calculation. * @type {number} * @memberof GetCryptoMACD200ResponseResultsValuesInner */ 'timestamp'?: number; /** * The indicator value for this period. * @type {number} * @memberof GetCryptoMACD200ResponseResultsValuesInner */ 'value'?: number; } /** * * @export * @interface GetCryptoOpenClose200Response */ interface GetCryptoOpenClose200Response { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetCryptoOpenClose200Response */ 'close': number; /** * An array of results containing the requested data. * @type {Array} * @memberof GetCryptoOpenClose200Response */ 'closingTrades': Array; /** * The date requested. * @type {string} * @memberof GetCryptoOpenClose200Response */ 'day': string; /** * Whether or not the timestamps are in UTC timezone. * @type {boolean} * @memberof GetCryptoOpenClose200Response */ 'isUTC': boolean; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetCryptoOpenClose200Response */ 'open': number; /** * An array of results containing the requested data. * @type {Array} * @memberof GetCryptoOpenClose200Response */ 'openTrades': Array; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof GetCryptoOpenClose200Response */ 'symbol': string; } /** * * @export * @interface GetCryptoRSI200Response */ interface GetCryptoRSI200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetCryptoRSI200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetCryptoRSI200Response */ 'request_id'?: string; /** * * @type {GetCryptoRSI200ResponseResults} * @memberof GetCryptoRSI200Response */ 'results'?: GetCryptoRSI200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoRSI200Response */ 'status'?: string; } /** * * @export * @interface GetCryptoRSI200ResponseResults */ interface GetCryptoRSI200ResponseResults { /** * * @type {GetCryptoEMA200ResponseResultsUnderlying} * @memberof GetCryptoRSI200ResponseResults */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** * * @type {Array} * @memberof GetCryptoRSI200ResponseResults */ 'values'?: Array; } /** * * @export * @interface GetCryptoSMA200Response */ interface GetCryptoSMA200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetCryptoSMA200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetCryptoSMA200Response */ 'request_id'?: string; /** * * @type {GetCryptoSMA200ResponseResults} * @memberof GetCryptoSMA200Response */ 'results'?: GetCryptoSMA200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoSMA200Response */ 'status'?: string; } /** * * @export * @interface GetCryptoSMA200ResponseResults */ interface GetCryptoSMA200ResponseResults { /** * * @type {GetCryptoEMA200ResponseResultsUnderlying} * @memberof GetCryptoSMA200ResponseResults */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** * * @type {Array} * @memberof GetCryptoSMA200ResponseResults */ 'values'?: Array; } /** * * @export * @interface GetCryptoSnapshotDirection200Response */ interface GetCryptoSnapshotDirection200Response { /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof GetCryptoSnapshotDirection200Response */ 'tickers'?: Array; } /** * * @export * @interface GetCryptoSnapshotTicker200Response */ interface GetCryptoSnapshotTicker200Response { /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoSnapshotTicker200Response */ 'status': string; /** * A request id assigned by the server. * @type {string} * @memberof GetCryptoSnapshotTicker200Response */ 'request_id': string; /** * * @type {GetCryptoSnapshotTicker200ResponseAllOfTicker} * @memberof GetCryptoSnapshotTicker200Response */ 'ticker'?: GetCryptoSnapshotTicker200ResponseAllOfTicker; } /** * Contains the requested snapshot data for the specified ticker. * @export * @interface GetCryptoSnapshotTicker200ResponseAllOfTicker */ interface GetCryptoSnapshotTicker200ResponseAllOfTicker { /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'day': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay; /** * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'fmv'?: number; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'lastTrade': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'min': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'ticker': string; /** * The value of the change from the previous day. * @type {number} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'todaysChange': number; /** * The percentage change since the previous day. * @type {number} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'todaysChangePerc': number; /** * The last updated timestamp. * @type {number} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ 'updated': number; } /** * * @export * @interface GetCryptoSnapshotTickers200Response */ interface GetCryptoSnapshotTickers200Response { /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoSnapshotTickers200Response */ 'status': string; /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof GetCryptoSnapshotTickers200Response */ 'tickers'?: Array; } /** * * @export * @interface GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ interface GetCryptoSnapshotTickers200ResponseAllOfTickersInner { /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'day': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay; /** * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'fmv'?: number; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'lastTrade': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'min': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'ticker': string; /** * The value of the change from the previous day. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'todaysChange': number; /** * The percentage change since the previous day. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'todaysChangePerc': number; /** * The last updated timestamp. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ 'updated': number; } /** * The most recent daily bar for this ticker. * @export * @interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay */ interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay */ 'o': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay */ 'vw': number; } /** * The most recent trade for this ticker. * @export * @interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade { /** * The trade conditions. * @type {Array} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'c': Array; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'i': string; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'p': number; /** * The size (volume) of the trade. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 's': number; /** * The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 't': number; /** * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'x': number; } /** * The most recent minute bar for this ticker. * @export * @interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 'n': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 'o': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin */ 'vw': number; } /** * The previous day\'s bar for this ticker. * @export * @interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'o': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'vw': number; } /** * * @export * @interface GetCryptoTrades200Response */ interface GetCryptoTrades200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetCryptoTrades200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetCryptoTrades200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetCryptoTrades200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoTrades200Response */ 'status': string; } /** * * @export * @interface GetCryptoTrades200ResponseResultsInner */ interface GetCryptoTrades200ResponseResultsInner { /** * A list of condition codes. * @type {Array} * @memberof GetCryptoTrades200ResponseResultsInner */ 'conditions'?: Array; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetCryptoTrades200ResponseResultsInner */ 'exchange': number; /** * The Trade ID which uniquely identifies a trade on the exchange that the trade happened on. * @type {string} * @memberof GetCryptoTrades200ResponseResultsInner */ 'id'?: string; /** * The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange. * @type {number} * @memberof GetCryptoTrades200ResponseResultsInner */ 'participant_timestamp'?: number; /** * The price of the trade in the base currency of the crypto pair. * @type {number} * @memberof GetCryptoTrades200ResponseResultsInner */ 'price': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof GetCryptoTrades200ResponseResultsInner */ 'size': number; } /** * * @export * @interface GetCurrencyConversion200Response */ interface GetCurrencyConversion200Response { /** * The result of the conversion. * @type {number} * @memberof GetCurrencyConversion200Response */ 'converted': number; /** * The \"from\" currency symbol. * @type {string} * @memberof GetCurrencyConversion200Response */ 'from': string; /** * The amount to convert. * @type {number} * @memberof GetCurrencyConversion200Response */ 'initialAmount': number; /** * * @type {GetCurrencyConversion200ResponseLast} * @memberof GetCurrencyConversion200Response */ 'last'?: GetCurrencyConversion200ResponseLast; /** * A request id assigned by the server. * @type {string} * @memberof GetCurrencyConversion200Response */ 'request_id': string; /** * The status of this request\'s response. * @type {string} * @memberof GetCurrencyConversion200Response */ 'status': string; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof GetCurrencyConversion200Response */ 'symbol': string; /** * The \"to\" currency symbol. * @type {string} * @memberof GetCurrencyConversion200Response */ 'to': string; } /** * Contains the requested quote data for the specified forex currency pair. * @export * @interface GetCurrencyConversion200ResponseLast */ interface GetCurrencyConversion200ResponseLast { /** * The ask price. * @type {number} * @memberof GetCurrencyConversion200ResponseLast */ 'ask': number; /** * The bid price. * @type {number} * @memberof GetCurrencyConversion200ResponseLast */ 'bid': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetCurrencyConversion200ResponseLast */ 'exchange': number; /** * The Unix millisecond timestamp. * @type {number} * @memberof GetCurrencyConversion200ResponseLast */ 'timestamp': number; } /** * * @export * @interface GetEvents200Response */ interface GetEvents200Response { /** * A request id assigned by the server. * @type {string} * @memberof GetEvents200Response */ 'request_id'?: string; /** * * @type {GetEvents200ResponseResults} * @memberof GetEvents200Response */ 'results'?: GetEvents200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetEvents200Response */ 'status'?: string; } /** * Contains the requested event data for the specified ticker. * @export * @interface GetEvents200ResponseResults */ interface GetEvents200ResponseResults { /** * An array of event containing the requested data. * @type {Array} * @memberof GetEvents200ResponseResults */ 'events'?: Array; /** * The name of the asset. * @type {string} * @memberof GetEvents200ResponseResults */ 'name'?: string; } /** * @type GetEvents200ResponseResultsEventsInner * @export */ declare type GetEvents200ResponseResultsEventsInner = GetEvents200ResponseResultsEventsInnerOneOf; /** * * @export * @interface GetEvents200ResponseResultsEventsInnerOneOf */ interface GetEvents200ResponseResultsEventsInnerOneOf { /** * The date the event took place * @type {string} * @memberof GetEvents200ResponseResultsEventsInnerOneOf */ 'date': string; /** * The type of historical event for the asset * @type {string} * @memberof GetEvents200ResponseResultsEventsInnerOneOf */ 'event_type': string; /** * * @type {GetEvents200ResponseResultsEventsInnerOneOfTickerChange} * @memberof GetEvents200ResponseResultsEventsInnerOneOf */ 'ticker_change'?: GetEvents200ResponseResultsEventsInnerOneOfTickerChange; } /** * Details about a ticker change * @export * @interface GetEvents200ResponseResultsEventsInnerOneOfTickerChange */ interface GetEvents200ResponseResultsEventsInnerOneOfTickerChange { /** * A ticker symbol * @type {string} * @memberof GetEvents200ResponseResultsEventsInnerOneOfTickerChange */ 'ticker'?: string; } /** * * @export * @interface GetFedV1Inflation200Response */ interface GetFedV1Inflation200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetFedV1Inflation200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetFedV1Inflation200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetFedV1Inflation200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFedV1Inflation200Response */ 'status': GetFedV1Inflation200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetFedV1Inflation200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetFedV1Inflation200ResponseResultsInner */ interface GetFedV1Inflation200ResponseResultsInner { /** * Consumer Price Index (CPI) for All Urban Consumers — a standard measure of headline inflation based on a fixed basket of goods and services, not seasonally adjusted. * @type {number} * @memberof GetFedV1Inflation200ResponseResultsInner */ 'cpi'?: number; /** * Core Consumer Price Index — the CPI excluding food and energy, used to understand underlying inflation trends without short-term volatility. * @type {number} * @memberof GetFedV1Inflation200ResponseResultsInner */ 'cpi_core'?: number; /** * Year-over-year percentage change in the headline CPI — the most commonly cited inflation rate in public discourse and economic policy. * @type {number} * @memberof GetFedV1Inflation200ResponseResultsInner */ 'cpi_year_over_year'?: number; /** * Calendar date of the observation (YYYY‑MM‑DD). * @type {string} * @memberof GetFedV1Inflation200ResponseResultsInner */ 'date'?: string; /** * Personal Consumption Expenditures (PCE) Price Index — a broader measure of inflation used by the Federal Reserve, reflecting actual consumer spending patterns and updated basket weights. * @type {number} * @memberof GetFedV1Inflation200ResponseResultsInner */ 'pce'?: number; /** * Core PCE Price Index — excludes food and energy prices from the PCE index, and is the Fed\'s preferred measure of underlying inflation. * @type {number} * @memberof GetFedV1Inflation200ResponseResultsInner */ 'pce_core'?: number; /** * Nominal Personal Consumption Expenditures — total dollar value of consumer spending in the U.S. economy, reported in billions of dollars and not adjusted for inflation. * @type {number} * @memberof GetFedV1Inflation200ResponseResultsInner */ 'pce_spending'?: number; } /** * * @export * @interface GetFedV1InflationExpectations200Response */ interface GetFedV1InflationExpectations200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetFedV1InflationExpectations200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetFedV1InflationExpectations200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetFedV1InflationExpectations200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFedV1InflationExpectations200Response */ 'status': GetFedV1InflationExpectations200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetFedV1InflationExpectations200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetFedV1InflationExpectations200ResponseResultsInner */ interface GetFedV1InflationExpectations200ResponseResultsInner { /** * Calendar date of the observation (YYYY‑MM‑DD). * @type {string} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'date'?: string; /** * 5-Year, 5-Year Forward Inflation Expectation Rate — the market\'s expectation of average annual inflation for the 5-year period beginning 5 years from now, based on the spread between forward nominal and real yields. * @type {number} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'forward_years_5_to_10'?: number; /** * 10-Year Breakeven Inflation Rate — the market\'s expectation of average annual inflation over the next 10 years, based on the spread between 10-year nominal Treasury yields and 10-year TIPS yields. * @type {number} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'market_10_year'?: number; /** * 5-Year Breakeven Inflation Rate — the market\'s expectation of average annual inflation over the next 5 years, based on the spread between 5-year nominal Treasury yields and 5-year TIPS yields. * @type {number} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'market_5_year'?: number; /** * The Cleveland Fed’s 10-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'model_10_year'?: number; /** * The Cleveland Fed’s 1-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'model_1_year'?: number; /** * The Cleveland Fed’s 30-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'model_30_year'?: number; /** * The Cleveland Fed’s 5-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ 'model_5_year'?: number; } /** * * @export * @interface GetFedV1TreasuryYields200Response */ interface GetFedV1TreasuryYields200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetFedV1TreasuryYields200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetFedV1TreasuryYields200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetFedV1TreasuryYields200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFedV1TreasuryYields200Response */ 'status': GetFedV1TreasuryYields200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetFedV1TreasuryYields200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetFedV1TreasuryYields200ResponseResultsInner */ interface GetFedV1TreasuryYields200ResponseResultsInner { /** * Calendar date of the yield observation (YYYY-MM-DD). * @type {string} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'date'?: string; /** * Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_10_year'?: number; /** * Market Yield on U.S. Treasury Securities at 1-Month Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_1_month'?: number; /** * Market Yield on U.S. Treasury Securities at 1-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_1_year'?: number; /** * Market Yield on U.S. Treasury Securities at 20-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_20_year'?: number; /** * Market Yield on U.S. Treasury Securities at 2-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_2_year'?: number; /** * Market Yield on U.S. Treasury Securities at 30-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_30_year'?: number; /** * Market Yield on U.S. Treasury Securities at 3-Month Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_3_month'?: number; /** * Market Yield on U.S. Treasury Securities at 3-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_3_year'?: number; /** * Market Yield on U.S. Treasury Securities at 5-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_5_year'?: number; /** * Market Yield on U.S. Treasury Securities at 6-Month Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_6_month'?: number; /** * Market Yield on U.S. Treasury Securities at 7-Year Constant Maturity, Quoted on an Investment Basis * @type {number} * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ 'yield_7_year'?: number; } /** * * @export * @interface GetForexQuotes200Response */ interface GetForexQuotes200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetForexQuotes200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetForexQuotes200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetForexQuotes200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetForexQuotes200Response */ 'status': string; } /** * * @export * @interface GetForexQuotes200ResponseResultsInner */ interface GetForexQuotes200ResponseResultsInner { /** * The ask exchange ID * @type {number} * @memberof GetForexQuotes200ResponseResultsInner */ 'ask_exchange'?: number; /** * The ask price. * @type {number} * @memberof GetForexQuotes200ResponseResultsInner */ 'ask_price'?: number; /** * The bid exchange ID * @type {number} * @memberof GetForexQuotes200ResponseResultsInner */ 'bid_exchange'?: number; /** * The bid price. * @type {number} * @memberof GetForexQuotes200ResponseResultsInner */ 'bid_price'?: number; /** * The nanosecond Exchange Unix Timestamp. This is the timestamp of when the quote was generated at the exchange. * @type {number} * @memberof GetForexQuotes200ResponseResultsInner */ 'participant_timestamp': number; } /** * * @export * @interface GetForexSnapshotTicker200Response */ interface GetForexSnapshotTicker200Response { /** * The status of this request\'s response. * @type {string} * @memberof GetForexSnapshotTicker200Response */ 'status': string; /** * A request id assigned by the server. * @type {string} * @memberof GetForexSnapshotTicker200Response */ 'request_id': string; /** * * @type {GetForexSnapshotTicker200ResponseAllOfTicker} * @memberof GetForexSnapshotTicker200Response */ 'ticker'?: GetForexSnapshotTicker200ResponseAllOfTicker; } /** * Contains the requested snapshot data for the specified ticker. * @export * @interface GetForexSnapshotTicker200ResponseAllOfTicker */ interface GetForexSnapshotTicker200ResponseAllOfTicker { /** * * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerDay} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'day': GetForexSnapshotTickers200ResponseAllOfTickersInnerDay; /** * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'fmv'?: number; /** * * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'lastQuote': GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote; /** * * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerMin} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'min': GetForexSnapshotTickers200ResponseAllOfTickersInnerMin; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'ticker': string; /** * The value of the change from the previous day. * @type {number} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'todaysChange': number; /** * The percentage change since the previous day. * @type {number} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'todaysChangePerc': number; /** * The last updated timestamp. * @type {number} * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ 'updated': number; } /** * * @export * @interface GetForexSnapshotTickers200Response */ interface GetForexSnapshotTickers200Response { /** * The status of this request\'s response. * @type {string} * @memberof GetForexSnapshotTickers200Response */ 'status': string; /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof GetForexSnapshotTickers200Response */ 'tickers'?: Array; } /** * * @export * @interface GetForexSnapshotTickers200ResponseAllOfTickersInner */ interface GetForexSnapshotTickers200ResponseAllOfTickersInner { /** * * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerDay} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'day': GetForexSnapshotTickers200ResponseAllOfTickersInnerDay; /** * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'fmv'?: number; /** * * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'lastQuote': GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote; /** * * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerMin} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'min': GetForexSnapshotTickers200ResponseAllOfTickersInnerMin; /** * * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'ticker': string; /** * The value of the change from the previous day. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'todaysChange': number; /** * The percentage change since the previous day. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'todaysChangePerc': number; /** * The last updated timestamp. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ 'updated': number; } /** * The most recent daily bar for this ticker. * @export * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ interface GetForexSnapshotTickers200ResponseAllOfTickersInnerDay { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ 'o': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ 'v': number; } /** * The most recent quote for this ticker. * @export * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ interface GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote { /** * The ask price. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 'a': number; /** * The bid price. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 'b': number; /** * The millisecond accuracy timestamp of the quote. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 't': number; /** * The exchange ID on which this quote happened. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 'x': number; } /** * The most recent minute bar for this ticker. * @export * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ interface GetForexSnapshotTickers200ResponseAllOfTickersInnerMin { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ 'c'?: number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ 'h'?: number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ 'l'?: number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ 'n'?: number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ 'o'?: number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ 't'?: number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ 'v'?: number; } /** * * @export * @interface GetFuturesAggregates200Response */ interface GetFuturesAggregates200Response { /** * If present, the URL to the next page of results. * @type {string} * @memberof GetFuturesAggregates200Response */ 'next_url'?: string; /** * * @type {Array} * @memberof GetFuturesAggregates200Response */ 'results'?: Array; /** * The status of the response. * @type {string} * @memberof GetFuturesAggregates200Response */ 'status'?: string; } /** * * @export * @interface GetFuturesAggregates200ResponseResultsInner */ interface GetFuturesAggregates200ResponseResultsInner { /** * The last price within the timeframe. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'close'?: number; /** * The total dollar volume of the transactions that occurred within the timeframe. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'dollar_volume'?: number; /** * The highest price within the timeframe. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'high'?: number; /** * The lowest price within the timeframe. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'low'?: number; /** * The opening price within the timeframe. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'open'?: number; /** * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @type {string} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'session_end_date'?: string; /** * The price the contract would have cost to settle for this session. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'settlement_price'?: number; /** * The ticker for the contract. * @type {string} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'ticker'?: string; /** * The number of transactions that occurred within the timeframe. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'transaction_count'?: number; /** * The number of contracts that traded within the timeframe. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'volume'?: number; /** * The timestamp of the beginning of the candlestick’s aggregation window. * @type {number} * @memberof GetFuturesAggregates200ResponseResultsInner */ 'window_start'?: number; } /** * * @export * @interface GetFuturesContractDetails200Response */ interface GetFuturesContractDetails200Response { /** * A unique identifier for this request. * @type {string} * @memberof GetFuturesContractDetails200Response */ 'request_id'?: string; /** * * @type {GetFuturesContracts200ResponseResultsInner} * @memberof GetFuturesContractDetails200Response */ 'results'?: GetFuturesContracts200ResponseResultsInner; /** * The status of this request\'s response. * @type {string} * @memberof GetFuturesContractDetails200Response */ 'status'?: string; } /** * * @export * @interface GetFuturesContracts200Response */ interface GetFuturesContracts200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetFuturesContracts200Response */ 'next_url'?: string; /** * A unique identifier for this request. * @type {string} * @memberof GetFuturesContracts200Response */ 'request_id'?: string; /** * * @type {Array} * @memberof GetFuturesContracts200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFuturesContracts200Response */ 'status'?: string; } /** * * @export * @interface GetFuturesContracts200ResponseResultsInner */ interface GetFuturesContracts200ResponseResultsInner { /** * Whether or not this contract was tradeable at the given point-in-time specified in the \'as_of\' attribute (a contract was active if the given day was after the \'first_trade_date\' and before the \'last_trade_date\'). * @type {boolean} * @memberof GetFuturesContracts200ResponseResultsInner */ 'active'?: boolean; /** * The point-in-time date for the given contract - e.g. if \'as_of\' is set to 2021-04-25, then the data retrieved describes the contract(s) as of 2021-04-25. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'as_of'?: string; /** * The number of days until this contract matures (since the point-in-time date). Note that the absence of this field means there are 0 days until maturity. * @type {number} * @memberof GetFuturesContracts200ResponseResultsInner */ 'days_to_maturity'?: number; /** * The date on which this contract first became tradeable. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'first_trade_date'?: string; /** * The date on which this contract last became tradeable. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'last_trade_date'?: string; /** * This field provides the calendar month reflected in the instrument symbol. For futures spreads and options spreads, this field contains the first leg\'s calendar month reflected in the instrument symbol. For daily products, this tag contains the full calendar date (YYYYMMDD) as reflected in the instrument symbol. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'maturity'?: string; /** * The maximum order quantity for this contract. * @type {number} * @memberof GetFuturesContracts200ResponseResultsInner */ 'max_order_quantity'?: number; /** * The minimum order quantity for this contract. * @type {number} * @memberof GetFuturesContracts200ResponseResultsInner */ 'min_order_quantity'?: number; /** * The name of the contract. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'name'?: string; /** * The unique identifier for the product to which this contract belongs. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'product_code': string; /** * The final settlement date for the contract. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'settlement_date'?: string; /** * The settlement tick size for this contract. * @type {number} * @memberof GetFuturesContracts200ResponseResultsInner */ 'settlement_tick_size'?: number; /** * The spread tick size for this contract. * @type {number} * @memberof GetFuturesContracts200ResponseResultsInner */ 'spread_tick_size'?: number; /** * The unique identifier for the contract, typically consisting of the product code and expiration date. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'ticker': string; /** * The tick size for this contract. * @type {number} * @memberof GetFuturesContracts200ResponseResultsInner */ 'trade_tick_size'?: number; /** * The trading venue (MIC) for the exchange on which this contract trades. * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'trading_venue': string; /** * The type of contract, one of \"single\" or \"combo\". * @type {string} * @memberof GetFuturesContracts200ResponseResultsInner */ 'type': string; } /** * * @export * @interface GetFuturesDailySchedules200Response */ interface GetFuturesDailySchedules200Response { /** * The URL for the next page of results. * @type {string} * @memberof GetFuturesDailySchedules200Response */ 'next_url'?: string; /** * The unique identifier for this request. * @type {string} * @memberof GetFuturesDailySchedules200Response */ 'request_id'?: string; /** * A list of schedules for each product. * @type {Array} * @memberof GetFuturesDailySchedules200Response */ 'results'?: Array; /** * The status of the response. * @type {string} * @memberof GetFuturesDailySchedules200Response */ 'status'?: string; } /** * * @export * @interface GetFuturesMarketStatuses200Response */ interface GetFuturesMarketStatuses200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetFuturesMarketStatuses200Response */ 'next_url'?: string; /** * A unique identifier for this request. * @type {string} * @memberof GetFuturesMarketStatuses200Response */ 'request_id'?: string; /** * * @type {Array} * @memberof GetFuturesMarketStatuses200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFuturesMarketStatuses200Response */ 'status'?: string; /** * An RFC3339 timestamp representing the moment at which the market statuses were evaluated. * @type {string} * @memberof GetFuturesMarketStatuses200Response */ 'timestamp'?: string; } /** * * @export * @interface GetFuturesMarketStatuses200ResponseResultsInner */ interface GetFuturesMarketStatuses200ResponseResultsInner { /** * The current status of the market. * @type {string} * @memberof GetFuturesMarketStatuses200ResponseResultsInner */ 'market_status': GetFuturesMarketStatuses200ResponseResultsInnerMarketStatusEnum; /** * The product code for the product. * @type {string} * @memberof GetFuturesMarketStatuses200ResponseResultsInner */ 'product_code': string; /** * The trading venue (MIC) for the exchange on which the corresponding product trades. * @type {string} * @memberof GetFuturesMarketStatuses200ResponseResultsInner */ 'trading_venue'?: string; } /** * @export * @enum {string} */ declare enum GetFuturesMarketStatuses200ResponseResultsInnerMarketStatusEnum { PreOpen = "pre_open", Open = "open", Close = "close", Pause = "pause", PostClosePreOpen = "post_close_pre_open" } /** * * @export * @interface GetFuturesProductDetails200Response */ interface GetFuturesProductDetails200Response { /** * A unique identifier for this request. * @type {string} * @memberof GetFuturesProductDetails200Response */ 'request_id'?: string; /** * * @type {GetFuturesProducts200ResponseResultsInner} * @memberof GetFuturesProductDetails200Response */ 'results'?: GetFuturesProducts200ResponseResultsInner; /** * The status of this request\'s response. * @type {string} * @memberof GetFuturesProductDetails200Response */ 'status'?: string; } /** * * @export * @interface GetFuturesProductSchedules200Response */ interface GetFuturesProductSchedules200Response { /** * An optional error message for failed requests when available. * @type {string} * @memberof GetFuturesProductSchedules200Response */ 'error'?: string; /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetFuturesProductSchedules200Response */ 'next_url'?: string; /** * The unique identifier for the request. * @type {string} * @memberof GetFuturesProductSchedules200Response */ 'request_id'?: string; /** * The list of schedules for the specified product. * @type {Array} * @memberof GetFuturesProductSchedules200Response */ 'results'?: Array; /** * The status of the response. * @type {string} * @memberof GetFuturesProductSchedules200Response */ 'status'?: string; } /** * * @export * @interface GetFuturesProductSchedules200ResponseResultsInner */ interface GetFuturesProductSchedules200ResponseResultsInner { /** * The product code for the futures product to which this schedule applies. * @type {string} * @memberof GetFuturesProductSchedules200ResponseResultsInner */ 'product_code'?: string; /** * The name of the futures product to which this schedule applies. * @type {string} * @memberof GetFuturesProductSchedules200ResponseResultsInner */ 'product_name'?: string; /** * * @type {Array} * @memberof GetFuturesProductSchedules200ResponseResultsInner */ 'schedule'?: Array; /** * The date on which the schedule\'s trading day ended (sometimes referred to as trading date) formatted as `YYYY-MM-DD`. Note that although there is no time component on this attribute, the day refers to Central Time. * @type {string} * @memberof GetFuturesProductSchedules200ResponseResultsInner */ 'session_end_date'?: string; /** * The trading venue (MIC) for the exchange on which this schedule\'s product trades. * @type {string} * @memberof GetFuturesProductSchedules200ResponseResultsInner */ 'trading_venue'?: string; } /** * * @export * @interface GetFuturesProductSchedules200ResponseResultsInnerScheduleInner */ interface GetFuturesProductSchedules200ResponseResultsInnerScheduleInner { /** * The market event for this schedule. * @type {string} * @memberof GetFuturesProductSchedules200ResponseResultsInnerScheduleInner */ 'event'?: GetFuturesProductSchedules200ResponseResultsInnerScheduleInnerEventEnum; /** * The timestamp for this market event in Central Time. * @type {string} * @memberof GetFuturesProductSchedules200ResponseResultsInnerScheduleInner */ 'timestamp'?: string; } /** * @export * @enum {string} */ declare enum GetFuturesProductSchedules200ResponseResultsInnerScheduleInnerEventEnum { PreOpen = "pre_open", Open = "open", Close = "close", Pause = "pause", PostClosePreOpen = "post_close_pre_open" } /** * * @export * @interface GetFuturesProducts200Response */ interface GetFuturesProducts200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetFuturesProducts200Response */ 'next_url'?: string; /** * A unique identifier for this request. * @type {string} * @memberof GetFuturesProducts200Response */ 'request_id'?: string; /** * * @type {Array} * @memberof GetFuturesProducts200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFuturesProducts200Response */ 'status'?: string; } /** * * @export * @interface GetFuturesProducts200ResponseResultsInner */ interface GetFuturesProducts200ResponseResultsInner { /** * The point-in-time date for the given product - e.g. if \'as_of\' is set to 2024-11-05, then these were the details for this product on that day. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'as_of'?: string; /** * The asset class to which the product belongs. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'asset_class'?: string; /** * The asset sub-class to which the product belongs. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'asset_sub_class'?: string; /** * The clearing channel for this product. Indicates whether the product can be cleared only through exchanges or through both exchanges and over-the-counter. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'clearing_channel'?: GetFuturesProducts200ResponseResultsInnerClearingChannelEnum; /** * The date and time at which this product was last updated. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'last_updated'?: string; /** * The full name of the product. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'name'?: string; /** * The quoted price for this product. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'price_quotation'?: string; /** * The unique identifier for the product. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'product_code': string; /** * The sector to which the product belongs. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'sector'?: string; /** * The currency in which this product settles. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'settlement_currency_code'?: string; /** * The method of settlement for this product (Financially Settled or Deliverable). * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'settlement_method'?: string; /** * The type of settlement for this product. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'settlement_type'?: string; /** * The sub-sector to which the product belongs. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'sub_sector'?: string; /** * The currency in which this product trades. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'trade_currency_code'?: string; /** * The trading venue (MIC) for the exchange on which this contract trades. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'trading_venue'?: string; /** * The type of product, one of \"single\" or \"combo\". * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'type'?: string; /** * The unit of measure for this product. * @type {string} * @memberof GetFuturesProducts200ResponseResultsInner */ 'unit_of_measure'?: string; /** * The quantity of the unit of measure for this product. * @type {number} * @memberof GetFuturesProducts200ResponseResultsInner */ 'unit_of_measure_quantity'?: number; } /** * @export * @enum {string} */ declare enum GetFuturesProducts200ResponseResultsInnerClearingChannelEnum { ExchangeOnly = "exchange_only", ExchangeAndOtc = "exchange_and_otc" } /** * * @export * @interface GetFuturesQuotes200Response */ interface GetFuturesQuotes200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetFuturesQuotes200Response */ 'next_url'?: string; /** * * @type {Array} * @memberof GetFuturesQuotes200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFuturesQuotes200Response */ 'status': string; } /** * * @export * @interface GetFuturesQuotes200ResponseResultsInner */ interface GetFuturesQuotes200ResponseResultsInner { /** * The ask price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value. * @type {number} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'ask_price'?: number; /** * The quote size represents the number of futures contracts available at the given ask price. * @type {number} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'ask_size'?: number; /** * The time when the ask price was submitted to the exchange. * @type {number} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'ask_timestamp'?: number; /** * The bid price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value. * @type {number} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'bid_price'?: number; /** * The quote size represents the number of futures contracts available at the given bid price. * @type {number} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'bid_size'?: number; /** * The time when the bid price was submitted to the exchange. * @type {number} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'bid_timestamp'?: number; /** * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @type {string} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'session_end_date'?: string; /** * The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @type {string} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'ticker'?: string; /** * The time when the quote was generated at the exchange to nanosecond precision. * @type {number} * @memberof GetFuturesQuotes200ResponseResultsInner */ 'timestamp'?: number; } /** * * @export * @interface GetFuturesTrades200Response */ interface GetFuturesTrades200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetFuturesTrades200Response */ 'next_url'?: string; /** * * @type {Array} * @memberof GetFuturesTrades200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetFuturesTrades200Response */ 'status': string; } /** * * @export * @interface GetFuturesTrades200ResponseResultsInner */ interface GetFuturesTrades200ResponseResultsInner { /** * The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetFuturesTrades200ResponseResultsInner */ 'price': number; /** * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @type {string} * @memberof GetFuturesTrades200ResponseResultsInner */ 'session_end_date'?: string; /** * The total number of contracts exchanged between buyers and sellers on a given trade. * @type {number} * @memberof GetFuturesTrades200ResponseResultsInner */ 'size': number; /** * ticker of the trade * @type {string} * @memberof GetFuturesTrades200ResponseResultsInner */ 'ticker'?: string; /** * The time when the trade was generated at the exchange to nanosecond precision. * @type {number} * @memberof GetFuturesTrades200ResponseResultsInner */ 'timestamp'?: number; } /** * * @export * @interface GetGroupedCryptoAggregates200Response */ interface GetGroupedCryptoAggregates200Response { /** * Whether or not this response was adjusted for splits. * @type {boolean} * @memberof GetGroupedCryptoAggregates200Response */ 'adjusted': boolean; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof GetGroupedCryptoAggregates200Response */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof GetGroupedCryptoAggregates200Response */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof GetGroupedCryptoAggregates200Response */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof GetGroupedCryptoAggregates200Response */ 'status': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetGroupedCryptoAggregates200Response */ 'results'?: Array; } /** * * @export * @interface GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ interface GetGroupedCryptoAggregates200ResponseAllOfResultsInner { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'T': string; /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'n'?: number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'o': number; /** * The Unix millisecond timestamp for the end of the aggregate window. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ 'vw'?: number; } /** * * @export * @interface GetGroupedStocksAggregates200Response */ interface GetGroupedStocksAggregates200Response { /** * Whether or not this response was adjusted for splits. * @type {boolean} * @memberof GetGroupedStocksAggregates200Response */ 'adjusted': boolean; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof GetGroupedStocksAggregates200Response */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof GetGroupedStocksAggregates200Response */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof GetGroupedStocksAggregates200Response */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof GetGroupedStocksAggregates200Response */ 'status': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetGroupedStocksAggregates200Response */ 'results'?: Array; } /** * * @export * @interface GetGroupedStocksAggregates200ResponseAllOfResultsInner */ interface GetGroupedStocksAggregates200ResponseAllOfResultsInner { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'T': string; /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'n'?: number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'otc'?: boolean; /** * The Unix millisecond timestamp for the end of the aggregate window. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ 'vw'?: number; } /** * * @export * @interface GetIndicesOpenClose200Response */ interface GetIndicesOpenClose200Response { /** * The close value of the ticker symbol in after hours trading. * @type {number} * @memberof GetIndicesOpenClose200Response */ 'afterHours'?: number; /** * The close value for the symbol in the given time period. * @type {number} * @memberof GetIndicesOpenClose200Response */ 'close': number; /** * The requested date. * @type {string} * @memberof GetIndicesOpenClose200Response */ 'from': string; /** * The highest value for the symbol in the given time period. * @type {number} * @memberof GetIndicesOpenClose200Response */ 'high': number; /** * The lowest value for the symbol in the given time period. * @type {number} * @memberof GetIndicesOpenClose200Response */ 'low': number; /** * The open value for the symbol in the given time period. * @type {number} * @memberof GetIndicesOpenClose200Response */ 'open': number; /** * The open value of the ticker symbol in pre-market trading. * @type {number} * @memberof GetIndicesOpenClose200Response */ 'preMarket'?: number; /** * The status of this request\'s response. * @type {string} * @memberof GetIndicesOpenClose200Response */ 'status': string; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetIndicesOpenClose200Response */ 'symbol': string; } /** * * @export * @interface GetIndicesSnapshot200Response */ interface GetIndicesSnapshot200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetIndicesSnapshot200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetIndicesSnapshot200Response */ 'request_id': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetIndicesSnapshot200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetIndicesSnapshot200Response */ 'status': string; } /** * * @export * @interface GetIndicesSnapshot200ResponseResultsInner */ interface GetIndicesSnapshot200ResponseResultsInner { /** * The error while looking for this ticker. * @type {string} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'error'?: string; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'last_updated'?: number; /** * The market status for the market that trades this ticker. * @type {string} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'market_status'?: string; /** * The error message while looking for this ticker. * @type {string} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'message'?: string; /** * Name of Index. * @type {string} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'name'?: string; /** * * @type {GetIndicesSnapshot200ResponseResultsInnerSession} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'session'?: GetIndicesSnapshot200ResponseResultsInnerSession; /** * Ticker of asset queried. * @type {string} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'ticker': string; /** * The time relevance of the data. * @type {string} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'timeframe'?: GetIndicesSnapshot200ResponseResultsInnerTimeframeEnum; /** * The indices market. * @type {string} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'type'?: GetIndicesSnapshot200ResponseResultsInnerTypeEnum; /** * Value of Index. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'value'?: number; } /** * @export * @enum {string} */ declare enum GetIndicesSnapshot200ResponseResultsInnerTimeframeEnum { Delayed = "DELAYED", RealTime = "REAL-TIME" } /** * @export * @enum {string} */ declare enum GetIndicesSnapshot200ResponseResultsInnerTypeEnum { Indices = "indices" } /** * Trading session metrics, detailing change percentages and key price points (open, close, high, low) for the asset within the current trading day. * @export * @interface GetIndicesSnapshot200ResponseResultsInnerSession */ interface GetIndicesSnapshot200ResponseResultsInnerSession { /** * The value of the change for the index from the previous trading day. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ 'change'?: number; /** * The percent of the change for the index from the previous trading day. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ 'change_percent'?: number; /** * The closing value for the index of the day. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ 'close'?: number; /** * The highest value for the index of the day. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ 'high'?: number; /** * The lowest value for the index of the day. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ 'low'?: number; /** * The open value for the index of the day. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ 'open'?: number; /** * The closing value for the index of previous trading day. * @type {number} * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ 'previous_close'?: number; } /** * * @export * @interface GetLastCryptoTrade200Response */ interface GetLastCryptoTrade200Response { /** * * @type {GetLastCryptoTrade200ResponseLast} * @memberof GetLastCryptoTrade200Response */ 'last'?: GetLastCryptoTrade200ResponseLast; /** * A request id assigned by the server. * @type {string} * @memberof GetLastCryptoTrade200Response */ 'request_id': string; /** * The status of this request\'s response. * @type {string} * @memberof GetLastCryptoTrade200Response */ 'status': string; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof GetLastCryptoTrade200Response */ 'symbol': string; } /** * Contains the requested trade data for the specified cryptocurrency pair. * @export * @interface GetLastCryptoTrade200ResponseLast */ interface GetLastCryptoTrade200ResponseLast { /** * A list of condition codes. * @type {Array} * @memberof GetLastCryptoTrade200ResponseLast */ 'conditions'?: Array; /** * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof GetLastCryptoTrade200ResponseLast */ 'exchange': number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetLastCryptoTrade200ResponseLast */ 'price': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof GetLastCryptoTrade200ResponseLast */ 'size': number; /** * The Unix millisecond timestamp. * @type {number} * @memberof GetLastCryptoTrade200ResponseLast */ 'timestamp': number; } /** * * @export * @interface GetLastCurrencyQuote200Response */ interface GetLastCurrencyQuote200Response { /** * * @type {GetCurrencyConversion200ResponseLast} * @memberof GetLastCurrencyQuote200Response */ 'last'?: GetCurrencyConversion200ResponseLast; /** * A request id assigned by the server. * @type {string} * @memberof GetLastCurrencyQuote200Response */ 'request_id': string; /** * The status of this request\'s response. * @type {string} * @memberof GetLastCurrencyQuote200Response */ 'status': string; /** * The symbol pair that was evaluated from the request. * @type {string} * @memberof GetLastCurrencyQuote200Response */ 'symbol': string; } /** * * @export * @interface GetLastOptionsTrade200Response */ interface GetLastOptionsTrade200Response { /** * A request id assigned by the server. * @type {string} * @memberof GetLastOptionsTrade200Response */ 'request_id': string; /** * * @type {GetLastOptionsTrade200ResponseResults} * @memberof GetLastOptionsTrade200Response */ 'results'?: GetLastOptionsTrade200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetLastOptionsTrade200Response */ 'status': string; } /** * * @export * @interface GetLastOptionsTrade200ResponseResults */ interface GetLastOptionsTrade200ResponseResults { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetLastOptionsTrade200ResponseResults */ 'T': string; /** * A list of condition codes. * @type {Array} * @memberof GetLastOptionsTrade200ResponseResults */ 'c'?: Array; /** * The trade correction indicator. * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'e'?: number; /** * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'f'?: number; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof GetLastOptionsTrade200ResponseResults */ 'i': string; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'p': number; /** * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'q': number; /** * The ID for the Trade Reporting Facility where the trade took place. * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'r'?: number; /** * The size of a trade (also known as volume). * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 's'?: number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 't': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'x': number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'y': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof GetLastOptionsTrade200ResponseResults */ 'z'?: number; } /** * * @export * @interface GetLastStocksQuote200Response */ interface GetLastStocksQuote200Response { /** * A request id assigned by the server. * @type {string} * @memberof GetLastStocksQuote200Response */ 'request_id': string; /** * * @type {GetLastStocksQuote200ResponseResults} * @memberof GetLastStocksQuote200Response */ 'results'?: GetLastStocksQuote200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetLastStocksQuote200Response */ 'status': string; } /** * * @export * @interface GetLastStocksQuote200ResponseResults */ interface GetLastStocksQuote200ResponseResults { /** * The ask price. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'P'?: number; /** * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'S'?: number; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetLastStocksQuote200ResponseResults */ 'T': string; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'X'?: number; /** * A list of condition codes. * @type {Array} * @memberof GetLastStocksQuote200ResponseResults */ 'c'?: Array; /** * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'f'?: number; /** * A list of indicator codes. * @type {Array} * @memberof GetLastStocksQuote200ResponseResults */ 'i'?: Array; /** * The bid price. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'p'?: number; /** * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'q': number; /** * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 's'?: number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 't': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'x'?: number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'y': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof GetLastStocksQuote200ResponseResults */ 'z'?: number; } /** * * @export * @interface GetMarketHolidays200ResponseInner */ interface GetMarketHolidays200ResponseInner { /** * The market close time on the holiday (if it\'s not closed). * @type {string} * @memberof GetMarketHolidays200ResponseInner */ 'close'?: string; /** * The date of the holiday. * @type {string} * @memberof GetMarketHolidays200ResponseInner */ 'date'?: string; /** * Which market the record is for. * @type {string} * @memberof GetMarketHolidays200ResponseInner */ 'exchange'?: string; /** * The name of the holiday. * @type {string} * @memberof GetMarketHolidays200ResponseInner */ 'name'?: string; /** * The market open time on the holiday (if it\'s not closed). * @type {string} * @memberof GetMarketHolidays200ResponseInner */ 'open'?: string; /** * The status of the market on the holiday. * @type {string} * @memberof GetMarketHolidays200ResponseInner */ 'status'?: string; } /** * * @export * @interface GetMarketStatus200Response */ interface GetMarketStatus200Response { /** * Whether or not the market is in post-market hours. * @type {boolean} * @memberof GetMarketStatus200Response */ 'afterHours'?: boolean; /** * * @type {GetMarketStatus200ResponseCurrencies} * @memberof GetMarketStatus200Response */ 'currencies'?: GetMarketStatus200ResponseCurrencies; /** * Whether or not the market is in pre-market hours. * @type {boolean} * @memberof GetMarketStatus200Response */ 'earlyHours'?: boolean; /** * * @type {GetMarketStatus200ResponseExchanges} * @memberof GetMarketStatus200Response */ 'exchanges'?: GetMarketStatus200ResponseExchanges; /** * * @type {GetMarketStatus200ResponseIndicesGroups} * @memberof GetMarketStatus200Response */ 'indicesGroups'?: GetMarketStatus200ResponseIndicesGroups; /** * The status of the market as a whole. * @type {string} * @memberof GetMarketStatus200Response */ 'market'?: string; /** * The current time of the server, returned as a date-time in RFC3339 format. * @type {string} * @memberof GetMarketStatus200Response */ 'serverTime'?: string; } /** * Contains the status of various currency markets. * @export * @interface GetMarketStatus200ResponseCurrencies */ interface GetMarketStatus200ResponseCurrencies { /** * The status of the crypto market. * @type {string} * @memberof GetMarketStatus200ResponseCurrencies */ 'crypto'?: string; /** * The status of the forex market. * @type {string} * @memberof GetMarketStatus200ResponseCurrencies */ 'fx'?: string; } /** * Contains the status of different US stock exchanges (e.g., Nasdaq, NYSE). * @export * @interface GetMarketStatus200ResponseExchanges */ interface GetMarketStatus200ResponseExchanges { /** * The status of the Nasdaq market. * @type {string} * @memberof GetMarketStatus200ResponseExchanges */ 'nasdaq'?: string; /** * The status of the NYSE market. * @type {string} * @memberof GetMarketStatus200ResponseExchanges */ 'nyse'?: string; /** * The status of the OTC market. * @type {string} * @memberof GetMarketStatus200ResponseExchanges */ 'otc'?: string; } /** * Contains the status of various index groups (e.g., MSCI, FTSE Russell). * @export * @interface GetMarketStatus200ResponseIndicesGroups */ interface GetMarketStatus200ResponseIndicesGroups { /** * The status of Cboe Streaming Market Indices Cryptocurrency (\"CCCY\") indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'cccy'?: string; /** * The status of Cboe Global Indices (\"CGI\") trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'cgi'?: string; /** * The status of Dow Jones indices trading hours * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'dow_jones'?: string; /** * The status of Financial Times Stock Exchange Group (\"FTSE\") Russell indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'ftse_russell'?: string; /** * The status of Morgan Stanley Capital International (\"MSCI\") indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'msci'?: string; /** * The status of Morningstar (\"MSTAR\") indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'mstar'?: string; /** * The status of Morningstar Customer (\"MSTARC\") indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'mstarc'?: string; /** * The status of National Association of Securities Dealers Automated Quotations (\"Nasdaq\") indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'nasdaq'?: string; /** * The status of Standard & Poors\'s (\"S&P\") indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 's_and_p'?: string; /** * The status of Societe Generale indices trading hours. * @type {string} * @memberof GetMarketStatus200ResponseIndicesGroups */ 'societe_generale'?: string; } /** * * @export * @interface GetOptionContract200Response */ interface GetOptionContract200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetOptionContract200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetOptionContract200Response */ 'request_id': string; /** * * @type {GetOptionsChain200ResponseResultsInner} * @memberof GetOptionContract200Response */ 'results'?: GetOptionsChain200ResponseResultsInner; /** * The status of this request\'s response. * @type {string} * @memberof GetOptionContract200Response */ 'status': string; } /** * * @export * @interface GetOptionsChain200Response */ interface GetOptionsChain200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetOptionsChain200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetOptionsChain200Response */ 'request_id': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetOptionsChain200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetOptionsChain200Response */ 'status': string; } /** * Contains the requested snapshot data for the specified contract. * @export * @interface GetOptionsChain200ResponseResultsInner */ interface GetOptionsChain200ResponseResultsInner { /** * The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid). * @type {number} * @memberof GetOptionsChain200ResponseResultsInner */ 'break_even_price': number; /** * * @type {GetOptionsChain200ResponseResultsInnerDay} * @memberof GetOptionsChain200ResponseResultsInner */ 'day': GetOptionsChain200ResponseResultsInnerDay; /** * * @type {GetOptionsChain200ResponseResultsInnerDetails} * @memberof GetOptionsChain200ResponseResultsInner */ 'details': GetOptionsChain200ResponseResultsInnerDetails; /** * Fair market value is only available on Business plans. It\'s it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetOptionsChain200ResponseResultsInner */ 'fmv'?: number; /** * * @type {GetSnapshots200ResponseResultsInnerGreeks} * @memberof GetOptionsChain200ResponseResultsInner */ 'greeks'?: GetSnapshots200ResponseResultsInnerGreeks; /** * The market\'s forecast for the volatility of the underlying asset, based on this option\'s current price. * @type {number} * @memberof GetOptionsChain200ResponseResultsInner */ 'implied_volatility'?: number; /** * * @type {GetOptionsChain200ResponseResultsInnerLastQuote} * @memberof GetOptionsChain200ResponseResultsInner */ 'last_quote': GetOptionsChain200ResponseResultsInnerLastQuote; /** * * @type {GetOptionsChain200ResponseResultsInnerLastTrade} * @memberof GetOptionsChain200ResponseResultsInner */ 'last_trade'?: GetOptionsChain200ResponseResultsInnerLastTrade; /** * The quantity of this contract held at the end of the last trading day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInner */ 'open_interest': number; /** * * @type {GetSnapshots200ResponseResultsInnerUnderlyingAsset} * @memberof GetOptionsChain200ResponseResultsInner */ 'underlying_asset': GetSnapshots200ResponseResultsInnerUnderlyingAsset; } /** * The most recent daily bar for this contract. * @export * @interface GetOptionsChain200ResponseResultsInnerDay */ interface GetOptionsChain200ResponseResultsInnerDay { /** * The value of the price change for the contract from the previous trading day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'change': number; /** * The percent of the price change for the contract from the previous trading day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'change_percent': number; /** * The closing price for the contract of the day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'close': number; /** * The highest price for the contract of the day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'high': number; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'last_updated'?: number; /** * The lowest price for the contract of the day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'low': number; /** * The open price for the contract of the day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'open': number; /** * The closing price for the contract of previous trading day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'previous_close': number; /** * The trading volume for the contract of the day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'volume': number; /** * The trading volume weighted average price for the contract of the day. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDay */ 'vwap': number; } /** * The details for this contract. * @export * @interface GetOptionsChain200ResponseResultsInnerDetails */ interface GetOptionsChain200ResponseResultsInnerDetails { /** * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". * @type {string} * @memberof GetOptionsChain200ResponseResultsInnerDetails */ 'contract_type': GetOptionsChain200ResponseResultsInnerDetailsContractTypeEnum; /** * The exercise style of this contract. See this link for more details on exercise styles. * @type {string} * @memberof GetOptionsChain200ResponseResultsInnerDetails */ 'exercise_style': GetOptionsChain200ResponseResultsInnerDetailsExerciseStyleEnum; /** * The contract\'s expiration date in YYYY-MM-DD format. * @type {string} * @memberof GetOptionsChain200ResponseResultsInnerDetails */ 'expiration_date': string; /** * The number of shares per contract for this contract. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDetails */ 'shares_per_contract': number; /** * The strike price of the option contract. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerDetails */ 'strike_price': number; /** * The ticker symbol for the asset. * @type {string} * @memberof GetOptionsChain200ResponseResultsInnerDetails */ 'ticker': string; } /** * @export * @enum {string} */ declare enum GetOptionsChain200ResponseResultsInnerDetailsContractTypeEnum { Put = "put", Call = "call", Other = "other" } /** * @export * @enum {string} */ declare enum GetOptionsChain200ResponseResultsInnerDetailsExerciseStyleEnum { American = "american", European = "european", Bermudan = "bermudan" } /** * The most recent quote for this contract. This is only returned if your current plan includes quotes. * @export * @interface GetOptionsChain200ResponseResultsInnerLastQuote */ interface GetOptionsChain200ResponseResultsInnerLastQuote { /** * The ask price. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'ask': number; /** * The ask side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'ask_exchange'?: number; /** * The ask size. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'ask_size': number; /** * The bid price. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'bid': number; /** * The bid side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'bid_exchange'?: number; /** * The bid size. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'bid_size': number; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'last_updated'?: number; /** * The average of the bid and ask price. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'midpoint': number; /** * The time relevance of the data. * @type {string} * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ 'timeframe'?: GetOptionsChain200ResponseResultsInnerLastQuoteTimeframeEnum; } /** * @export * @enum {string} */ declare enum GetOptionsChain200ResponseResultsInnerLastQuoteTimeframeEnum { Delayed = "DELAYED", RealTime = "REAL-TIME" } /** * The most recent trade for this contract. This is only returned if your current plan includes trades. * @export * @interface GetOptionsChain200ResponseResultsInnerLastTrade */ interface GetOptionsChain200ResponseResultsInnerLastTrade { /** * A list of condition codes. * @type {Array} * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'conditions'?: Array; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'exchange': number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'price': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'sip_timestamp': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'size': number; /** * The time relevance of the data. * @type {string} * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'timeframe'?: GetOptionsChain200ResponseResultsInnerLastTradeTimeframeEnum; } /** * @export * @enum {string} */ declare enum GetOptionsChain200ResponseResultsInnerLastTradeTimeframeEnum { Delayed = "DELAYED", RealTime = "REAL-TIME" } /** * * @export * @interface GetOptionsContract200Response */ interface GetOptionsContract200Response { /** * A request id assigned by the server. * @type {string} * @memberof GetOptionsContract200Response */ 'request_id'?: string; /** * * @type {ListOptionsContracts200ResponseResultsInner} * @memberof GetOptionsContract200Response */ 'results'?: ListOptionsContracts200ResponseResultsInner; /** * The status of this request\'s response. * @type {string} * @memberof GetOptionsContract200Response */ 'status'?: string; } /** * * @export * @interface GetOptionsOpenClose200Response */ interface GetOptionsOpenClose200Response { /** * The close price of the ticker symbol in after hours trading. * @type {number} * @memberof GetOptionsOpenClose200Response */ 'afterHours'?: number; /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetOptionsOpenClose200Response */ 'close': number; /** * The requested date. * @type {string} * @memberof GetOptionsOpenClose200Response */ 'from': string; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetOptionsOpenClose200Response */ 'high': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetOptionsOpenClose200Response */ 'low': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetOptionsOpenClose200Response */ 'open': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof GetOptionsOpenClose200Response */ 'otc'?: boolean; /** * The open price of the ticker symbol in pre-market trading. * @type {number} * @memberof GetOptionsOpenClose200Response */ 'preMarket'?: number; /** * The status of this request\'s response. * @type {string} * @memberof GetOptionsOpenClose200Response */ 'status': string; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetOptionsOpenClose200Response */ 'symbol': string; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetOptionsOpenClose200Response */ 'volume': number; } /** * * @export * @interface GetOptionsQuotes200Response */ interface GetOptionsQuotes200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetOptionsQuotes200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetOptionsQuotes200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetOptionsQuotes200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetOptionsQuotes200Response */ 'status': string; } /** * * @export * @interface GetOptionsQuotes200ResponseResultsInner */ interface GetOptionsQuotes200ResponseResultsInner { /** * The ask exchange ID * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'ask_exchange'?: number; /** * The ask price. * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'ask_price'?: number; /** * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'ask_size'?: number; /** * The bid exchange ID * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'bid_exchange'?: number; /** * The bid price. * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'bid_price'?: number; /** * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'bid_size'?: number; /** * The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'sequence_number': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. * @type {number} * @memberof GetOptionsQuotes200ResponseResultsInner */ 'sip_timestamp': number; } /** * * @export * @interface GetOptionsTrades200Response */ interface GetOptionsTrades200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetOptionsTrades200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetOptionsTrades200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetOptionsTrades200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetOptionsTrades200Response */ 'status': string; } /** * * @export * @interface GetOptionsTrades200ResponseResultsInner */ interface GetOptionsTrades200ResponseResultsInner { /** * A list of condition codes. * @type {Array} * @memberof GetOptionsTrades200ResponseResultsInner */ 'conditions'?: Array; /** * The trade correction indicator. * @type {number} * @memberof GetOptionsTrades200ResponseResultsInner */ 'correction'?: number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetOptionsTrades200ResponseResultsInner */ 'exchange': number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange. * @type {number} * @memberof GetOptionsTrades200ResponseResultsInner */ 'participant_timestamp'?: number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetOptionsTrades200ResponseResultsInner */ 'price': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. * @type {number} * @memberof GetOptionsTrades200ResponseResultsInner */ 'sip_timestamp': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof GetOptionsTrades200ResponseResultsInner */ 'size': number; } /** * * @export * @interface GetPreviousCryptoAggregates200Response */ interface GetPreviousCryptoAggregates200Response { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetPreviousCryptoAggregates200Response */ 'ticker': string; /** * Whether or not this response was adjusted for splits. * @type {boolean} * @memberof GetPreviousCryptoAggregates200Response */ 'adjusted': boolean; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof GetPreviousCryptoAggregates200Response */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof GetPreviousCryptoAggregates200Response */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof GetPreviousCryptoAggregates200Response */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof GetPreviousCryptoAggregates200Response */ 'status': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetPreviousCryptoAggregates200Response */ 'results'?: Array; } /** * * @export * @interface GetPreviousForexAggregates200Response */ interface GetPreviousForexAggregates200Response { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetPreviousForexAggregates200Response */ 'ticker': string; /** * Whether or not this response was adjusted for splits. * @type {boolean} * @memberof GetPreviousForexAggregates200Response */ 'adjusted': boolean; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof GetPreviousForexAggregates200Response */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof GetPreviousForexAggregates200Response */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof GetPreviousForexAggregates200Response */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof GetPreviousForexAggregates200Response */ 'status': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetPreviousForexAggregates200Response */ 'results'?: Array; } /** * * @export * @interface GetPreviousForexAggregates200ResponseAllOfResultsInner */ interface GetPreviousForexAggregates200ResponseAllOfResultsInner { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'T': string; /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'n'?: number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'o': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ 'vw'?: number; } /** * * @export * @interface GetPreviousIndicesAggregates200Response */ interface GetPreviousIndicesAggregates200Response { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetPreviousIndicesAggregates200Response */ 'ticker': string; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof GetPreviousIndicesAggregates200Response */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof GetPreviousIndicesAggregates200Response */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof GetPreviousIndicesAggregates200Response */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof GetPreviousIndicesAggregates200Response */ 'status': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetPreviousIndicesAggregates200Response */ 'results'?: Array; } /** * * @export * @interface GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ interface GetPreviousIndicesAggregates200ResponseAllOfResultsInner { /** * The close value for the symbol in the given time period. * @type {number} * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ 'c': number; /** * The highest value for the symbol in the given time period. * @type {number} * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ 'h': number; /** * The lowest value for the symbol in the given time period. * @type {number} * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ 'l': number; /** * The open value for the symbol in the given time period. * @type {number} * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ 'o': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ 't': number; } /** * * @export * @interface GetRelatedCompanies200Response */ interface GetRelatedCompanies200Response { /** * A request id assigned by the server. * @type {string} * @memberof GetRelatedCompanies200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetRelatedCompanies200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetRelatedCompanies200Response */ 'status'?: string; /** * The ticker being queried. * @type {string} * @memberof GetRelatedCompanies200Response */ 'ticker'?: string; } /** * The tickers related to the requested ticker. * @export * @interface GetRelatedCompanies200ResponseResultsInner */ interface GetRelatedCompanies200ResponseResultsInner { /** * A ticker related to the requested ticker. * @type {string} * @memberof GetRelatedCompanies200ResponseResultsInner */ 'ticker': string; } /** * * @export * @interface GetSnapshotSummary200Response */ interface GetSnapshotSummary200Response { /** * A request id assigned by the server. * @type {string} * @memberof GetSnapshotSummary200Response */ 'request_id': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetSnapshotSummary200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetSnapshotSummary200Response */ 'status': string; } /** * * @export * @interface GetSnapshotSummary200ResponseResultsInner */ interface GetSnapshotSummary200ResponseResultsInner { /** * * @type {GetSnapshotSummary200ResponseResultsInnerBranding} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'branding'?: GetSnapshotSummary200ResponseResultsInnerBranding; /** * The error while looking for this ticker. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'error'?: string; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'last_updated'?: number; /** * The market status for the market that trades this ticker. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'market_status'?: string; /** * The error message while looking for this ticker. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'message'?: string; /** * Name of ticker, forex, or crypto asset. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'name'?: string; /** * * @type {GetSnapshotSummary200ResponseResultsInnerOptions} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'options'?: GetSnapshotSummary200ResponseResultsInnerOptions; /** * The most up to date ticker price. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'price'?: number; /** * * @type {GetSnapshotSummary200ResponseResultsInnerSession} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'session'?: GetSnapshotSummary200ResponseResultsInnerSession; /** * Ticker of asset queried. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'ticker': string; /** * The market for this ticker of stock, crypto, fx, option. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInner */ 'type'?: GetSnapshotSummary200ResponseResultsInnerTypeEnum; } /** * @export * @enum {string} */ declare enum GetSnapshotSummary200ResponseResultsInnerTypeEnum { Stocks = "stocks", Crypto = "crypto", Options = "options", Fx = "fx" } /** * * @export * @interface GetSnapshotSummary200ResponseResultsInnerBranding */ interface GetSnapshotSummary200ResponseResultsInnerBranding { /** * A link to this ticker\'s company\'s icon. Icon\'s are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInnerBranding */ 'icon_url'?: string; /** * A link to this ticker\'s company\'s logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInnerBranding */ 'logo_url'?: string; } /** * * @export * @interface GetSnapshotSummary200ResponseResultsInnerOptions */ interface GetSnapshotSummary200ResponseResultsInnerOptions { /** * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ 'contract_type': GetSnapshotSummary200ResponseResultsInnerOptionsContractTypeEnum; /** * The exercise style of this contract. See this link for more details on exercise styles. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ 'exercise_style': GetSnapshotSummary200ResponseResultsInnerOptionsExerciseStyleEnum; /** * The contract\'s expiration date in YYYY-MM-DD format. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ 'expiration_date': string; /** * The number of shares per contract for this contract. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ 'shares_per_contract': number; /** * The strike price of the option contract. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ 'strike_price': number; /** * The ticker for the option contract. * @type {string} * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ 'underlying_ticker': string; } /** * @export * @enum {string} */ declare enum GetSnapshotSummary200ResponseResultsInnerOptionsContractTypeEnum { Put = "put", Call = "call", Other = "other" } /** * @export * @enum {string} */ declare enum GetSnapshotSummary200ResponseResultsInnerOptionsExerciseStyleEnum { American = "american", European = "european", Bermudan = "bermudan" } /** * Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking. * @export * @interface GetSnapshotSummary200ResponseResultsInnerSession */ interface GetSnapshotSummary200ResponseResultsInnerSession { /** * The value of the price change for the asset from the previous trading day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'change': number; /** * The percent of the price change for the asset from the previous trading day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'change_percent': number; /** * The closing price of the asset for the day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'close': number; /** * Today\'s early trading change amount, difference between price and previous close if in early trading hours, otherwise difference between last price during early trading and previous close. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'early_trading_change'?: number; /** * Today\'s early trading change as a percentage. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'early_trading_change_percent'?: number; /** * The highest price of the asset for the day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'high': number; /** * Today\'s late trading change amount, difference between price and today\'s close if in late trading hours, otherwise difference between last price during late trading and today\'s close. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'late_trading_change'?: number; /** * Today\'s late trading change as a percentage. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'late_trading_change_percent'?: number; /** * The lowest price of the asset for the day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'low': number; /** * The open price of the asset for the day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'open': number; /** * The closing price of the asset for the previous trading day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'previous_close': number; /** * The price of the most recent trade or bid price for this asset. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'price'?: number; /** * Today\'s change in regular trading hours, difference between current price and previous trading day\'s close, otherwise difference between today\'s close and previous day\'s close. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'regular_trading_change'?: number; /** * Today\'s regular trading change as a percentage. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'regular_trading_change_percent'?: number; /** * The trading volume for the asset for the day. * @type {number} * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ 'volume'?: number; } /** * * @export * @interface GetSnapshots200Response */ interface GetSnapshots200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetSnapshots200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetSnapshots200Response */ 'request_id': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetSnapshots200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetSnapshots200Response */ 'status': string; } /** * * @export * @interface GetSnapshots200ResponseResultsInner */ interface GetSnapshots200ResponseResultsInner { /** * The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid). * @type {number} * @memberof GetSnapshots200ResponseResultsInner */ 'break_even_price'?: number; /** * * @type {GetSnapshots200ResponseResultsInnerDetails} * @memberof GetSnapshots200ResponseResultsInner */ 'details'?: GetSnapshots200ResponseResultsInnerDetails; /** * The error while looking for this ticker. * @type {string} * @memberof GetSnapshots200ResponseResultsInner */ 'error'?: string; /** * Fair market value is only available on Business plans. It\'s it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetSnapshots200ResponseResultsInner */ 'fmv'?: number; /** * * @type {GetSnapshots200ResponseResultsInnerGreeks} * @memberof GetSnapshots200ResponseResultsInner */ 'greeks'?: GetSnapshots200ResponseResultsInnerGreeks; /** * The market\'s forecast for the volatility of the underlying asset, based on this option\'s current price. * @type {number} * @memberof GetSnapshots200ResponseResultsInner */ 'implied_volatility'?: number; /** * * @type {GetSnapshots200ResponseResultsInnerLastMinute} * @memberof GetSnapshots200ResponseResultsInner */ 'last_minute'?: GetSnapshots200ResponseResultsInnerLastMinute; /** * * @type {GetSnapshots200ResponseResultsInnerLastQuote} * @memberof GetSnapshots200ResponseResultsInner */ 'last_quote'?: GetSnapshots200ResponseResultsInnerLastQuote; /** * * @type {GetSnapshots200ResponseResultsInnerLastTrade} * @memberof GetSnapshots200ResponseResultsInner */ 'last_trade'?: GetSnapshots200ResponseResultsInnerLastTrade; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetSnapshots200ResponseResultsInner */ 'last_updated'?: number; /** * The market status for the market that trades this ticker. Possible values for stocks, options, crypto, and forex snapshots are open, closed, early_trading, or late_trading. Possible values for indices snapshots are regular_trading, closed, early_trading, and late_trading. * @type {string} * @memberof GetSnapshots200ResponseResultsInner */ 'market_status'?: string; /** * The error message while looking for this ticker. * @type {string} * @memberof GetSnapshots200ResponseResultsInner */ 'message'?: string; /** * The name of this contract. * @type {string} * @memberof GetSnapshots200ResponseResultsInner */ 'name'?: string; /** * The quantity of this contract held at the end of the last trading day. * @type {number} * @memberof GetSnapshots200ResponseResultsInner */ 'open_interest'?: number; /** * * @type {GetSnapshotSummary200ResponseResultsInnerSession} * @memberof GetSnapshots200ResponseResultsInner */ 'session'?: GetSnapshotSummary200ResponseResultsInnerSession; /** * The ticker symbol for the asset. * @type {string} * @memberof GetSnapshots200ResponseResultsInner */ 'ticker': string; /** * The time relevance of the data. * @type {string} * @memberof GetSnapshots200ResponseResultsInner */ 'timeframe'?: GetSnapshots200ResponseResultsInnerTimeframeEnum; /** * The asset class for this ticker. * @type {string} * @memberof GetSnapshots200ResponseResultsInner */ 'type'?: GetSnapshots200ResponseResultsInnerTypeEnum; /** * * @type {GetSnapshots200ResponseResultsInnerUnderlyingAsset} * @memberof GetSnapshots200ResponseResultsInner */ 'underlying_asset'?: GetSnapshots200ResponseResultsInnerUnderlyingAsset; /** * Value of Index. * @type {number} * @memberof GetSnapshots200ResponseResultsInner */ 'value'?: number; } /** * @export * @enum {string} */ declare enum GetSnapshots200ResponseResultsInnerTimeframeEnum { Delayed = "DELAYED", RealTime = "REAL-TIME" } /** * @export * @enum {string} */ declare enum GetSnapshots200ResponseResultsInnerTypeEnum { Stocks = "stocks", Options = "options", Fx = "fx", Crypto = "crypto", Indices = "indices" } /** * The details for this contract. * @export * @interface GetSnapshots200ResponseResultsInnerDetails */ interface GetSnapshots200ResponseResultsInnerDetails { /** * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". * @type {string} * @memberof GetSnapshots200ResponseResultsInnerDetails */ 'contract_type': GetSnapshots200ResponseResultsInnerDetailsContractTypeEnum; /** * The exercise style of this contract. See this link for more details on exercise styles. * @type {string} * @memberof GetSnapshots200ResponseResultsInnerDetails */ 'exercise_style': GetSnapshots200ResponseResultsInnerDetailsExerciseStyleEnum; /** * The contract\'s expiration date in YYYY-MM-DD format. * @type {string} * @memberof GetSnapshots200ResponseResultsInnerDetails */ 'expiration_date': string; /** * The number of shares per contract for this contract. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerDetails */ 'shares_per_contract': number; /** * The strike price of the option contract. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerDetails */ 'strike_price': number; } /** * @export * @enum {string} */ declare enum GetSnapshots200ResponseResultsInnerDetailsContractTypeEnum { Put = "put", Call = "call", Other = "other" } /** * @export * @enum {string} */ declare enum GetSnapshots200ResponseResultsInnerDetailsExerciseStyleEnum { American = "american", European = "european", Bermudan = "bermudan" } /** * The greeks for this contract. There are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money. See this article for more information. * @export * @interface GetSnapshots200ResponseResultsInnerGreeks */ interface GetSnapshots200ResponseResultsInnerGreeks { /** * The change in the option\'s price per $0.01 increment in the price of the underlying asset. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerGreeks */ 'delta': number; /** * The change in delta per $0.01 change in the price of the underlying asset. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerGreeks */ 'gamma': number; /** * The change in the option\'s price per day. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerGreeks */ 'theta': number; /** * The change in the option\'s price per 1% increment in volatility. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerGreeks */ 'vega': number; } /** * The most recent minute aggregate for this stock. * @export * @interface GetSnapshots200ResponseResultsInnerLastMinute */ interface GetSnapshots200ResponseResultsInnerLastMinute { /** * The closing value for the minute aggreate. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ 'close': number; /** * The highest value for the minute aggregate. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ 'high': number; /** * The lowest value for the minute aggregate. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ 'low': number; /** * The open value for the minute aggregate. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ 'open': number; /** * The number of transactions that took place within the minute aggregate. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ 'transactions': number; /** * The trading volume for the minute aggregate. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ 'volume': number; /** * The trading volume weighted average price for the minute aggregate. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ 'vwap': number; } /** * The most recent quote for this contract. This is only returned if your current plan includes quotes. * @export * @interface GetSnapshots200ResponseResultsInnerLastQuote */ interface GetSnapshots200ResponseResultsInnerLastQuote { /** * The ask price. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'ask': number; /** * The ask side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'ask_exchange'?: number; /** * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'ask_size'?: number; /** * The bid price. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'bid': number; /** * The bid side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'bid_exchange'?: number; /** * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'bid_size'?: number; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'last_updated': number; /** * The average of the bid and ask price. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'midpoint'?: number; /** * The time relevance of the data. * @type {string} * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ 'timeframe': GetSnapshots200ResponseResultsInnerLastQuoteTimeframeEnum; } /** * @export * @enum {string} */ declare enum GetSnapshots200ResponseResultsInnerLastQuoteTimeframeEnum { Delayed = "DELAYED", RealTime = "REAL-TIME" } /** * The most recent quote for this contract. This is only returned if your current plan includes trades. * @export * @interface GetSnapshots200ResponseResultsInnerLastTrade */ interface GetSnapshots200ResponseResultsInnerLastTrade { /** * A list of condition codes. * @type {Array} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'conditions'?: Array; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'exchange'?: number; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'id'?: string; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'last_updated'?: number; /** * The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'participant_timestamp'?: number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'price': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'sip_timestamp'?: number; /** * The size of a trade (also known as volume). * @type {number} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'size': number; /** * The time relevance of the data. * @type {string} * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ 'timeframe'?: GetSnapshots200ResponseResultsInnerLastTradeTimeframeEnum; } /** * @export * @enum {string} */ declare enum GetSnapshots200ResponseResultsInnerLastTradeTimeframeEnum { Delayed = "DELAYED", RealTime = "REAL-TIME" } /** * Information on the underlying stock for this options contract. The market data returned depends on your current stocks plan. * @export * @interface GetSnapshots200ResponseResultsInnerUnderlyingAsset */ interface GetSnapshots200ResponseResultsInnerUnderlyingAsset { /** * The change in price for the contract to break even. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ 'change_to_break_even': number; /** * The nanosecond timestamp of when this information was updated. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ 'last_updated'?: number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ 'price'?: number; /** * The ticker symbol for the contract\'s underlying asset. * @type {string} * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ 'ticker': string; /** * The time relevance of the data. * @type {string} * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ 'timeframe'?: GetSnapshots200ResponseResultsInnerUnderlyingAssetTimeframeEnum; /** * The value of the underlying index. * @type {number} * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ 'value'?: number; } /** * @export * @enum {string} */ declare enum GetSnapshots200ResponseResultsInnerUnderlyingAssetTimeframeEnum { Delayed = "DELAYED", RealTime = "REAL-TIME" } /** * * @export * @interface GetStocksAggregates200Response */ interface GetStocksAggregates200Response { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetStocksAggregates200Response */ 'ticker': string; /** * Whether or not this response was adjusted for splits. * @type {boolean} * @memberof GetStocksAggregates200Response */ 'adjusted': boolean; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof GetStocksAggregates200Response */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof GetStocksAggregates200Response */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof GetStocksAggregates200Response */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof GetStocksAggregates200Response */ 'status': string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetStocksAggregates200Response */ 'results'?: Array; /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetStocksAggregates200Response */ 'next_url'?: string; } /** * * @export * @interface GetStocksAggregates200ResponseAllOfResultsInner */ interface GetStocksAggregates200ResponseAllOfResultsInner { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'n'?: number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'otc'?: boolean; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ 'vw'?: number; } /** * * @export * @interface GetStocksQuotes200Response */ interface GetStocksQuotes200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetStocksQuotes200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetStocksQuotes200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetStocksQuotes200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetStocksQuotes200Response */ 'status': string; } /** * * @export * @interface GetStocksQuotes200ResponseResultsInner */ interface GetStocksQuotes200ResponseResultsInner { /** * The ask exchange ID * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'ask_exchange'?: number; /** * The ask price. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'ask_price'?: number; /** * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'ask_size'?: number; /** * The bid exchange ID * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'bid_exchange'?: number; /** * The bid price. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'bid_price'?: number; /** * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'bid_size'?: number; /** * A list of condition codes. * @type {Array} * @memberof GetStocksQuotes200ResponseResultsInner */ 'conditions'?: Array; /** * A list of indicator codes. * @type {Array} * @memberof GetStocksQuotes200ResponseResultsInner */ 'indicators'?: Array; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'participant_timestamp': number; /** * The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'sequence_number': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'sip_timestamp': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'tape'?: number; /** * The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. * @type {number} * @memberof GetStocksQuotes200ResponseResultsInner */ 'trf_timestamp'?: number; } /** * * @export * @interface GetStocksSnapshotDirection200Response */ interface GetStocksSnapshotDirection200Response { /** * The status of this request\'s response. * @type {string} * @memberof GetStocksSnapshotDirection200Response */ 'status': string; /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof GetStocksSnapshotDirection200Response */ 'tickers'?: Array; } /** * * @export * @interface GetStocksSnapshotTicker200Response */ interface GetStocksSnapshotTicker200Response { /** * The status of this request\'s response. * @type {string} * @memberof GetStocksSnapshotTicker200Response */ 'status': string; /** * A request id assigned by the server. * @type {string} * @memberof GetStocksSnapshotTicker200Response */ 'request_id': string; /** * * @type {GetStocksSnapshotTicker200ResponseAllOfTicker} * @memberof GetStocksSnapshotTicker200Response */ 'ticker'?: GetStocksSnapshotTicker200ResponseAllOfTicker; } /** * Contains the requested snapshot data for the specified ticker. * @export * @interface GetStocksSnapshotTicker200ResponseAllOfTicker */ interface GetStocksSnapshotTicker200ResponseAllOfTicker { /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'day'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay; /** * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'fmv'?: number; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'lastQuote'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'lastTrade'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'min'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'prevDay'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'ticker'?: string; /** * The value of the change from the previous day. * @type {number} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'todaysChange'?: number; /** * The percentage change since the previous day. * @type {number} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'todaysChangePerc'?: number; /** * The last updated timestamp. * @type {number} * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ 'updated'?: number; } /** * * @export * @interface GetStocksSnapshotTickers200Response */ interface GetStocksSnapshotTickers200Response { /** * The total number of results for this request. * @type {number} * @memberof GetStocksSnapshotTickers200Response */ 'count'?: number; /** * The status of this request\'s response. * @type {string} * @memberof GetStocksSnapshotTickers200Response */ 'status': string; /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof GetStocksSnapshotTickers200Response */ 'tickers'?: Array; } /** * * @export * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInner */ interface GetStocksSnapshotTickers200ResponseAllOfTickersInner { /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'day'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay; /** * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'fmv'?: number; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'lastQuote'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'lastTrade'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'min'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin; /** * * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'prevDay'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'ticker'?: string; /** * The value of the change from the previous day. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'todaysChange'?: number; /** * The percentage change since the previous day. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'todaysChangePerc'?: number; /** * The last updated timestamp. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ 'updated'?: number; } /** * The most recent daily bar for this ticker. * @export * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'otc'?: boolean; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'vw': number; } /** * The most recent quote for this ticker. This is only returned if your current plan includes quotes. * @export * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote { /** * The ask price. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 'P': number; /** * The ask size in lots. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 'S': number; /** * The bid price. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 'p': number; /** * The bid size in lots. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 's': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ 't': number; } /** * The most recent trade for this ticker. This is only returned if your current plan includes trades. * @export * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade { /** * The trade conditions. * @type {Array} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'c': Array; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'i': string; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'p': number; /** * The size (volume) of the trade. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 's': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 't': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ 'x': number; } /** * The most recent minute bar for this ticker. * @export * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin { /** * The accumulated volume. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'av': number; /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'n': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'otc'?: boolean; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 'vw': number; } /** * The previous day\'s bar for this ticker. * @export * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay { /** * The close price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'otc'?: boolean; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ 'vw': number; } /** * * @export * @interface GetStocksTrades200Response */ interface GetStocksTrades200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof GetStocksTrades200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetStocksTrades200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof GetStocksTrades200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof GetStocksTrades200Response */ 'status': string; } /** * * @export * @interface GetStocksTrades200ResponseResultsInner */ interface GetStocksTrades200ResponseResultsInner { /** * A list of condition codes. * @type {Array} * @memberof GetStocksTrades200ResponseResultsInner */ 'conditions'?: Array; /** * The trade correction indicator. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'correction'?: number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'exchange': number; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof GetStocksTrades200ResponseResultsInner */ 'id': string; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'participant_timestamp': number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'price': number; /** * The sequence number represents the sequence in which trade events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'sequence_number': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'sip_timestamp': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'size': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'tape'?: number; /** * The ID for the Trade Reporting Facility where the trade took place. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'trf_id'?: number; /** * The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this trade. * @type {number} * @memberof GetStocksTrades200ResponseResultsInner */ 'trf_timestamp'?: number; } /** * * @export * @interface GetStocksV1ShortInterest200Response */ interface GetStocksV1ShortInterest200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetStocksV1ShortInterest200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetStocksV1ShortInterest200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetStocksV1ShortInterest200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetStocksV1ShortInterest200Response */ 'status': GetStocksV1ShortInterest200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetStocksV1ShortInterest200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetStocksV1ShortInterest200ResponseResultsInner */ interface GetStocksV1ShortInterest200ResponseResultsInner { /** * The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. * @type {number} * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ 'avg_daily_volume': number; /** * Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. * @type {number} * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ 'days_to_cover': number; /** * The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. * @type {string} * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ 'settlement_date': string; /** * The total number of shares that have been sold short but have not yet been covered or closed out. * @type {number} * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ 'short_interest'?: number; /** * The primary ticker symbol for the stock. * @type {string} * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ 'ticker'?: string; } /** * * @export * @interface GetStocksV1ShortVolume200Response */ interface GetStocksV1ShortVolume200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetStocksV1ShortVolume200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetStocksV1ShortVolume200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetStocksV1ShortVolume200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetStocksV1ShortVolume200Response */ 'status': GetStocksV1ShortVolume200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetStocksV1ShortVolume200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetStocksV1ShortVolume200ResponseResultsInner */ interface GetStocksV1ShortVolume200ResponseResultsInner { /** * Short volume reported via the Alternative Display Facility (ADF), excluding exempt volume. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'adf_short_volume'?: number; /** * Short volume reported via ADF that was marked as exempt. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'adf_short_volume_exempt'?: number; /** * The date of trade activity reported in the format YYYY-MM-DD * @type {string} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'date': string; /** * Portion of short volume that was marked as exempt from regulation SHO. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'exempt_volume'?: number; /** * Short volume reported from Nasdaq\'s Carteret facility, excluding exempt volume. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'nasdaq_carteret_short_volume'?: number; /** * Short volume from Nasdaq Carteret that was marked as exempt. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'nasdaq_carteret_short_volume_exempt'?: number; /** * Short volume reported from Nasdaq\'s Chicago facility, excluding exempt volume. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'nasdaq_chicago_short_volume'?: number; /** * Short volume from Nasdaq Chicago that was marked as exempt. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'nasdaq_chicago_short_volume_exempt'?: number; /** * Portion of short volume that was not exempt from regulation SHO (i.e., short_volume - exempt_volume). * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'non_exempt_volume'?: number; /** * Short volume reported from NYSE facilities, excluding exempt volume. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'nyse_short_volume'?: number; /** * Short volume from NYSE facilities that was marked as exempt. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'nyse_short_volume_exempt'?: number; /** * Total number of shares sold short across all venues for the ticker on the given date. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'short_volume'?: number; /** * The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'short_volume_ratio'?: number; /** * The primary ticker symbol for the stock. * @type {string} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'ticker'?: string; /** * Total reported volume across all venues for the ticker on the given date. * @type {number} * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ 'total_volume'?: number; } /** * * @export * @interface GetTicker200Response */ interface GetTicker200Response { /** * The total number of results for this request. * @type {number} * @memberof GetTicker200Response */ 'count'?: number; /** * A request id assigned by the server. * @type {string} * @memberof GetTicker200Response */ 'request_id'?: string; /** * * @type {GetTicker200ResponseResults} * @memberof GetTicker200Response */ 'results'?: GetTicker200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetTicker200Response */ 'status'?: string; } /** * Ticker with details. * @export * @interface GetTicker200ResponseResults */ interface GetTicker200ResponseResults { /** * Whether or not the asset is actively traded. False means the asset has been delisted. * @type {boolean} * @memberof GetTicker200ResponseResults */ 'active': boolean; /** * * @type {GetTicker200ResponseResultsAddress} * @memberof GetTicker200ResponseResults */ 'address'?: GetTicker200ResponseResultsAddress; /** * * @type {GetTicker200ResponseResultsBranding} * @memberof GetTicker200ResponseResults */ 'branding'?: GetTicker200ResponseResultsBranding; /** * The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key). * @type {string} * @memberof GetTicker200ResponseResults */ 'cik'?: string; /** * The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) * @type {string} * @memberof GetTicker200ResponseResults */ 'composite_figi'?: string; /** * The name of the currency that this asset is traded with. * @type {string} * @memberof GetTicker200ResponseResults */ 'currency_name': string; /** * The last date that the asset was traded. * @type {string} * @memberof GetTicker200ResponseResults */ 'delisted_utc'?: string; /** * A description of the company and what they do/offer. * @type {string} * @memberof GetTicker200ResponseResults */ 'description'?: string; /** * The URL of the company\'s website homepage. * @type {string} * @memberof GetTicker200ResponseResults */ 'homepage_url'?: string; /** * The date that the symbol was first publicly listed in the format YYYY-MM-DD. * @type {string} * @memberof GetTicker200ResponseResults */ 'list_date'?: string; /** * The locale of the asset. * @type {string} * @memberof GetTicker200ResponseResults */ 'locale': GetTicker200ResponseResultsLocaleEnum; /** * The market type of the asset. * @type {string} * @memberof GetTicker200ResponseResults */ 'market': GetTicker200ResponseResultsMarketEnum; /** * The most recent close price of the ticker multiplied by weighted outstanding shares. * @type {number} * @memberof GetTicker200ResponseResults */ 'market_cap'?: number; /** * The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair. * @type {string} * @memberof GetTicker200ResponseResults */ 'name': string; /** * The phone number for the company behind this ticker. * @type {string} * @memberof GetTicker200ResponseResults */ 'phone_number'?: string; /** * The Market Identifier Code (MIC) of the primary listing exchange for this asset (see [ISO 10383](https://www.iso20022.org/market-identifier-codes)). * @type {string} * @memberof GetTicker200ResponseResults */ 'primary_exchange'?: string; /** * Round lot size of this security. * @type {number} * @memberof GetTicker200ResponseResults */ 'round_lot'?: number; /** * The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) * @type {string} * @memberof GetTicker200ResponseResults */ 'share_class_figi'?: string; /** * The recorded number of outstanding shares for this particular share class. * @type {number} * @memberof GetTicker200ResponseResults */ 'share_class_shares_outstanding'?: number; /** * The standard industrial classification code for this ticker. For a list of SIC Codes, see the SEC\'s SIC Code List. * @type {string} * @memberof GetTicker200ResponseResults */ 'sic_code'?: string; /** * A description of this ticker\'s SIC code. * @type {string} * @memberof GetTicker200ResponseResults */ 'sic_description'?: string; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof GetTicker200ResponseResults */ 'ticker': string; /** * The root of a specified ticker. For example, the root of BRK.A is BRK. * @type {string} * @memberof GetTicker200ResponseResults */ 'ticker_root'?: string; /** * The suffix of a specified ticker. For example, the suffix of BRK.A is A. * @type {string} * @memberof GetTicker200ResponseResults */ 'ticker_suffix'?: string; /** * The approximate number of employees for the company. * @type {number} * @memberof GetTicker200ResponseResults */ 'total_employees'?: number; /** * The type of the asset. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). * @type {string} * @memberof GetTicker200ResponseResults */ 'type'?: string; /** * The shares outstanding calculated assuming all shares of other share classes are converted to this share class. * @type {number} * @memberof GetTicker200ResponseResults */ 'weighted_shares_outstanding'?: number; } /** * @export * @enum {string} */ declare enum GetTicker200ResponseResultsLocaleEnum { Us = "us", Global = "global" } /** * @export * @enum {string} */ declare enum GetTicker200ResponseResultsMarketEnum { Stocks = "stocks", Crypto = "crypto", Fx = "fx", Otc = "otc", Indices = "indices" } /** * Company headquarters address details. * @export * @interface GetTicker200ResponseResultsAddress */ interface GetTicker200ResponseResultsAddress { /** * The first line of the company\'s headquarters address. * @type {string} * @memberof GetTicker200ResponseResultsAddress */ 'address1'?: string; /** * The second line of the company\'s headquarters address, if applicable. * @type {string} * @memberof GetTicker200ResponseResultsAddress */ 'address2'?: string; /** * The city of the company\'s headquarters address. * @type {string} * @memberof GetTicker200ResponseResultsAddress */ 'city'?: string; /** * The postal code of the company\'s headquarters address. * @type {string} * @memberof GetTicker200ResponseResultsAddress */ 'postal_code'?: string; /** * The state of the company\'s headquarters address. * @type {string} * @memberof GetTicker200ResponseResultsAddress */ 'state'?: string; } /** * Provides URLs aiding in visual identification. * @export * @interface GetTicker200ResponseResultsBranding */ interface GetTicker200ResponseResultsBranding { /** * A link to this ticker\'s company\'s icon. Icon\'s are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. * @type {string} * @memberof GetTicker200ResponseResultsBranding */ 'icon_url'?: string; /** * A link to this ticker\'s company\'s logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. * @type {string} * @memberof GetTicker200ResponseResultsBranding */ 'logo_url'?: string; } /** * * @export * @interface GetTmxV1CorporateEvents200Response */ interface GetTmxV1CorporateEvents200Response { /** * If present, this value can be used to fetch the next page. * @type {string} * @memberof GetTmxV1CorporateEvents200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof GetTmxV1CorporateEvents200Response */ 'request_id': string; /** * The results for this request. * @type {Array} * @memberof GetTmxV1CorporateEvents200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof GetTmxV1CorporateEvents200Response */ 'status': GetTmxV1CorporateEvents200ResponseStatusEnum; } /** * @export * @enum {string} */ declare enum GetTmxV1CorporateEvents200ResponseStatusEnum { Ok = "OK" } /** * * @export * @interface GetTmxV1CorporateEvents200ResponseResultsInner */ interface GetTmxV1CorporateEvents200ResponseResultsInner { /** * Full name of the company. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'company_name'?: string; /** * Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'date'?: string; /** * Standard international identifier for the company\'s common stock. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'isin'?: string; /** * Name or title of the event. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'name'?: string; /** * The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'status'?: string; /** * The company\'s stock symbol. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'ticker'?: string; /** * Unique numeric identifier for the company used by TMX. * @type {number} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'tmx_company_id'?: number; /** * The unique alphanumeric identifier for the event record used by TMX. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'tmx_record_id'?: string; /** * MIC (Market Identifier Code) of the exchange where the company\'s stock is listed. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'trading_venue'?: string; /** * The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'type'?: string; /** * URL linking to the primary public source of the event announcement, if available. * @type {string} * @memberof GetTmxV1CorporateEvents200ResponseResultsInner */ 'url'?: string; } /** * * @export * @interface IndexAggsBase */ interface IndexAggsBase { /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof IndexAggsBase */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof IndexAggsBase */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof IndexAggsBase */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof IndexAggsBase */ 'status': string; } /** * * @export * @interface IndicesGroupedResults */ interface IndicesGroupedResults { /** * An array of results containing the requested data. * @type {Array} * @memberof IndicesGroupedResults */ 'results'?: Array; } /** * * @export * @interface IndicesOpenClose */ interface IndicesOpenClose { /** * The close value of the ticker symbol in after hours trading. * @type {number} * @memberof IndicesOpenClose */ 'afterHours'?: number; /** * The close value for the symbol in the given time period. * @type {number} * @memberof IndicesOpenClose */ 'close': number; /** * The requested date. * @type {string} * @memberof IndicesOpenClose */ 'from': string; /** * The highest value for the symbol in the given time period. * @type {number} * @memberof IndicesOpenClose */ 'high': number; /** * The lowest value for the symbol in the given time period. * @type {number} * @memberof IndicesOpenClose */ 'low': number; /** * The open value for the symbol in the given time period. * @type {number} * @memberof IndicesOpenClose */ 'open': number; /** * The open value of the ticker symbol in pre-market trading. * @type {number} * @memberof IndicesOpenClose */ 'preMarket'?: number; /** * The status of this request\'s response. * @type {string} * @memberof IndicesOpenClose */ 'status': string; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof IndicesOpenClose */ 'symbol': string; } /** * * @export * @interface IndicesTickerResults */ interface IndicesTickerResults { /** * An array of results containing the requested data. * @type {Array} * @memberof IndicesTickerResults */ 'results'?: Array; } /** * * @export * @interface IndicesTickerResultsResultsInner */ interface IndicesTickerResultsResultsInner { /** * The close value for the symbol in the given time period. * @type {number} * @memberof IndicesTickerResultsResultsInner */ 'c': number; /** * The highest value for the symbol in the given time period. * @type {number} * @memberof IndicesTickerResultsResultsInner */ 'h': number; /** * The lowest value for the symbol in the given time period. * @type {number} * @memberof IndicesTickerResultsResultsInner */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof IndicesTickerResultsResultsInner */ 'n'?: number; /** * The open value for the symbol in the given time period. * @type {number} * @memberof IndicesTickerResultsResultsInner */ 'o': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof IndicesTickerResultsResultsInner */ 't': number; } /** * * @export * @interface ListConditions200Response */ interface ListConditions200Response { /** * The total number of results for this request. * @type {number} * @memberof ListConditions200Response */ 'count': number; /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListConditions200Response */ 'next_url'?: string; /** * A request ID assigned by the server. * @type {string} * @memberof ListConditions200Response */ 'request_id': string; /** * An array of conditions that match your query. * @type {Array} * @memberof ListConditions200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof ListConditions200Response */ 'status': string; } /** * A condition generally refers to any extra information passed in a trade or a quote. These conditions may or may not affect the behavior of aggregates. * @export * @interface ListConditions200ResponseResultsInner */ interface ListConditions200ResponseResultsInner { /** * A commonly-used abbreviation for this condition. * @type {string} * @memberof ListConditions200ResponseResultsInner */ 'abbreviation'?: string; /** * An identifier for a group of similar financial instruments. * @type {string} * @memberof ListConditions200ResponseResultsInner */ 'asset_class': ListConditions200ResponseResultsInnerAssetClassEnum; /** * Data types that this condition applies to. * @type {Array} * @memberof ListConditions200ResponseResultsInner */ 'data_types': Array; /** * A short description of the semantics of this condition. * @type {string} * @memberof ListConditions200ResponseResultsInner */ 'description'?: string; /** * If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute. In other words, data with this condition attached comes exclusively from the given exchange. * @type {number} * @memberof ListConditions200ResponseResultsInner */ 'exchange'?: number; /** * An identifier used by Polygon.io for this condition. Unique per data type. * @type {number} * @memberof ListConditions200ResponseResultsInner */ 'id': number; /** * If true, this condition is from an old version of the SIPs\' specs and no longer is used. Other conditions may or may not reuse the same symbol as this one. * @type {boolean} * @memberof ListConditions200ResponseResultsInner */ 'legacy'?: boolean; /** * The name of this condition. * @type {string} * @memberof ListConditions200ResponseResultsInner */ 'name': string; /** * * @type {ListConditions200ResponseResultsInnerSipMapping} * @memberof ListConditions200ResponseResultsInner */ 'sip_mapping': ListConditions200ResponseResultsInnerSipMapping; /** * An identifier for a collection of related conditions. * @type {string} * @memberof ListConditions200ResponseResultsInner */ 'type': ListConditions200ResponseResultsInnerTypeEnum; /** * * @type {ListConditions200ResponseResultsInnerUpdateRules} * @memberof ListConditions200ResponseResultsInner */ 'update_rules'?: ListConditions200ResponseResultsInnerUpdateRules; } /** * @export * @enum {string} */ declare enum ListConditions200ResponseResultsInnerAssetClassEnum { Stocks = "stocks", Options = "options", Crypto = "crypto", Fx = "fx" } /** * @export * @enum {string} */ declare enum ListConditions200ResponseResultsInnerDataTypesEnum { Trade = "trade", Bbo = "bbo", Nbbo = "nbbo" } /** * @export * @enum {string} */ declare enum ListConditions200ResponseResultsInnerTypeEnum { SaleCondition = "sale_condition", QuoteCondition = "quote_condition", SipGeneratedFlag = "sip_generated_flag", FinancialStatusIndicator = "financial_status_indicator", ShortSaleRestrictionIndicator = "short_sale_restriction_indicator", SettlementCondition = "settlement_condition", MarketCondition = "market_condition", TradeThruExempt = "trade_thru_exempt" } /** * A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Polygon.io. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting. * @export * @interface ListConditions200ResponseResultsInnerSipMapping */ interface ListConditions200ResponseResultsInnerSipMapping { /** * Condition code from the Consolidated Tape Association (CTA). * @type {string} * @memberof ListConditions200ResponseResultsInnerSipMapping */ 'CTA'?: string; /** * Condition code from the Options Price Reporting Authority (OPRA). * @type {string} * @memberof ListConditions200ResponseResultsInnerSipMapping */ 'OPRA'?: string; /** * Condition code from UTP Plan (UTP). * @type {string} * @memberof ListConditions200ResponseResultsInnerSipMapping */ 'UTP'?: string; } /** * A list of aggregation rules. * @export * @interface ListConditions200ResponseResultsInnerUpdateRules */ interface ListConditions200ResponseResultsInnerUpdateRules { /** * * @type {ListConditions200ResponseResultsInnerUpdateRulesConsolidated} * @memberof ListConditions200ResponseResultsInnerUpdateRules */ 'consolidated': ListConditions200ResponseResultsInnerUpdateRulesConsolidated; /** * * @type {ListConditions200ResponseResultsInnerUpdateRulesMarketCenter} * @memberof ListConditions200ResponseResultsInnerUpdateRules */ 'market_center': ListConditions200ResponseResultsInnerUpdateRulesMarketCenter; } /** * Describes aggregation rules on a consolidated (all exchanges) basis. * @export * @interface ListConditions200ResponseResultsInnerUpdateRulesConsolidated */ interface ListConditions200ResponseResultsInnerUpdateRulesConsolidated { /** * Whether or not trades with this condition update the high/low. * @type {boolean} * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated */ 'updates_high_low': boolean; /** * Whether or not trades with this condition update the open/close. * @type {boolean} * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated */ 'updates_open_close': boolean; /** * Whether or not trades with this condition update the volume. * @type {boolean} * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated */ 'updates_volume': boolean; } /** * Describes aggregation rules on a per-market-center basis. * @export * @interface ListConditions200ResponseResultsInnerUpdateRulesMarketCenter */ interface ListConditions200ResponseResultsInnerUpdateRulesMarketCenter { /** * Whether or not trades with this condition update the high/low. * @type {boolean} * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter */ 'updates_high_low': boolean; /** * Whether or not trades with this condition update the open/close. * @type {boolean} * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter */ 'updates_open_close': boolean; /** * Whether or not trades with this condition update the volume. * @type {boolean} * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter */ 'updates_volume': boolean; } /** * * @export * @interface ListConditions400Response */ interface ListConditions400Response { /** * The total number of results for this request. * @type {number} * @memberof ListConditions400Response */ 'count': number; /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListConditions400Response */ 'next_url'?: string; /** * A request ID assigned by the server. * @type {string} * @memberof ListConditions400Response */ 'request_id': string; /** * An array of conditions that match your query. * @type {Array} * @memberof ListConditions400Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof ListConditions400Response */ 'status': string; } /** * A list of dividends. * @export * @interface ListDividends200Response */ interface ListDividends200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListDividends200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof ListDividends200Response */ 'request_id': string; /** * An array of results containing the requested data. * @type {Array} * @memberof ListDividends200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListDividends200Response */ 'status'?: string; } /** * * @export * @interface ListDividends200ResponseResultsInner */ interface ListDividends200ResponseResultsInner { /** * The cash amount of the dividend per share owned. * @type {number} * @memberof ListDividends200ResponseResultsInner */ 'cash_amount': number; /** * The currency in which the dividend is paid. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'currency'?: string; /** * The date that the dividend was announced. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'declaration_date'?: string; /** * The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. Long-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'dividend_type': ListDividends200ResponseResultsInnerDividendTypeEnum; /** * The date that the stock first trades without the dividend, determined by the exchange. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'ex_dividend_date': string; /** * The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly). * @type {number} * @memberof ListDividends200ResponseResultsInner */ 'frequency': number; /** * The unique identifier of the dividend. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'id': string; /** * The date that the dividend is paid out. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'pay_date'?: string; /** * The date that the stock must be held to receive the dividend, set by the company. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'record_date'?: string; /** * The ticker symbol of the dividend. * @type {string} * @memberof ListDividends200ResponseResultsInner */ 'ticker': string; } /** * @export * @enum {string} */ declare enum ListDividends200ResponseResultsInnerDividendTypeEnum { Cd = "CD", Sc = "SC", Lt = "LT", St = "ST" } /** * * @export * @interface ListExchanges200Response */ interface ListExchanges200Response { /** * The total number of results for this request. * @type {number} * @memberof ListExchanges200Response */ 'count'?: number; /** * A request ID assigned by the server. * @type {string} * @memberof ListExchanges200Response */ 'request_id': string; /** * An array of results containing the requested data. * @type {Array} * @memberof ListExchanges200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListExchanges200Response */ 'status': string; } /** * An entity that reports trades. * @export * @interface ListExchanges200ResponseResultsInner */ interface ListExchanges200ResponseResultsInner { /** * A commonly used abbreviation for this exchange. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'acronym'?: string; /** * An identifier for a group of similar financial instruments. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'asset_class': ListExchanges200ResponseResultsInnerAssetClassEnum; /** * A unique identifier used by Polygon.io for this exchange. * @type {number} * @memberof ListExchanges200ResponseResultsInner */ 'id': number; /** * An identifier for a geographical location. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'locale': ListExchanges200ResponseResultsInnerLocaleEnum; /** * The Market Identifier Code of this exchange (see ISO 10383). * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'mic'?: string; /** * Name of this exchange. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'name': string; /** * The MIC of the entity that operates this exchange. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'operating_mic'?: string; /** * The ID used by SIP\'s to represent this exchange. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'participant_id'?: string; /** * Represents the type of exchange. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'type': ListExchanges200ResponseResultsInnerTypeEnum; /** * A link to this exchange\'s website, if one exists. * @type {string} * @memberof ListExchanges200ResponseResultsInner */ 'url'?: string; } /** * @export * @enum {string} */ declare enum ListExchanges200ResponseResultsInnerAssetClassEnum { Stocks = "stocks", Options = "options", Crypto = "crypto", Fx = "fx", Futures = "futures" } /** * @export * @enum {string} */ declare enum ListExchanges200ResponseResultsInnerLocaleEnum { Us = "us", Global = "global" } /** * @export * @enum {string} */ declare enum ListExchanges200ResponseResultsInnerTypeEnum { Exchange = "exchange", Trf = "TRF", Sip = "SIP" } /** * * @export * @interface ListExchanges400Response */ interface ListExchanges400Response { /** * The total number of results for this request. * @type {number} * @memberof ListExchanges400Response */ 'count'?: number; /** * A request ID assigned by the server. * @type {string} * @memberof ListExchanges400Response */ 'request_id': string; /** * The status of this request\'s response. * @type {string} * @memberof ListExchanges400Response */ 'status': string; } /** * * @export * @interface ListFinancials200Response */ interface ListFinancials200Response { /** * The total number of results for this request. * @type {number} * @memberof ListFinancials200Response */ 'count': number; /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListFinancials200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof ListFinancials200Response */ 'request_id': string; /** * An array of results containing the requested data. * @type {Array} * @memberof ListFinancials200Response */ 'results': Array; /** * The status of this request\'s response. * @type {string} * @memberof ListFinancials200Response */ 'status': string; } /** * * @export * @interface ListFinancials200ResponseResultsInner */ interface ListFinancials200ResponseResultsInner { /** * The datetime (EST timezone) the filing was accepted by EDGAR in YYYYMMDDHHMMSS format. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'acceptance_datetime'?: string; /** * The CIK number for the company. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'cik': string; /** * The company name. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'company_name': string; /** * The end date of the period that these financials cover in YYYYMMDD format. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'end_date'?: string; /** * The date that the SEC filing which these financials were derived from was made available. Note that this is not necessarily the date when this information became public, as some companies may publish a press release before filing with the SEC. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'filing_date'?: string; /** * * @type {ListFinancials200ResponseResultsInnerFinancials} * @memberof ListFinancials200ResponseResultsInner */ 'financials': ListFinancials200ResponseResultsInnerFinancials; /** * Fiscal period of the report according to the company (Q1, Q2, Q3, Q4, or FY). * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'fiscal_period': string; /** * Fiscal year of the report according to the company. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'fiscal_year'?: string; /** * The Standard Industrial Classification (SIC) code for the company. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'sic'?: string; /** * The URL of the specific XBRL instance document within the SEC filing that these financials were derived from. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'source_filing_file_url'?: string; /** * The URL of the SEC filing that these financials were derived from. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'source_filing_url'?: string; /** * The start date of the period that these financials cover in YYYYMMDD format. * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'start_date'?: string; /** * The list of ticker symbols for the company. * @type {Array} * @memberof ListFinancials200ResponseResultsInner */ 'tickers'?: Array; /** * The timeframe of the report (quarterly, annual or ttm). * @type {string} * @memberof ListFinancials200ResponseResultsInner */ 'timeframe': string; } /** * Structured financial statements with detailed data points and metadata. * @export * @interface ListFinancials200ResponseResultsInnerFinancials */ interface ListFinancials200ResponseResultsInnerFinancials { /** * * @type {ListFinancials200ResponseResultsInnerFinancialsBalanceSheet} * @memberof ListFinancials200ResponseResultsInnerFinancials */ 'balance_sheet'?: ListFinancials200ResponseResultsInnerFinancialsBalanceSheet; /** * Cash flow statement. The keys in this object can be any of the fields listed in the Cash Flow Statement section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. * @type {object} * @memberof ListFinancials200ResponseResultsInnerFinancials */ 'cash_flow_statement'?: object; /** * Comprehensive income. The keys in this object can be any of the fields listed in the Comprehensive Income section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. * @type {object} * @memberof ListFinancials200ResponseResultsInnerFinancials */ 'comprehensive_income'?: object; /** * Income statement. The keys in this object can be any of the fields listed in the Income Statement section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. * @type {object} * @memberof ListFinancials200ResponseResultsInnerFinancials */ 'income_statement'?: object; } /** * Balance sheet. The keys in this object can be any of the fields listed in the Balance Sheet section of the financials API glossary of terms. * @export * @interface ListFinancials200ResponseResultsInnerFinancialsBalanceSheet */ interface ListFinancials200ResponseResultsInnerFinancialsBalanceSheet { /** * * @type {ListFinancials200ResponseResultsInnerFinancialsBalanceSheet} * @memberof ListFinancials200ResponseResultsInnerFinancialsBalanceSheet */ '*'?: ListFinancials200ResponseResultsInnerFinancialsBalanceSheet; } /** * * @export * @interface ListIPOs200Response */ interface ListIPOs200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListIPOs200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof ListIPOs200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof ListIPOs200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListIPOs200Response */ 'status'?: string; } /** * * @export * @interface ListIPOs200ResponseResultsInner */ interface ListIPOs200ResponseResultsInner { /** * The date when the IPO event was announced. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'announced_date'?: string; /** * Underlying currency of the security. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'currency_code'?: string; /** * The price set by the company and its underwriters before the IPO goes live. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'final_issue_price'?: number; /** * The highest price within the IPO price range that the company might use to price the shares. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'highest_offer_price'?: number; /** * The status of the IPO event. IPO events start out as status \"rumor\" or \"pending\". On listing day, the status changes to \"new\". After the listing day, the status changes to \"history\". The status \"direct_listing_process\" corresponds to a type of offering where, instead of going through all the IPO processes, the company decides to list its shares directly on an exchange, without using an investment bank or other intermediaries. This is called a direct listing, direct placement, or direct public offering (DPO). * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'ipo_status': ListIPOs200ResponseResultsInnerIpoStatusEnum; /** * International Securities Identification Number. This is a unique twelve-digit code that is assigned to every security issuance in the world. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'isin'?: string; /** * Name of issuer. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'issuer_name': string; /** * The date when the IPO event was last modified. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'last_updated': string; /** * First trading date for the newly listed entity. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'listing_date'?: string; /** * The minimum number of shares that can be bought or sold in a single transaction. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'lot_size'?: number; /** * The lowest price within the IPO price range that the company is willing to offer its shares to investors. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'lowest_offer_price'?: number; /** * The upper limit of the shares that the company is offering to investors. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'max_shares_offered'?: number; /** * The lower limit of shares that the company is willing to sell in the IPO. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'min_shares_offered'?: number; /** * Market Identifier Code (MIC) of the primary exchange where the security is listed. The Market Identifier Code (MIC) (ISO 10383) is a unique identification code used to identify securities trading exchanges, regulated and non-regulated trading markets. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'primary_exchange'?: string; /** * Description of the security. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'security_description'?: string; /** * The classification of the stock. For example, \"CS\" stands for Common Stock. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'security_type': string; /** * The total number of shares that the company has issued and are held by investors. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'shares_outstanding'?: number; /** * The ticker symbol of the IPO event. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'ticker': string; /** * The total amount raised by the company for IPO. * @type {number} * @memberof ListIPOs200ResponseResultsInner */ 'total_offer_size'?: number; /** * This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. * @type {string} * @memberof ListIPOs200ResponseResultsInner */ 'us_code'?: string; } /** * @export * @enum {string} */ declare enum ListIPOs200ResponseResultsInnerIpoStatusEnum { DirectListingProcess = "direct_listing_process", History = "history", New = "new", Pending = "pending", Postponed = "postponed", Rumor = "rumor", Withdrawn = "withdrawn" } /** * * @export * @interface ListNews200Response */ interface ListNews200Response { /** * The total number of results for this request. * @type {number} * @memberof ListNews200Response */ 'count'?: number; /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListNews200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof ListNews200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof ListNews200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListNews200Response */ 'status'?: string; } /** * * @export * @interface ListNews200ResponseResultsInner */ interface ListNews200ResponseResultsInner { /** * The mobile friendly Accelerated Mobile Page (AMP) URL. * @type {string} * @memberof ListNews200ResponseResultsInner */ 'amp_url'?: string; /** * A link to the news article. * @type {string} * @memberof ListNews200ResponseResultsInner */ 'article_url': string; /** * The article\'s author. * @type {string} * @memberof ListNews200ResponseResultsInner */ 'author': string; /** * A description of the article. * @type {string} * @memberof ListNews200ResponseResultsInner */ 'description'?: string; /** * Unique identifier for the article. * @type {string} * @memberof ListNews200ResponseResultsInner */ 'id': string; /** * The article\'s image URL. * @type {string} * @memberof ListNews200ResponseResultsInner */ 'image_url'?: string; /** * The insights related to the article. * @type {Array} * @memberof ListNews200ResponseResultsInner */ 'insights'?: Array; /** * The keywords associated with the article (which will vary depending on the publishing source). * @type {Array} * @memberof ListNews200ResponseResultsInner */ 'keywords'?: Array; /** * The UTC date and time when the article was published, formatted in RFC3339 standard (e.g. YYYY-MM-DDTHH:MM:SSZ). * @type {string} * @memberof ListNews200ResponseResultsInner */ 'published_utc': string; /** * * @type {ListNews200ResponseResultsInnerPublisher} * @memberof ListNews200ResponseResultsInner */ 'publisher': ListNews200ResponseResultsInnerPublisher; /** * The ticker symbols associated with the article. * @type {Array} * @memberof ListNews200ResponseResultsInner */ 'tickers': Array; /** * The title of the news article. * @type {string} * @memberof ListNews200ResponseResultsInner */ 'title': string; } /** * * @export * @interface ListNews200ResponseResultsInnerInsightsInner */ interface ListNews200ResponseResultsInnerInsightsInner { /** * The sentiment of the insight. * @type {string} * @memberof ListNews200ResponseResultsInnerInsightsInner */ 'sentiment': ListNews200ResponseResultsInnerInsightsInnerSentimentEnum; /** * The reasoning behind the sentiment. * @type {string} * @memberof ListNews200ResponseResultsInnerInsightsInner */ 'sentiment_reasoning': string; /** * The ticker symbol associated with the insight. * @type {string} * @memberof ListNews200ResponseResultsInnerInsightsInner */ 'ticker': string; } /** * @export * @enum {string} */ declare enum ListNews200ResponseResultsInnerInsightsInnerSentimentEnum { Positive = "positive", Neutral = "neutral", Negative = "negative" } /** * Details the source of the news article, including the publisher\'s name, logo, and homepage URLs. This information helps users identify and access the original source of news content. * @export * @interface ListNews200ResponseResultsInnerPublisher */ interface ListNews200ResponseResultsInnerPublisher { /** * The publisher\'s homepage favicon URL. * @type {string} * @memberof ListNews200ResponseResultsInnerPublisher */ 'favicon_url'?: string; /** * The publisher\'s homepage URL. * @type {string} * @memberof ListNews200ResponseResultsInnerPublisher */ 'homepage_url': string; /** * The publisher\'s logo URL. * @type {string} * @memberof ListNews200ResponseResultsInnerPublisher */ 'logo_url': string; /** * The publisher\'s name. * @type {string} * @memberof ListNews200ResponseResultsInnerPublisher */ 'name': string; } /** * @type ListNewsPublishedUtcParameter * @export */ declare type ListNewsPublishedUtcParameter = string; /** * * @export * @interface ListOptionsContracts200Response */ interface ListOptionsContracts200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListOptionsContracts200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof ListOptionsContracts200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof ListOptionsContracts200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListOptionsContracts200Response */ 'status'?: string; } /** * Contains the requested data for the specified options contract. * @export * @interface ListOptionsContracts200ResponseResultsInner */ interface ListOptionsContracts200ResponseResultsInner { /** * If an option contract has additional underlyings or deliverables associated with it, they will appear here. See here for some examples of what might cause a contract to have additional underlyings. * @type {Array} * @memberof ListOptionsContracts200ResponseResultsInner */ 'additional_underlyings'?: Array; /** * The 6 letter CFI code of the contract (defined in ISO 10962) * @type {string} * @memberof ListOptionsContracts200ResponseResultsInner */ 'cfi'?: string; /** * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". * @type {string} * @memberof ListOptionsContracts200ResponseResultsInner */ 'contract_type'?: string; /** * The correction number for this option contract. * @type {number} * @memberof ListOptionsContracts200ResponseResultsInner */ 'correction'?: number; /** * The exercise style of this contract. See this link for more details on exercise styles. * @type {string} * @memberof ListOptionsContracts200ResponseResultsInner */ 'exercise_style'?: ListOptionsContracts200ResponseResultsInnerExerciseStyleEnum; /** * The contract\'s expiration date in YYYY-MM-DD format. * @type {string} * @memberof ListOptionsContracts200ResponseResultsInner */ 'expiration_date'?: string; /** * The MIC code of the primary exchange that this contract is listed on. * @type {string} * @memberof ListOptionsContracts200ResponseResultsInner */ 'primary_exchange'?: string; /** * The number of shares per contract for this contract. * @type {number} * @memberof ListOptionsContracts200ResponseResultsInner */ 'shares_per_contract'?: number; /** * The strike price of the option contract. * @type {number} * @memberof ListOptionsContracts200ResponseResultsInner */ 'strike_price'?: number; /** * The ticker for the option contract. * @type {string} * @memberof ListOptionsContracts200ResponseResultsInner */ 'ticker'?: string; /** * The underlying ticker that the option contract relates to. * @type {string} * @memberof ListOptionsContracts200ResponseResultsInner */ 'underlying_ticker'?: string; } /** * @export * @enum {string} */ declare enum ListOptionsContracts200ResponseResultsInnerExerciseStyleEnum { American = "american", European = "european", Bermudan = "bermudan" } /** * * @export * @interface ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner */ interface ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner { /** * The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency. * @type {number} * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner */ 'amount'?: number; /** * The type of the additional underlying asset, either equity or currency. * @type {string} * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner */ 'type'?: string; /** * The name of the additional underlying asset. * @type {string} * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner */ 'underlying'?: string; } /** * * @export * @interface ListStockSplits200Response */ interface ListStockSplits200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListStockSplits200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof ListStockSplits200Response */ 'request_id'?: string; /** * An array of results containing the requested data. * @type {Array} * @memberof ListStockSplits200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListStockSplits200Response */ 'status'?: string; } /** * * @export * @interface ListStockSplits200ResponseResultsInner */ interface ListStockSplits200ResponseResultsInner { /** * The execution date of the stock split. On this date the stock split was applied. * @type {string} * @memberof ListStockSplits200ResponseResultsInner */ 'execution_date': string; /** * The unique identifier for this stock split. * @type {string} * @memberof ListStockSplits200ResponseResultsInner */ 'id': string; /** * The second number in the split ratio. For example: In a 2-for-1 split, split_from would be 1. * @type {number} * @memberof ListStockSplits200ResponseResultsInner */ 'split_from': number; /** * The first number in the split ratio. For example: In a 2-for-1 split, split_to would be 2. * @type {number} * @memberof ListStockSplits200ResponseResultsInner */ 'split_to': number; /** * The ticker symbol of the stock split. * @type {string} * @memberof ListStockSplits200ResponseResultsInner */ 'ticker': string; } /** * * @export * @interface ListTickerTypes200Response */ interface ListTickerTypes200Response { /** * The total number of results for this request. * @type {number} * @memberof ListTickerTypes200Response */ 'count'?: number; /** * A request ID assigned by the server. * @type {string} * @memberof ListTickerTypes200Response */ 'request_id': string; /** * * @type {Array} * @memberof ListTickerTypes200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListTickerTypes200Response */ 'status': string; } /** * Describes the type of financial instrument represented by a ticker. * @export * @interface ListTickerTypes200ResponseResultsInner */ interface ListTickerTypes200ResponseResultsInner { /** * An identifier for a group of similar financial instruments. * @type {string} * @memberof ListTickerTypes200ResponseResultsInner */ 'asset_class': ListTickerTypes200ResponseResultsInnerAssetClassEnum; /** * A code used by Polygon.io to refer to this ticker type. * @type {string} * @memberof ListTickerTypes200ResponseResultsInner */ 'code': string; /** * A short description of this ticker type. * @type {string} * @memberof ListTickerTypes200ResponseResultsInner */ 'description': string; /** * An identifier for a geographical location. * @type {string} * @memberof ListTickerTypes200ResponseResultsInner */ 'locale': ListTickerTypes200ResponseResultsInnerLocaleEnum; } /** * @export * @enum {string} */ declare enum ListTickerTypes200ResponseResultsInnerAssetClassEnum { Stocks = "stocks", Options = "options", Crypto = "crypto", Fx = "fx", Indices = "indices" } /** * @export * @enum {string} */ declare enum ListTickerTypes200ResponseResultsInnerLocaleEnum { Us = "us", Global = "global" } /** * * @export * @interface ListTickers200Response */ interface ListTickers200Response { /** * The total number of results for this request. * @type {number} * @memberof ListTickers200Response */ 'count'?: number; /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof ListTickers200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} * @memberof ListTickers200Response */ 'request_id'?: string; /** * An array of tickers that match your query. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. * @type {Array} * @memberof ListTickers200Response */ 'results'?: Array; /** * The status of this request\'s response. * @type {string} * @memberof ListTickers200Response */ 'status'?: string; } /** * * @export * @interface ListTickers200ResponseResultsInner */ interface ListTickers200ResponseResultsInner { /** * Whether or not the asset is actively traded. False means the asset has been delisted. * @type {boolean} * @memberof ListTickers200ResponseResultsInner */ 'active'?: boolean; /** * The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key). * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'cik'?: string; /** * The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'composite_figi'?: string; /** * The name of the currency that this asset is traded with. * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'currency_name'?: string; /** * The last date that the asset was traded. * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'delisted_utc'?: string; /** * The information is accurate up to this time. * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'last_updated_utc'?: string; /** * The locale of the asset. * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'locale': ListTickers200ResponseResultsInnerLocaleEnum; /** * The market type of the asset. * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'market': ListTickers200ResponseResultsInnerMarketEnum; /** * The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair. * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'name': string; /** * The Market Identifier Code (MIC) of the primary listing exchange for this asset (see [ISO 10383](https://www.iso20022.org/market-identifier-codes)). * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'primary_exchange'?: string; /** * The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'share_class_figi'?: string; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'ticker': string; /** * The type of the asset. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). * @type {string} * @memberof ListTickers200ResponseResultsInner */ 'type'?: string; } /** * @export * @enum {string} */ declare enum ListTickers200ResponseResultsInnerLocaleEnum { Us = "us", Global = "global" } /** * @export * @enum {string} */ declare enum ListTickers200ResponseResultsInnerMarketEnum { Stocks = "stocks", Crypto = "crypto", Fx = "fx", Otc = "otc", Indices = "indices" } /** * * @export * @interface Locales */ interface Locales { /** * * @type {Array} * @memberof Locales */ 'results'?: Array; } /** * * @export * @interface LocalesResultsInner */ interface LocalesResultsInner { /** * An abbreviated country name. * @type {string} * @memberof LocalesResultsInner */ 'locale'?: string; /** * The name of the country. * @type {string} * @memberof LocalesResultsInner */ 'name'?: string; } /** * A dynamic key from the results set * @export * @interface MapKey */ interface MapKey { /** * The descriptive name of this results key * @type {string} * @memberof MapKey */ 'name'?: string; /** * The data type of this results key * @type {string} * @memberof MapKey */ 'type'?: MapKeyTypeEnum; } /** * @export * @enum {string} */ declare enum MapKeyTypeEnum { String = "string", Int = "int", Int64 = "int64", Float64 = "float64" } /** * * @export * @interface MarketHolidayInner */ interface MarketHolidayInner { /** * The market close time on the holiday (if it\'s not closed). * @type {string} * @memberof MarketHolidayInner */ 'close'?: string; /** * The date of the holiday. * @type {string} * @memberof MarketHolidayInner */ 'date': string; /** * Which market the record is for. * @type {string} * @memberof MarketHolidayInner */ 'exchange': string; /** * The name of the holiday. * @type {string} * @memberof MarketHolidayInner */ 'name': string; /** * The market open time on the holiday (if it\'s not closed). * @type {string} * @memberof MarketHolidayInner */ 'open'?: string; /** * The status of the market on the holiday. * @type {string} * @memberof MarketHolidayInner */ 'status': string; } /** * * @export * @interface MarketStatus */ interface MarketStatus { /** * Whether or not the market is in post-market hours. * @type {boolean} * @memberof MarketStatus */ 'afterHours'?: boolean; /** * * @type {MarketStatusCurrencies} * @memberof MarketStatus */ 'currencies'?: MarketStatusCurrencies; /** * Whether or not the market is in pre-market hours. * @type {boolean} * @memberof MarketStatus */ 'earlyHours'?: boolean; /** * * @type {MarketStatusExchanges} * @memberof MarketStatus */ 'exchanges'?: MarketStatusExchanges; /** * The status of the market as a whole. * @type {string} * @memberof MarketStatus */ 'market'?: string; /** * The current time of the server. * @type {string} * @memberof MarketStatus */ 'serverTime'?: string; } /** * * @export * @interface MarketStatusCurrencies */ interface MarketStatusCurrencies { /** * The status of the crypto market. * @type {string} * @memberof MarketStatusCurrencies */ 'crypto'?: string; /** * The status of the forex market. * @type {string} * @memberof MarketStatusCurrencies */ 'fx'?: string; } /** * * @export * @interface MarketStatusExchanges */ interface MarketStatusExchanges { /** * The status of the Nasdaq market. * @type {string} * @memberof MarketStatusExchanges */ 'nasdaq'?: string; /** * The status of the NYSE market. * @type {string} * @memberof MarketStatusExchanges */ 'nyse'?: string; /** * The status of the OTC market. * @type {string} * @memberof MarketStatusExchanges */ 'otc'?: string; } /** * * @export * @interface Markets */ interface Markets { /** * A list of supported markets. * @type {Array} * @memberof Markets */ 'results'?: Array; } /** * * @export * @interface MarketsResultsInner */ interface MarketsResultsInner { /** * A description of the market. * @type {string} * @memberof MarketsResultsInner */ 'desc'?: string; /** * The name of the market. * @type {string} * @memberof MarketsResultsInner */ 'market'?: string; } /** * @type ModelDate * @export */ declare type ModelDate = string; /** * A mapping of the keys returned in the results to their descriptive name and data types. * @export * @interface ModelMap */ interface ModelMap { /** * * @type {MapKey} * @memberof ModelMap */ 'key'?: MapKey; } /** * * @export * @interface NewsInner */ interface NewsInner { /** * A URL of the image for the news article, if found. * @type {string} * @memberof NewsInner */ 'image'?: string; /** * A list of common keywords related to the news article. * @type {Array} * @memberof NewsInner */ 'keywords'?: Array; /** * The publication source of the article. * @type {string} * @memberof NewsInner */ 'source'?: string; /** * A summary of the news article. * @type {string} * @memberof NewsInner */ 'summary'?: string; /** * A list of ticker symbols relating to the article. * @type {Array} * @memberof NewsInner */ 'symbols'?: Array; /** * The timestamp of the news article. * @type {string} * @memberof NewsInner */ 'timestamp'?: string; /** * The title of the news article. * @type {string} * @memberof NewsInner */ 'title'?: string; /** * A direct link to the news article from its source publication. * @type {string} * @memberof NewsInner */ 'url'?: string; } /** * * @export * @interface PaginationHooksBase */ interface PaginationHooksBase { /** * If present, this value can be used to fetch the next page of data. * @type {string} * @memberof PaginationHooksBase */ 'next_url'?: string; } /** * * @export * @interface RatingSection */ interface RatingSection { /** * Analyst Rating at current month * @type {number} * @memberof RatingSection */ 'current': number; /** * Analyst Ratings at 1 month in the future * @type {number} * @memberof RatingSection */ 'month1': number; /** * Analyst Ratings at 2 month in the future * @type {number} * @memberof RatingSection */ 'month2': number; /** * Analyst Ratings at 3 month in the future * @type {number} * @memberof RatingSection */ 'month3': number; /** * Analyst Ratings at 4 month in the future * @type {number} * @memberof RatingSection */ 'month4'?: number; /** * Analyst Ratings at 5 month in the future * @type {number} * @memberof RatingSection */ 'month5'?: number; } /** * * @export * @interface RequestIdBase */ interface RequestIdBase { /** * A request id assigned by the server. * @type {string} * @memberof RequestIdBase */ 'request_id': string; } /** * * @export * @interface SnapshotMinOHLCV */ interface SnapshotMinOHLCV { /** * The close price for the symbol in the given time period. * @type {number} * @memberof SnapshotMinOHLCV */ 'c'?: number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof SnapshotMinOHLCV */ 'h'?: number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof SnapshotMinOHLCV */ 'l'?: number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof SnapshotMinOHLCV */ 'n'?: number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof SnapshotMinOHLCV */ 'o'?: number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof SnapshotMinOHLCV */ 't'?: number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof SnapshotMinOHLCV */ 'v'?: number; } /** * * @export * @interface SnapshotOHLCV */ interface SnapshotOHLCV { /** * The close price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCV */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCV */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCV */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCV */ 'o': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCV */ 'v': number; } /** * * @export * @interface SnapshotOHLCVVW */ interface SnapshotOHLCVVW { /** * The close price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVW */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVW */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVW */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVW */ 'o': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVW */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof SnapshotOHLCVVW */ 'vw': number; } /** * * @export * @interface SnapshotOHLCVVWOtc */ interface SnapshotOHLCVVWOtc { /** * The close price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVWOtc */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVWOtc */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVWOtc */ 'l': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVWOtc */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof SnapshotOHLCVVWOtc */ 'otc'?: boolean; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof SnapshotOHLCVVWOtc */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof SnapshotOHLCVVWOtc */ 'vw': number; } /** * * @export * @interface StandardBase */ interface StandardBase { /** * A request id assigned by the server. * @type {string} * @memberof StandardBase */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof StandardBase */ 'count'?: number; /** * The status of this request\'s response. * @type {string} * @memberof StandardBase */ 'status': string; } /** * * @export * @interface StatusBase */ interface StatusBase { /** * The status of this request\'s response. * @type {string} * @memberof StatusBase */ 'status': string; } /** * * @export * @interface StatusCountBase */ interface StatusCountBase { /** * The total number of results for this request. * @type {number} * @memberof StatusCountBase */ 'count'?: number; /** * The status of this request\'s response. * @type {string} * @memberof StatusCountBase */ 'status': string; } /** * * @export * @interface StocksGroupedResults */ interface StocksGroupedResults { /** * An array of results containing the requested data. * @type {Array} * @memberof StocksGroupedResults */ 'results'?: Array; } /** * * @export * @interface StocksOpenClose */ interface StocksOpenClose { /** * The close price of the ticker symbol in after hours trading. * @type {number} * @memberof StocksOpenClose */ 'afterHours'?: number; /** * The close price for the symbol in the given time period. * @type {number} * @memberof StocksOpenClose */ 'close': number; /** * The requested date. * @type {string} * @memberof StocksOpenClose */ 'from': string; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof StocksOpenClose */ 'high': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof StocksOpenClose */ 'low': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof StocksOpenClose */ 'open': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof StocksOpenClose */ 'otc'?: boolean; /** * The open price of the ticker symbol in pre-market trading. * @type {number} * @memberof StocksOpenClose */ 'preMarket'?: number; /** * The status of this request\'s response. * @type {string} * @memberof StocksOpenClose */ 'status': string; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof StocksOpenClose */ 'symbol': string; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof StocksOpenClose */ 'volume': number; } /** * * @export * @interface StocksSnapshotLastQuote */ interface StocksSnapshotLastQuote { /** * The ask price. * @type {number} * @memberof StocksSnapshotLastQuote */ 'P': number; /** * The ask size in lots. * @type {number} * @memberof StocksSnapshotLastQuote */ 'S': number; /** * The bid price. * @type {number} * @memberof StocksSnapshotLastQuote */ 'p': number; /** * The bid size in lots. * @type {number} * @memberof StocksSnapshotLastQuote */ 's': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof StocksSnapshotLastQuote */ 't': number; } /** * * @export * @interface StocksSnapshotMinute */ interface StocksSnapshotMinute { /** * The accumulated volume. * @type {number} * @memberof StocksSnapshotMinute */ 'av': number; /** * The close price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinute */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinute */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinute */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof StocksSnapshotMinute */ 'n': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinute */ 'o': number; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof StocksSnapshotMinute */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinute */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof StocksSnapshotMinute */ 'vw': number; } /** * * @export * @interface StocksSnapshotMinuteOTC */ interface StocksSnapshotMinuteOTC { /** * The accumulated volume. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'av': number; /** * The close price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'l': number; /** * The number of transactions in the aggregate window. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'n': number; /** * The open price for the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'o': number; /** * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. * @type {boolean} * @memberof StocksSnapshotMinuteOTC */ 'otc'?: boolean; /** * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 't': number; /** * The trading volume of the symbol in the given time period. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'v': number; /** * The volume weighted average price. * @type {number} * @memberof StocksSnapshotMinuteOTC */ 'vw': number; } /** * * @export * @interface StocksSnapshotTicker */ interface StocksSnapshotTicker { /** * * @type {GetStocksSnapshotTicker200ResponseAllOfTicker} * @memberof StocksSnapshotTicker */ 'ticker'?: GetStocksSnapshotTicker200ResponseAllOfTicker; } /** * * @export * @interface StocksSnapshotTickers */ interface StocksSnapshotTickers { /** * An array of snapshot data for the specified tickers. * @type {Array} * @memberof StocksSnapshotTickers */ 'tickers'?: Array; } /** * * @export * @interface StocksTickerResultsOTC */ interface StocksTickerResultsOTC { /** * An array of results containing the requested data. * @type {Array} * @memberof StocksTickerResultsOTC */ 'results'?: Array; } /** * * @export * @interface StocksV2Base */ interface StocksV2Base { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof StocksV2Base */ 'T': string; /** * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} * @memberof StocksV2Base */ 'f': number; /** * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof StocksV2Base */ 'q': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof StocksV2Base */ 't': number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof StocksV2Base */ 'y': number; } /** * * @export * @interface StocksV2NBBO */ interface StocksV2NBBO { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof StocksV2NBBO */ 'T': string; /** * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} * @memberof StocksV2NBBO */ 'f': number; /** * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof StocksV2NBBO */ 'q': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof StocksV2NBBO */ 't': number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof StocksV2NBBO */ 'y': number; /** * The ask price. * @type {number} * @memberof StocksV2NBBO */ 'P': number; /** * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. * @type {number} * @memberof StocksV2NBBO */ 'S': number; /** * The ask exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof StocksV2NBBO */ 'X': number; /** * A list of condition codes. * @type {Array} * @memberof StocksV2NBBO */ 'c': Array; /** * The indicators. For more information, see our glossary of [Conditions and Indicators](https://polygon.io/glossary/us/stocks/conditions-indicators). * @type {Array} * @memberof StocksV2NBBO */ 'i': Array; /** * The bid price. * @type {number} * @memberof StocksV2NBBO */ 'p': number; /** * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. * @type {number} * @memberof StocksV2NBBO */ 's': number; /** * The bid exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof StocksV2NBBO */ 'x': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof StocksV2NBBO */ 'z': number; } /** * * @export * @interface StocksV2NBBOs */ interface StocksV2NBBOs { /** * * @type {Array} * @memberof StocksV2NBBOs */ 'results'?: Array; } /** * * @export * @interface StocksV2Trade */ interface StocksV2Trade { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof StocksV2Trade */ 'T': string; /** * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} * @memberof StocksV2Trade */ 'f': number; /** * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} * @memberof StocksV2Trade */ 'q': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} * @memberof StocksV2Trade */ 't': number; /** * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} * @memberof StocksV2Trade */ 'y': number; /** * A list of condition codes. * @type {Array} * @memberof StocksV2Trade */ 'c': Array; /** * The trade correction indicator. * @type {number} * @memberof StocksV2Trade */ 'e': number; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} * @memberof StocksV2Trade */ 'i': string; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} * @memberof StocksV2Trade */ 'p': number; /** * The ID for the Trade Reporting Facility where the trade took place. * @type {number} * @memberof StocksV2Trade */ 'r': number; /** * The size of a trade (also known as volume). * @type {number} * @memberof StocksV2Trade */ 's': number; /** * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. * @type {number} * @memberof StocksV2Trade */ 'x': number; /** * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} * @memberof StocksV2Trade */ 'z': number; } /** * * @export * @interface StocksV2Trades */ interface StocksV2Trades { /** * * @type {Array} * @memberof StocksV2Trades */ 'results'?: Array; } /** * * @export * @interface TickerBase */ interface TickerBase { /** * The exchange symbol that this item is traded under. * @type {string} * @memberof TickerBase */ 'ticker': string; } /** * * @export * @interface TickerResults */ interface TickerResults { /** * An array of results containing the requested data. * @type {Array} * @memberof TickerResults */ 'results'?: Array; } /** * * @export * @interface TradeDetailsMapItem */ interface TradeDetailsMapItem { /** * Name of the trade detail item * @type {string} * @memberof TradeDetailsMapItem */ 'name'?: string; /** * Actual type of the trade detail item * @type {string} * @memberof TradeDetailsMapItem */ 'type'?: string; } /** * * @export * @interface V1LastBase */ interface V1LastBase { /** * A request id assigned by the server. * @type {string} * @memberof V1LastBase */ 'request_id': string; /** * The status of this request\'s response. * @type {string} * @memberof V1LastBase */ 'status': string; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof V1LastBase */ 'symbol': string; } /** * * @export * @interface V2AggsBase */ interface V2AggsBase { /** * Whether or not this response was adjusted for splits. * @type {boolean} * @memberof V2AggsBase */ 'adjusted': boolean; /** * The number of aggregates (minute or day) used to generate the response. * @type {number} * @memberof V2AggsBase */ 'queryCount': number; /** * A request id assigned by the server. * @type {string} * @memberof V2AggsBase */ 'request_id': string; /** * The total number of results for this request. * @type {number} * @memberof V2AggsBase */ 'resultsCount': number; /** * The status of this request\'s response. * @type {string} * @memberof V2AggsBase */ 'status': string; } /** * * @export * @interface V2LastBase */ interface V2LastBase { /** * A request id assigned by the server. * @type {string} * @memberof V2LastBase */ 'request_id': string; /** * The status of this request\'s response. * @type {string} * @memberof V2LastBase */ 'status': string; } /** * * @export * @interface V2TicksBase */ interface V2TicksBase { /** * Latency in milliseconds for the query results from the database. * @type {number} * @memberof V2TicksBase */ 'db_latency'?: number; /** * The total number of results for this request. * @type {number} * @memberof V2TicksBase */ 'results_count'?: number; /** * Whether or not this query was executed successfully. * @type {boolean} * @memberof V2TicksBase */ 'success'?: boolean; /** * The exchange symbol that this item is traded under. * @type {string} * @memberof V2TicksBase */ 'ticker'?: string; } /** * DefaultApi - axios parameter creator * @export */ declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker Full Book (L2) * @param {string} ticker The cryptocurrency ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetCryptoSnapshotTickerBook: (ticker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get historic trade ticks for a cryptocurrency pair. * @summary Historic Crypto Trades * @param {string} from The \"from\" symbol of the crypto pair. * @param {string} to The \"to\" symbol of the crypto pair. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricCryptoTrades: (from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get historic ticks for a forex currency pair. * @summary Historic Forex Ticks * @param {string} from The \"from\" symbol of the currency pair. Example: For **USD/JPY** the `from` would be **USD**. * @param {string} to The \"to\" symbol of the currency pair. Example: For **USD/JPY** the `to` would be **JPY**. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricForexQuotes: (from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get NBBO quotes for a given ticker symbol on a specified date. * @summary Quotes (NBBO) * @param {string} ticker The ticker symbol we want quotes for. * @param {string} date The date/day of the quotes to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricStocksQuotes: (ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get trades for a given ticker symbol on a specified date. * @summary Trades * @param {string} ticker The ticker symbol we want trades for. * @param {string} date The date/day of the trades to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricStocksTrades: (ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [firm] The name of the research firm or investment bank issuing the rating. * @param {string} [firmAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmGt] Filter greater than the value. * @param {string} [firmGte] Filter greater than or equal to the value. * @param {string} [firmLt] Filter less than the value. * @param {string} [firmLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for the firm record. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [benzingaRatingId] The identifier used by Benzinga for the rating record. * @param {string} [benzingaRatingIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaRatingIdGt] Filter greater than the value. * @param {string} [benzingaRatingIdGte] Filter greater than or equal to the value. * @param {string} [benzingaRatingIdLt] Filter less than the value. * @param {string} [benzingaRatingIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1AnalystInsights: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, firm?: string, firmAnyOf?: string, firmGt?: string, firmGte?: string, firmLt?: string, firmLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, benzingaRatingId?: string, benzingaRatingIdAnyOf?: string, benzingaRatingIdGt?: string, benzingaRatingIdGte?: string, benzingaRatingIdLt?: string, benzingaRatingIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms. * @param {string} [benzingaId] The identifier used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The unique identifier assigned by Benzinga to the research firm or investment bank. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [firmName] The name of the research firm or investment bank issuing the ratings. * @param {string} [firmNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmNameGt] Filter greater than the value. * @param {string} [firmNameGte] Filter greater than or equal to the value. * @param {string} [firmNameLt] Filter less than the value. * @param {string} [firmNameLte] Filter less than or equal to the value. * @param {string} [fullName] The full name of the analyst associated with the ratings. * @param {string} [fullNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fullNameGt] Filter greater than the value. * @param {string} [fullNameGte] Filter greater than or equal to the value. * @param {string} [fullNameLt] Filter less than the value. * @param {string} [fullNameLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'full_name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Analysts: (benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, firmName?: string, firmNameAnyOf?: string, firmNameGt?: string, firmNameGte?: string, firmNameLt?: string, firmNameLte?: string, fullName?: string, fullNameAnyOf?: string, fullNameGt?: string, fullNameGte?: string, fullNameLt?: string, fullNameLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. * @param {string} ticker The requested ticker. * @param {string} [date] The publication date of the news article. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1ConsensusRatings: (ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company reporting earnings. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateStatusGt] Filter greater than the value. * @param {string} [dateStatusGte] Filter greater than or equal to the value. * @param {string} [dateStatusLt] Filter less than the value. * @param {string} [dateStatusLte] Filter less than or equal to the value. * @param {number} [epsSurprisePercent] The percentage difference between the actual and estimated EPS. Value must be a floating point number. * @param {string} [epsSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [epsSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercent] The percentage difference between the actual and estimated revenue. Value must be a floating point number. * @param {string} [revenueSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [revenueSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [fiscalYear] The fiscal year in which the earnings period falls. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Earnings: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, dateStatus?: string, dateStatusAnyOf?: string, dateStatusGt?: string, dateStatusGte?: string, dateStatusLt?: string, dateStatusLte?: string, epsSurprisePercent?: number, epsSurprisePercentAnyOf?: string, epsSurprisePercentGt?: number, epsSurprisePercentGte?: number, epsSurprisePercentLt?: number, epsSurprisePercentLte?: number, revenueSurprisePercent?: number, revenueSurprisePercentAnyOf?: string, revenueSurprisePercentGt?: number, revenueSurprisePercentGte?: number, revenueSurprisePercentLt?: number, revenueSurprisePercentLte?: number, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Firms: (benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the guidance was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company issuing guidance. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [positioning] Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are \'primary\' (the emphasized figure) and \'secondary\' (a supporting or alternate figure) * @param {string} [positioningAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [positioningGt] Filter greater than the value. * @param {string} [positioningGte] Filter greater than or equal to the value. * @param {string} [positioningLt] Filter less than the value. * @param {string} [positioningLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {number} [fiscalYear] The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Guidance: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, positioning?: string, positioningAnyOf?: string, positioningGt?: string, positioningGte?: string, positioningLt?: string, positioningLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. * @param {string} [publishedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [publishedGt] Filter greater than the value. * @param {string} [publishedGte] Filter greater than or equal to the value. * @param {string} [publishedLt] Filter less than the value. * @param {string} [publishedLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [tickers] Filter for arrays that contain the value. * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channels] Filter for arrays that contain the value. * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tags] Filter for arrays that contain the value. * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [author] The name of the journalist or entity that authored the news article. * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [authorGt] Filter greater than the value. * @param {string} [authorGte] Filter greater than or equal to the value. * @param {string} [authorLt] Filter less than the value. * @param {string} [authorLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1News: (published?: string, publishedAnyOf?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [priceTargetAction] The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets. * @param {string} [priceTargetActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [priceTargetActionGt] Filter greater than the value. * @param {string} [priceTargetActionGte] Filter greater than or equal to the value. * @param {string} [priceTargetActionLt] Filter less than the value. * @param {string} [priceTargetActionLte] Filter less than or equal to the value. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaAnalystId] The identifer used by Benzinga for this analyst. * @param {string} [benzingaAnalystIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaAnalystIdGt] Filter greater than the value. * @param {string} [benzingaAnalystIdGte] Filter greater than or equal to the value. * @param {string} [benzingaAnalystIdLt] Filter less than the value. * @param {string} [benzingaAnalystIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for this firm. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Ratings: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetCryptoAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoAggregates: (cryptoTicker: string, multiplier: number, timespan: GetCryptoAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetCryptoAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} cryptoTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoEMA: (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoEMATimespanEnum, window?: number, seriesType?: GetCryptoEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} cryptoTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetCryptoMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate MACD data. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoMACD: (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoMACDTimespanEnum, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetCryptoMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the open, close prices of a cryptocurrency symbol on a certain day. * @summary Daily Open/Close * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoOpenClose: (from: string, to: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} cryptoTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoRSI: (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoRSITimespanEnum, window?: number, seriesType?: GetCryptoRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} cryptoTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSMA: (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoSMATimespanEnum, window?: number, seriesType?: GetCryptoSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the current top 20 gainers or losers of the day in cryptocurrency markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetCryptoSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotDirection: (direction: GetCryptoSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker Ticker of the snapshot * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotTicker: (ticker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotTickers: (tickers?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Get trades for a crypto ticker symbol in a given time range. * @summary Trades * @param {string} cryptoTicker The ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetCryptoTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetCryptoTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoTrades: (cryptoTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetCryptoTradesOrderEnum, limit?: number, sort?: GetCryptoTradesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. * @summary Real-time Currency Conversion * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {number} [amount] The amount to convert, with a decimal. * @param {GetCurrencyConversionPrecisionEnum} [precision] The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCurrencyConversion: (from: string, to: string, amount?: number, precision?: GetCurrencyConversionPrecisionEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. * @summary Ticker Events * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvents: (id: string, types?: string, options?: RawAxiosRequestConfig) => Promise; /** * A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1Inflation: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1InflationExpectations: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities. * @param {string} [date] Calendar date of the yield observation (YYYY-MM-DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1TreasuryYields: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get aggregate bars for a forex pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} forexTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetForexAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexAggregates: (forexTicker: string, multiplier: number, timespan: GetForexAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetForexAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} fxTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexEMA: (fxTicker: string, timestamp?: string, timespan?: GetForexEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} fxTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetForexMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexMACD: (fxTicker: string, timestamp?: string, timespan?: GetForexMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetForexMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get BBO quotes for a ticker symbol in a given time range. * @summary Quotes (BBO) * @param {string} fxTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetForexQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetForexQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexQuotes: (fxTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetForexQuotesOrderEnum, limit?: number, sort?: GetForexQuotesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} fxTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetForexRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexRSI: (fxTicker: string, timestamp?: string, timespan?: GetForexRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} fxTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSMA: (fxTicker: string, timestamp?: string, timespan?: GetForexSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the current top 20 gainers or losers of the day in forex markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetForexSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotDirection: (direction: GetForexSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker The forex ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotTicker: (ticker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotTickers: (tickers?: Array, options?: RawAxiosRequestConfig) => Promise; /** * Get aggregates for a contract in a given time range. * @summary Aggregates * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [windowStartGte] Range by window_start. * @param {string} [windowStartGt] Range by window_start. * @param {string} [windowStartLte] Range by window_start. * @param {string} [windowStartLt] Range by window_start. * @param {GetFuturesAggregatesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesAggregates: (ticker: string, resolution?: string, windowStart?: string, limit?: number, windowStartGte?: string, windowStartGt?: string, windowStartLte?: string, windowStartLt?: string, sort?: GetFuturesAggregatesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * The Contract Details endpoint returns the details for a single contract at a specific point in time. * @summary Contract Details * @param {string} ticker The ticker symbol of the contract to retrieve. * @param {string} [asOf] The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesContractDetails: (ticker: string, asOf?: string, options?: RawAxiosRequestConfig) => Promise; /** * The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract\'s ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date. * @summary Contracts * @param {string} [productCode] A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product. * @param {string} [firstTradeDate] The first day that a contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [lastTradeDate] The last day that the contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [asOf] Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today). * @param {GetFuturesContractsActiveEnum} [active] Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract\'s \'first_trade_date\' and less-than-or-equal-to its \'last_trade_date\', then the contract was active. If the date queried is greater-than-or-equal-to the contract\'s \'last_trade_date\' or less-than-or-equal-to its \'first_trade_date\', then the contract was inactive. * @param {GetFuturesContractsTypeEnum} [type] The type of contract, one of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesContractsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesContracts: (productCode?: string, firstTradeDate?: string, lastTradeDate?: string, asOf?: string, active?: GetFuturesContractsActiveEnum, type?: GetFuturesContractsTypeEnum, limit?: number, sort?: GetFuturesContractsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps. * @summary Daily Schedules * @param {string} [sessionEndDate] The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to \'today\' in Central Time. e.g. If a request is made from Pacific Time on \'2025-01-01\' at 11:00 pm with no \'session_end_date\' a default value of `2025-01-02` will be used. * @param {string} [tradingVenue] The trading venue (MIC) of the exchange for the schedules. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesDailySchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesDailySchedules: (sessionEndDate?: string, tradingVenue?: string, limit?: number, sort?: GetFuturesDailySchedulesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * The market status endpoint returns the current status of the futures market for the given product code(s). * @summary Market Status * @param {string} [productCodeAnyOf] The product code(s) to return market statuses for. Multiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes. * @param {string} [productCode] The product code to return market statuses for. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesMarketStatusesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesMarketStatuses: (productCodeAnyOf?: string, productCode?: string, limit?: number, sort?: GetFuturesMarketStatusesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * The Product Details endpoint returns the details for a single product as of a specific day. * @summary Product Details * @param {string} productCode The unique identifier for a product. * @param {GetFuturesProductDetailsTypeEnum} [type] The type of product to return. One of \"single\" or \"combo\" (default=single). * @param {string} [asOf] A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product\'s data at that point-in-time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProductDetails: (productCode: string, type?: GetFuturesProductDetailsTypeEnum, asOf?: string, options?: RawAxiosRequestConfig) => Promise; /** * The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps. * @summary Product Schedules * @param {string} productCode The product code for the futures product. * @param {string} [sessionEndDate] The date on which the schedule\'s trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesProductSchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProductSchedules: (productCode: string, sessionEndDate?: string, limit?: number, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesProductSchedulesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product\'s name, exchange, sector, sub-sector, asset class, asset sub-class, and type. * @summary Products * @param {string} [name] Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive. * @param {string} [asOf] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). * @param {string} [tradingVenue] The trading venue (MIC) for the exchange on which the products trades. * @param {GetFuturesProductsSectorEnum} [sector] The sector to which the products belong. * @param {GetFuturesProductsSubSectorEnum} [subSector] The sub-sector to which the products belong. * @param {GetFuturesProductsAssetClassEnum} [assetClass] The asset class to which the products belong. * @param {GetFuturesProductsAssetSubClassEnum} [assetSubClass] The asset sub-class to which the products belong. * @param {GetFuturesProductsTypeEnum} [type] The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, maximum=1000, minimum=1). * @param {string} [nameSearch] Search by name. * @param {GetFuturesProductsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProducts: (name?: string, asOf?: string, tradingVenue?: string, sector?: GetFuturesProductsSectorEnum, subSector?: GetFuturesProductsSubSectorEnum, assetClass?: GetFuturesProductsAssetClassEnum, assetSubClass?: GetFuturesProductsAssetSubClassEnum, type?: GetFuturesProductsTypeEnum, limit?: number, nameSearch?: string, sort?: GetFuturesProductsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get quotes for a contract in a given time range. * @summary Quotes * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesQuotesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesQuotes: (ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesQuotesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get trades for a contract in a given time range. * @summary Trades * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesTradesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesTrades: (ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesTradesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedCryptoAggregates: (date: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire forex markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedForexAggregates: (date: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedStocksAggregates: (date: string, adjusted?: boolean, includeOtc?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get aggregate bars for an index over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} indicesTicker The ticker symbol of Index. * @param {number} multiplier The size of the timespan multiplier. * @param {GetIndicesAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesAggregates: (indicesTicker: string, multiplier: number, timespan: GetIndicesAggregatesTimespanEnum, from: string, to: string, sort?: GetIndicesAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} indicesTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesEMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close values to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesEMA: (indicesTicker: string, timestamp?: string, timespan?: GetIndicesEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} indicesTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetIndicesMACDSeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close values to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesMACD: (indicesTicker: string, timestamp?: string, timespan?: GetIndicesMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetIndicesMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the open, close and afterhours values of a index symbol on a certain date. * @summary Daily Open/Close * @param {string} indicesTicker The ticker symbol of Index. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesOpenClose: (indicesTicker: string, date: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} indicesTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetIndicesRSISeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close values to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesRSI: (indicesTicker: string, timestamp?: string, timespan?: GetIndicesRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} indicesTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesSMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close values to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesSMA: (indicesTicker: string, timestamp?: string, timespan?: GetIndicesSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a Snapshot of indices data for said tickers * @summary Indices Snapshot * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {string} [ticker] Search a range of tickers lexicographically. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {GetIndicesSnapshotOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetIndicesSnapshotSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesSnapshot: (tickerAnyOf?: string, ticker?: string, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: GetIndicesSnapshotOrderEnum, limit?: number, sort?: GetIndicesSnapshotSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the last trade tick for a cryptocurrency pair. * @summary Last Trade for a Crypto Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastCryptoTrade: (from: string, to: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the last quote tick for a forex currency pair. * @summary Last Quote for a Currency Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastCurrencyQuote: (from: string, to: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the most recent trade for a given options contract. * @summary Last Trade * @param {string} optionsTicker The ticker symbol of the options contract. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastOptionsTrade: (optionsTicker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the most recent NBBO (Quote) tick for a given stock. * @summary Last Quote * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastStocksQuote: (stocksTicker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the most recent trade for a given stock. * @summary Last Trade * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastStocksTrade: (stocksTicker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get upcoming market holidays and their open/close times. * @summary Market Holidays * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketHolidays: (options?: RawAxiosRequestConfig) => Promise; /** * Get the current trading status of the exchanges and overall financial markets. * @summary Market Status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketStatus: (options?: RawAxiosRequestConfig) => Promise; /** * Get the snapshot of an option contract for a stock equity. * @summary Option Contract * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {string} optionContract The option contract identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionContract: (underlyingAsset: string, optionContract: string, options?: RawAxiosRequestConfig) => Promise; /** * Get aggregate bars for an option contract over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} optionsTicker The ticker symbol of the options contract. * @param {number} multiplier The size of the timespan multiplier. * @param {GetOptionsAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsAggregates: (optionsTicker: string, multiplier: number, timespan: GetOptionsAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetOptionsAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get the snapshot of all options contracts for an underlying ticker. * @summary Options Chain * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {number} [strikePrice] Query by strike price of a contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {GetOptionsChainContractTypeEnum} [contractType] Query by the type of contract. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {GetOptionsChainOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetOptionsChainSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsChain: (underlyingAsset: string, strikePrice?: number, expirationDate?: string, contractType?: GetOptionsChainContractTypeEnum, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, order?: GetOptionsChainOrderEnum, limit?: number, sort?: GetOptionsChainSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get an options contract * @summary Options Contract * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsContract: (optionsTicker: string, asOf?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} optionsTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsEMA: (optionsTicker: string, timestamp?: string, timespan?: GetOptionsEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} optionsTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetOptionsMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsMACD: (optionsTicker: string, timestamp?: string, timespan?: GetOptionsMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetOptionsMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the open, close and afterhours prices of an options contract on a certain date. * @summary Daily Open/Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsOpenClose: (optionsTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get quotes for an options ticker symbol in a given time range. * @summary Quotes * @param {string} optionsTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsQuotes: (optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsQuotesOrderEnum, limit?: number, sort?: GetOptionsQuotesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} optionsTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetOptionsRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsRSI: (optionsTicker: string, timestamp?: string, timespan?: GetOptionsRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} optionsTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsSMA: (optionsTicker: string, timestamp?: string, timespan?: GetOptionsSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get trades for an options ticker symbol in a given time range. * @summary Trades * @param {string} optionsTicker The options ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsTrades: (optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsTradesOrderEnum, limit?: number, sort?: GetOptionsTradesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. * @summary Previous Close * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousCryptoAggregates: (cryptoTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified forex pair. * @summary Previous Close * @param {string} forexTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousForexAggregates: (forexTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified index. * @summary Previous Close * @param {string} indicesTicker The ticker symbol of Index. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousIndicesAggregates: (indicesTicker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified option contract. * @summary Previous Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousOptionsAggregates: (optionsTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified stock ticker. * @summary Previous Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousStocksAggregates: (stocksTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get a list of tickers related to the queried ticker based on News and Returns data. * @summary Related Companies * @param {string} ticker The ticker symbol to search. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelatedCompanies: (ticker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get everything needed to visualize the tick-by-tick movement of a list of tickers. * @summary Summaries * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSnapshotSummary: (tickerAnyOf?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get snapshots for assets of all types * @summary Universal Snapshot * @param {string} [ticker] Search a range of tickers lexicographically. * @param {GetSnapshotsTypeEnum} [type] Query by the type of asset. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {GetSnapshotsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetSnapshotsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSnapshots: (ticker?: string, type?: GetSnapshotsTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, tickerAnyOf?: string, order?: GetSnapshotsOrderEnum, limit?: number, sort?: GetSnapshotsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get aggregate bars for a stock over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {number} multiplier The size of the timespan multiplier. * @param {GetStocksAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksAggregates: (stocksTicker: string, multiplier: number, timespan: GetStocksAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetStocksAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksEMA: (stockTicker: string, timestamp?: string, timespan?: GetStocksEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get moving average convergence/divergence (MACD) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetStocksMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksMACD: (stockTicker: string, timestamp?: string, timespan?: GetStocksMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetStocksMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the open, close and afterhours prices of a stock symbol on a certain date. * @summary Daily Open/Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksOpenClose: (stocksTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get NBBO quotes for a ticker symbol in a given time range. * @summary Quotes (NBBO) * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksQuotes: (stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksQuotesOrderEnum, limit?: number, sort?: GetStocksQuotesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get relative strength index (RSI) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetStocksRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksRSI: (stockTicker: string, timestamp?: string, timespan?: GetStocksRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get simple moving average (SMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSMA: (stockTicker: string, timestamp?: string, timespan?: GetStocksSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close. This output will only include tickers with a trading volume of 10,000 or more.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetStocksSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotDirection: (direction: GetStocksSnapshotDirectionDirectionEnum, includeOtc?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get the most up-to-date market data for a single traded stock ticker.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary Ticker * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotTicker: (stocksTicker: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the most up-to-date market data for all traded stock symbols.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotTickers: (tickers?: Array, includeOtc?: boolean, options?: RawAxiosRequestConfig) => Promise; /** * Get trades for a ticker symbol in a given time range. * @summary Trades * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksTrades: (stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksTradesOrderEnum, limit?: number, sort?: GetStocksTradesSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [daysToCover] Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. Value must be a floating point number. * @param {string} [daysToCoverAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [daysToCoverGt] Filter greater than the value. Value must be a floating point number. * @param {number} [daysToCoverGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [daysToCoverLt] Filter less than the value. Value must be a floating point number. * @param {number} [daysToCoverLte] Filter less than or equal to the value. Value must be a floating point number. * @param {string} [settlementDate] The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. * @param {string} [settlementDateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [settlementDateGt] Filter greater than the value. * @param {string} [settlementDateGte] Filter greater than or equal to the value. * @param {string} [settlementDateLt] Filter less than the value. * @param {string} [settlementDateLte] Filter less than or equal to the value. * @param {number} [avgDailyVolume] The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer. * @param {string} [avgDailyVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [avgDailyVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [avgDailyVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [avgDailyVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [avgDailyVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksV1ShortInterest: (ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, daysToCover?: number, daysToCoverAnyOf?: string, daysToCoverGt?: number, daysToCoverGte?: number, daysToCoverLt?: number, daysToCoverLte?: number, settlementDate?: string, settlementDateAnyOf?: string, settlementDateGt?: string, settlementDateGte?: string, settlementDateLt?: string, settlementDateLte?: string, avgDailyVolume?: number, avgDailyVolumeAnyOf?: string, avgDailyVolumeGt?: number, avgDailyVolumeGte?: number, avgDailyVolumeLt?: number, avgDailyVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [date] The date of trade activity reported in the format YYYY-MM-DD * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [shortVolumeRatio] The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number. * @param {string} [shortVolumeRatioAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [shortVolumeRatioGt] Filter greater than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLt] Filter less than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [totalVolume] Total reported volume across all venues for the ticker on the given date. Value must be an integer. * @param {string} [totalVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [totalVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [totalVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [totalVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [totalVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksV1ShortVolume: (ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, shortVolumeRatio?: number, shortVolumeRatioAnyOf?: string, shortVolumeRatioGt?: number, shortVolumeRatioGte?: number, shortVolumeRatioLt?: number, shortVolumeRatioLte?: number, totalVolume?: number, totalVolumeAnyOf?: string, totalVolumeGt?: number, totalVolumeGte?: number, totalVolumeLt?: number, totalVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTicker: (ticker: string, date?: string, options?: RawAxiosRequestConfig) => Promise; /** * * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [type] The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop. * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [typeGt] Filter greater than the value. * @param {string} [typeGte] Filter greater than or equal to the value. * @param {string} [typeLt] Filter less than the value. * @param {string} [typeLte] Filter less than or equal to the value. * @param {string} [status] The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed. * @param {string} [statusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [statusGt] Filter greater than the value. * @param {string} [statusGte] Filter greater than or equal to the value. * @param {string} [statusLt] Filter less than the value. * @param {string} [statusLte] Filter less than or equal to the value. * @param {string} [ticker] The company\'s stock symbol. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [isin] Standard international identifier for the company\'s common stock. * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [isinGt] Filter greater than the value. * @param {string} [isinGte] Filter greater than or equal to the value. * @param {string} [isinLt] Filter less than the value. * @param {string} [isinLte] Filter less than or equal to the value. * @param {string} [tradingVenue] MIC (Market Identifier Code) of the exchange where the company\'s stock is listed. * @param {string} [tradingVenueAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tradingVenueGt] Filter greater than the value. * @param {string} [tradingVenueGte] Filter greater than or equal to the value. * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. * @param {number} [tmxCompanyIdLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [tmxRecordId] The unique alphanumeric identifier for the event record used by TMX. * @param {string} [tmxRecordIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tmxRecordIdGt] Filter greater than the value. * @param {string} [tmxRecordIdGte] Filter greater than or equal to the value. * @param {string} [tmxRecordIdLt] Filter less than the value. * @param {string} [tmxRecordIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTmxV1CorporateEvents: (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * List all conditions that Polygon.io uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. * @param {number} [id] Filter for conditions with a given ID. * @param {ListConditionsSipEnum} [sip] Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned. * @param {ListConditionsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListConditionsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConditions: (assetClass?: ListConditionsAssetClassEnum, dataType?: ListConditionsDataTypeEnum, id?: number, sip?: ListConditionsSipEnum, order?: ListConditionsOrderEnum, limit?: number, sort?: ListConditionsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get a list of historical cash dividends, including the ticker symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount. * @summary Dividends v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [exDividendDate] Query by ex-dividend date with the format YYYY-MM-DD. * @param {string} [recordDate] Query by record date with the format YYYY-MM-DD. * @param {string} [declarationDate] Query by declaration date with the format YYYY-MM-DD. * @param {string} [payDate] Query by pay date with the format YYYY-MM-DD. * @param {ListDividendsFrequencyEnum} [frequency] Query by the number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly). * @param {number} [cashAmount] Query by the cash amount of the dividend. * @param {ListDividendsDividendTypeEnum} [dividendType] Query by the type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [exDividendDateGte] Range by ex_dividend_date. * @param {string} [exDividendDateGt] Range by ex_dividend_date. * @param {string} [exDividendDateLte] Range by ex_dividend_date. * @param {string} [exDividendDateLt] Range by ex_dividend_date. * @param {string} [recordDateGte] Range by record_date. * @param {string} [recordDateGt] Range by record_date. * @param {string} [recordDateLte] Range by record_date. * @param {string} [recordDateLt] Range by record_date. * @param {string} [declarationDateGte] Range by declaration_date. * @param {string} [declarationDateGt] Range by declaration_date. * @param {string} [declarationDateLte] Range by declaration_date. * @param {string} [declarationDateLt] Range by declaration_date. * @param {string} [payDateGte] Range by pay_date. * @param {string} [payDateGt] Range by pay_date. * @param {string} [payDateLte] Range by pay_date. * @param {string} [payDateLt] Range by pay_date. * @param {number} [cashAmountGte] Range by cash_amount. * @param {number} [cashAmountGt] Range by cash_amount. * @param {number} [cashAmountLte] Range by cash_amount. * @param {number} [cashAmountLt] Range by cash_amount. * @param {ListDividendsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListDividendsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDividends: (ticker?: string, exDividendDate?: string, recordDate?: string, declarationDate?: string, payDate?: string, frequency?: ListDividendsFrequencyEnum, cashAmount?: number, dividendType?: ListDividendsDividendTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, exDividendDateGte?: string, exDividendDateGt?: string, exDividendDateLte?: string, exDividendDateLt?: string, recordDateGte?: string, recordDateGt?: string, recordDateLte?: string, recordDateLt?: string, declarationDateGte?: string, declarationDateGt?: string, declarationDateLte?: string, declarationDateLt?: string, payDateGte?: string, payDateGt?: string, payDateLte?: string, payDateLt?: string, cashAmountGte?: number, cashAmountGt?: number, cashAmountLte?: number, cashAmountLt?: number, order?: ListDividendsOrderEnum, limit?: number, sort?: ListDividendsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * List all exchanges that Polygon.io knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listExchanges: (assetClass?: ListExchangesAssetClassEnum, locale?: ListExchangesLocaleEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get historical financial data for a stock ticker. The financials data is extracted from XBRL from company SEC filings using the methodology outlined here. * @summary Stock Financials vX * @param {string} [ticker] Query by company ticker. * @param {string} [cik] Query by central index key (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/edgar/searchedgar/cik.htm\">CIK</a>) Number * @param {string} [companyName] Query by company name. * @param {string} [sic] Query by standard industrial classification (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list\">SIC</a>) * @param {string} [filingDate] Query by the date when the filing with financials data was filed in YYYY-MM-DD format. Best used when querying over date ranges to find financials based on filings that happen in a time period. Examples: To get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01 To get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01 * @param {string} [periodOfReportDate] The period of report for the filing with financials data in YYYY-MM-DD format. * @param {ListFinancialsTimeframeEnum} [timeframe] Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4 * @param {boolean} [includeSources] Whether or not to include the `xpath` and `formula` attributes for each financial data point. See the `xpath` and `formula` response attributes for more info. False by default. * @param {string} [companyNameSearch] Search by company_name. * @param {string} [filingDateGte] Search by filing_date. * @param {string} [filingDateGt] Search by filing_date. * @param {string} [filingDateLte] Search by filing_date. * @param {string} [filingDateLt] Search by filing_date. * @param {string} [periodOfReportDateGte] Search by period_of_report_date. * @param {string} [periodOfReportDateGt] Search by period_of_report_date. * @param {string} [periodOfReportDateLte] Search by period_of_report_date. * @param {string} [periodOfReportDateLt] Search by period_of_report_date. * @param {ListFinancialsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 100. * @param {ListFinancialsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFinancials: (ticker?: string, cik?: string, companyName?: string, sic?: string, filingDate?: string, periodOfReportDate?: string, timeframe?: ListFinancialsTimeframeEnum, includeSources?: boolean, companyNameSearch?: string, filingDateGte?: string, filingDateGt?: string, filingDateLte?: string, filingDateLt?: string, periodOfReportDateGte?: string, periodOfReportDateGt?: string, periodOfReportDateLte?: string, periodOfReportDateLt?: string, order?: ListFinancialsOrderEnum, limit?: number, sort?: ListFinancialsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * The IPOs API provides access to detailed information about Initial Public Offerings (IPOs), including both upcoming and historical events. With this API, you can query for a comprehensive list of IPOs, along with key details such as the issuer name, ticker symbol, ISIN, IPO date, number of shares offered, expected price range, and final offering price. You can filter the results by status to focus on new, rumors, pending, historical, and more. * @summary IPOs * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, TSLA represents Tesla Inc. * @param {string} [usCode] Specify a us_code. This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. * @param {string} [isin] Specify an International Securities Identification Number (ISIN). This is a unique twelve-digit code that is assigned to every security issuance in the world. * @param {string} [listingDate] Specify a listing date. This is the first trading date for the newly listed entity. * @param {ListIPOsIpoStatusEnum} [ipoStatus] Specify an IPO status. * @param {string} [listingDateGte] Range by listing_date. * @param {string} [listingDateGt] Range by listing_date. * @param {string} [listingDateLte] Range by listing_date. * @param {string} [listingDateLt] Range by listing_date. * @param {ListIPOsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListIPOsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listIPOs: (ticker?: string, usCode?: string, isin?: string, listingDate?: string, ipoStatus?: ListIPOsIpoStatusEnum, listingDateGte?: string, listingDateGt?: string, listingDateLte?: string, listingDateLt?: string, order?: ListIPOsOrderEnum, limit?: number, sort?: ListIPOsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source. * @summary Ticker News * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {ListNewsPublishedUtcParameter} [publishedUtc] Return results published on, before, or after this date. * @param {string} [tickerGte] Search by ticker. * @param {string} [tickerGt] Search by ticker. * @param {string} [tickerLte] Search by ticker. * @param {string} [tickerLt] Search by ticker. * @param {ListNewsPublishedUtcParameter} [publishedUtcGte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcGt] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLt] Search by published_utc. * @param {ListNewsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListNewsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNews: (ticker?: string, publishedUtc?: ListNewsPublishedUtcParameter, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, publishedUtcGte?: ListNewsPublishedUtcParameter, publishedUtcGt?: ListNewsPublishedUtcParameter, publishedUtcLte?: ListNewsPublishedUtcParameter, publishedUtcLt?: ListNewsPublishedUtcParameter, order?: ListNewsOrderEnum, limit?: number, sort?: ListNewsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {number} [strikePrice] Query by strike price of a contract. * @param {boolean} [expired] Query for expired contracts. Default is false. * @param {string} [underlyingTickerGte] Range by underlying_ticker. * @param {string} [underlyingTickerGt] Range by underlying_ticker. * @param {string} [underlyingTickerLte] Range by underlying_ticker. * @param {string} [underlyingTickerLt] Range by underlying_ticker. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {ListOptionsContractsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListOptionsContractsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOptionsContracts: (underlyingTicker?: string, ticker?: string, contractType?: ListOptionsContractsContractTypeEnum, expirationDate?: string, asOf?: string, strikePrice?: number, expired?: boolean, underlyingTickerGte?: string, underlyingTickerGt?: string, underlyingTickerLte?: string, underlyingTickerLt?: string, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, order?: ListOptionsContractsOrderEnum, limit?: number, sort?: ListOptionsContractsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * Get a list of historical stock splits, including the ticker symbol, the execution date, and the factors of the split ratio. * @summary Stock Splits v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [executionDate] Query by execution date with the format YYYY-MM-DD. * @param {boolean | null} [reverseSplit] Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. By default this filter is not used. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [executionDateGte] Range by execution_date. * @param {string} [executionDateGt] Range by execution_date. * @param {string} [executionDateLte] Range by execution_date. * @param {string} [executionDateLt] Range by execution_date. * @param {ListStockSplitsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListStockSplitsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listStockSplits: (ticker?: string, executionDate?: string, reverseSplit?: boolean | null, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, executionDateGte?: string, executionDateGt?: string, executionDateLte?: string, executionDateLt?: string, order?: ListStockSplitsOrderEnum, limit?: number, sort?: ListStockSplitsSortEnum, options?: RawAxiosRequestConfig) => Promise; /** * List all ticker types that Polygon.io has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTickerTypes: (assetClass?: ListTickerTypesAssetClassEnum, locale?: ListTickerTypesLocaleEnum, options?: RawAxiosRequestConfig) => Promise; /** * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. * @param {string} [cik] Specify the CIK of the asset you want to search for. Find more information about CIK codes [at their website](https://www.sec.gov/edgar/searchedgar/cik.htm). Defaults to empty string which queries all CIKs. * @param {string} [date] Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date. * @param {string} [search] Search for terms within the ticker and/or company name. * @param {boolean} [active] Specify if the tickers returned should be actively traded on the queried date. Default is true. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {ListTickersOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 100 and max is 1000. * @param {ListTickersSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTickers: (ticker?: string, type?: ListTickersTypeEnum, market?: ListTickersMarketEnum, exchange?: string, cusip?: string, cik?: string, date?: string, search?: string, active?: boolean, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: ListTickersOrderEnum, limit?: number, sort?: ListTickersSortEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * DefaultApi - functional programming interface * @export */ declare const DefaultApiFp: (configuration?: Configuration) => { /** * Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker Full Book (L2) * @param {string} ticker The cryptocurrency ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetCryptoSnapshotTickerBook(ticker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get historic trade ticks for a cryptocurrency pair. * @summary Historic Crypto Trades * @param {string} from The \"from\" symbol of the crypto pair. * @param {string} to The \"to\" symbol of the crypto pair. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricCryptoTrades(from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get historic ticks for a forex currency pair. * @summary Historic Forex Ticks * @param {string} from The \"from\" symbol of the currency pair. Example: For **USD/JPY** the `from` would be **USD**. * @param {string} to The \"to\" symbol of the currency pair. Example: For **USD/JPY** the `to` would be **JPY**. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricForexQuotes(from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get NBBO quotes for a given ticker symbol on a specified date. * @summary Quotes (NBBO) * @param {string} ticker The ticker symbol we want quotes for. * @param {string} date The date/day of the quotes to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricStocksQuotes(ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get trades for a given ticker symbol on a specified date. * @summary Trades * @param {string} ticker The ticker symbol we want trades for. * @param {string} date The date/day of the trades to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricStocksTrades(ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [firm] The name of the research firm or investment bank issuing the rating. * @param {string} [firmAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmGt] Filter greater than the value. * @param {string} [firmGte] Filter greater than or equal to the value. * @param {string} [firmLt] Filter less than the value. * @param {string} [firmLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for the firm record. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [benzingaRatingId] The identifier used by Benzinga for the rating record. * @param {string} [benzingaRatingIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaRatingIdGt] Filter greater than the value. * @param {string} [benzingaRatingIdGte] Filter greater than or equal to the value. * @param {string} [benzingaRatingIdLt] Filter less than the value. * @param {string} [benzingaRatingIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1AnalystInsights(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, firm?: string, firmAnyOf?: string, firmGt?: string, firmGte?: string, firmLt?: string, firmLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, benzingaRatingId?: string, benzingaRatingIdAnyOf?: string, benzingaRatingIdGt?: string, benzingaRatingIdGte?: string, benzingaRatingIdLt?: string, benzingaRatingIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms. * @param {string} [benzingaId] The identifier used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The unique identifier assigned by Benzinga to the research firm or investment bank. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [firmName] The name of the research firm or investment bank issuing the ratings. * @param {string} [firmNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmNameGt] Filter greater than the value. * @param {string} [firmNameGte] Filter greater than or equal to the value. * @param {string} [firmNameLt] Filter less than the value. * @param {string} [firmNameLte] Filter less than or equal to the value. * @param {string} [fullName] The full name of the analyst associated with the ratings. * @param {string} [fullNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fullNameGt] Filter greater than the value. * @param {string} [fullNameGte] Filter greater than or equal to the value. * @param {string} [fullNameLt] Filter less than the value. * @param {string} [fullNameLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'full_name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Analysts(benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, firmName?: string, firmNameAnyOf?: string, firmNameGt?: string, firmNameGte?: string, firmNameLt?: string, firmNameLte?: string, fullName?: string, fullNameAnyOf?: string, fullNameGt?: string, fullNameGte?: string, fullNameLt?: string, fullNameLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. * @param {string} ticker The requested ticker. * @param {string} [date] The publication date of the news article. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company reporting earnings. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateStatusGt] Filter greater than the value. * @param {string} [dateStatusGte] Filter greater than or equal to the value. * @param {string} [dateStatusLt] Filter less than the value. * @param {string} [dateStatusLte] Filter less than or equal to the value. * @param {number} [epsSurprisePercent] The percentage difference between the actual and estimated EPS. Value must be a floating point number. * @param {string} [epsSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [epsSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercent] The percentage difference between the actual and estimated revenue. Value must be a floating point number. * @param {string} [revenueSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [revenueSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [fiscalYear] The fiscal year in which the earnings period falls. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Earnings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, dateStatus?: string, dateStatusAnyOf?: string, dateStatusGt?: string, dateStatusGte?: string, dateStatusLt?: string, dateStatusLte?: string, epsSurprisePercent?: number, epsSurprisePercentAnyOf?: string, epsSurprisePercentGt?: number, epsSurprisePercentGte?: number, epsSurprisePercentLt?: number, epsSurprisePercentLte?: number, revenueSurprisePercent?: number, revenueSurprisePercentAnyOf?: string, revenueSurprisePercentGt?: number, revenueSurprisePercentGte?: number, revenueSurprisePercentLt?: number, revenueSurprisePercentLte?: number, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Firms(benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the guidance was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company issuing guidance. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [positioning] Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are \'primary\' (the emphasized figure) and \'secondary\' (a supporting or alternate figure) * @param {string} [positioningAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [positioningGt] Filter greater than the value. * @param {string} [positioningGte] Filter greater than or equal to the value. * @param {string} [positioningLt] Filter less than the value. * @param {string} [positioningLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {number} [fiscalYear] The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Guidance(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, positioning?: string, positioningAnyOf?: string, positioningGt?: string, positioningGte?: string, positioningLt?: string, positioningLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. * @param {string} [publishedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [publishedGt] Filter greater than the value. * @param {string} [publishedGte] Filter greater than or equal to the value. * @param {string} [publishedLt] Filter less than the value. * @param {string} [publishedLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [tickers] Filter for arrays that contain the value. * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channels] Filter for arrays that contain the value. * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tags] Filter for arrays that contain the value. * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [author] The name of the journalist or entity that authored the news article. * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [authorGt] Filter greater than the value. * @param {string} [authorGte] Filter greater than or equal to the value. * @param {string} [authorLt] Filter less than the value. * @param {string} [authorLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1News(published?: string, publishedAnyOf?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [priceTargetAction] The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets. * @param {string} [priceTargetActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [priceTargetActionGt] Filter greater than the value. * @param {string} [priceTargetActionGte] Filter greater than or equal to the value. * @param {string} [priceTargetActionLt] Filter less than the value. * @param {string} [priceTargetActionLte] Filter less than or equal to the value. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaAnalystId] The identifer used by Benzinga for this analyst. * @param {string} [benzingaAnalystIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaAnalystIdGt] Filter greater than the value. * @param {string} [benzingaAnalystIdGte] Filter greater than or equal to the value. * @param {string} [benzingaAnalystIdLt] Filter less than the value. * @param {string} [benzingaAnalystIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for this firm. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetCryptoAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoAggregates(cryptoTicker: string, multiplier: number, timespan: GetCryptoAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetCryptoAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} cryptoTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoEMA(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoEMATimespanEnum, window?: number, seriesType?: GetCryptoEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} cryptoTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetCryptoMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate MACD data. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoMACD(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoMACDTimespanEnum, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetCryptoMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the open, close prices of a cryptocurrency symbol on a certain day. * @summary Daily Open/Close * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoOpenClose(from: string, to: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} cryptoTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoRSI(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoRSITimespanEnum, window?: number, seriesType?: GetCryptoRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} cryptoTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSMA(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoSMATimespanEnum, window?: number, seriesType?: GetCryptoSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the current top 20 gainers or losers of the day in cryptocurrency markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetCryptoSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotDirection(direction: GetCryptoSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker Ticker of the snapshot * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotTicker(ticker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotTickers(tickers?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get trades for a crypto ticker symbol in a given time range. * @summary Trades * @param {string} cryptoTicker The ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetCryptoTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetCryptoTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoTrades(cryptoTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetCryptoTradesOrderEnum, limit?: number, sort?: GetCryptoTradesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. * @summary Real-time Currency Conversion * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {number} [amount] The amount to convert, with a decimal. * @param {GetCurrencyConversionPrecisionEnum} [precision] The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCurrencyConversion(from: string, to: string, amount?: number, precision?: GetCurrencyConversionPrecisionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. * @summary Ticker Events * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvents(id: string, types?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1Inflation(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1InflationExpectations(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities. * @param {string} [date] Calendar date of the yield observation (YYYY-MM-DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1TreasuryYields(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get aggregate bars for a forex pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} forexTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetForexAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexAggregates(forexTicker: string, multiplier: number, timespan: GetForexAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetForexAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} fxTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexEMA(fxTicker: string, timestamp?: string, timespan?: GetForexEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} fxTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetForexMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexMACD(fxTicker: string, timestamp?: string, timespan?: GetForexMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetForexMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get BBO quotes for a ticker symbol in a given time range. * @summary Quotes (BBO) * @param {string} fxTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetForexQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetForexQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexQuotes(fxTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetForexQuotesOrderEnum, limit?: number, sort?: GetForexQuotesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} fxTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetForexRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexRSI(fxTicker: string, timestamp?: string, timespan?: GetForexRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} fxTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSMA(fxTicker: string, timestamp?: string, timespan?: GetForexSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the current top 20 gainers or losers of the day in forex markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetForexSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotDirection(direction: GetForexSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker The forex ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotTicker(ticker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotTickers(tickers?: Array, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get aggregates for a contract in a given time range. * @summary Aggregates * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [windowStartGte] Range by window_start. * @param {string} [windowStartGt] Range by window_start. * @param {string} [windowStartLte] Range by window_start. * @param {string} [windowStartLt] Range by window_start. * @param {GetFuturesAggregatesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesAggregates(ticker: string, resolution?: string, windowStart?: string, limit?: number, windowStartGte?: string, windowStartGt?: string, windowStartLte?: string, windowStartLt?: string, sort?: GetFuturesAggregatesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The Contract Details endpoint returns the details for a single contract at a specific point in time. * @summary Contract Details * @param {string} ticker The ticker symbol of the contract to retrieve. * @param {string} [asOf] The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesContractDetails(ticker: string, asOf?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract\'s ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date. * @summary Contracts * @param {string} [productCode] A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product. * @param {string} [firstTradeDate] The first day that a contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [lastTradeDate] The last day that the contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [asOf] Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today). * @param {GetFuturesContractsActiveEnum} [active] Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract\'s \'first_trade_date\' and less-than-or-equal-to its \'last_trade_date\', then the contract was active. If the date queried is greater-than-or-equal-to the contract\'s \'last_trade_date\' or less-than-or-equal-to its \'first_trade_date\', then the contract was inactive. * @param {GetFuturesContractsTypeEnum} [type] The type of contract, one of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesContractsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesContracts(productCode?: string, firstTradeDate?: string, lastTradeDate?: string, asOf?: string, active?: GetFuturesContractsActiveEnum, type?: GetFuturesContractsTypeEnum, limit?: number, sort?: GetFuturesContractsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps. * @summary Daily Schedules * @param {string} [sessionEndDate] The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to \'today\' in Central Time. e.g. If a request is made from Pacific Time on \'2025-01-01\' at 11:00 pm with no \'session_end_date\' a default value of `2025-01-02` will be used. * @param {string} [tradingVenue] The trading venue (MIC) of the exchange for the schedules. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesDailySchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesDailySchedules(sessionEndDate?: string, tradingVenue?: string, limit?: number, sort?: GetFuturesDailySchedulesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The market status endpoint returns the current status of the futures market for the given product code(s). * @summary Market Status * @param {string} [productCodeAnyOf] The product code(s) to return market statuses for. Multiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes. * @param {string} [productCode] The product code to return market statuses for. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesMarketStatusesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesMarketStatuses(productCodeAnyOf?: string, productCode?: string, limit?: number, sort?: GetFuturesMarketStatusesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The Product Details endpoint returns the details for a single product as of a specific day. * @summary Product Details * @param {string} productCode The unique identifier for a product. * @param {GetFuturesProductDetailsTypeEnum} [type] The type of product to return. One of \"single\" or \"combo\" (default=single). * @param {string} [asOf] A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product\'s data at that point-in-time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProductDetails(productCode: string, type?: GetFuturesProductDetailsTypeEnum, asOf?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps. * @summary Product Schedules * @param {string} productCode The product code for the futures product. * @param {string} [sessionEndDate] The date on which the schedule\'s trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesProductSchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProductSchedules(productCode: string, sessionEndDate?: string, limit?: number, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesProductSchedulesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product\'s name, exchange, sector, sub-sector, asset class, asset sub-class, and type. * @summary Products * @param {string} [name] Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive. * @param {string} [asOf] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). * @param {string} [tradingVenue] The trading venue (MIC) for the exchange on which the products trades. * @param {GetFuturesProductsSectorEnum} [sector] The sector to which the products belong. * @param {GetFuturesProductsSubSectorEnum} [subSector] The sub-sector to which the products belong. * @param {GetFuturesProductsAssetClassEnum} [assetClass] The asset class to which the products belong. * @param {GetFuturesProductsAssetSubClassEnum} [assetSubClass] The asset sub-class to which the products belong. * @param {GetFuturesProductsTypeEnum} [type] The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, maximum=1000, minimum=1). * @param {string} [nameSearch] Search by name. * @param {GetFuturesProductsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProducts(name?: string, asOf?: string, tradingVenue?: string, sector?: GetFuturesProductsSectorEnum, subSector?: GetFuturesProductsSubSectorEnum, assetClass?: GetFuturesProductsAssetClassEnum, assetSubClass?: GetFuturesProductsAssetSubClassEnum, type?: GetFuturesProductsTypeEnum, limit?: number, nameSearch?: string, sort?: GetFuturesProductsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get quotes for a contract in a given time range. * @summary Quotes * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesQuotesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesQuotes(ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesQuotesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get trades for a contract in a given time range. * @summary Trades * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesTradesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesTrades(ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesTradesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedCryptoAggregates(date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the daily open, high, low, and close (OHLC) for the entire forex markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedForexAggregates(date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedStocksAggregates(date: string, adjusted?: boolean, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get aggregate bars for an index over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} indicesTicker The ticker symbol of Index. * @param {number} multiplier The size of the timespan multiplier. * @param {GetIndicesAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesAggregates(indicesTicker: string, multiplier: number, timespan: GetIndicesAggregatesTimespanEnum, from: string, to: string, sort?: GetIndicesAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} indicesTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesEMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close values to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesEMA(indicesTicker: string, timestamp?: string, timespan?: GetIndicesEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} indicesTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetIndicesMACDSeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close values to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesMACD(indicesTicker: string, timestamp?: string, timespan?: GetIndicesMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetIndicesMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the open, close and afterhours values of a index symbol on a certain date. * @summary Daily Open/Close * @param {string} indicesTicker The ticker symbol of Index. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesOpenClose(indicesTicker: string, date: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} indicesTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetIndicesRSISeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close values to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesRSI(indicesTicker: string, timestamp?: string, timespan?: GetIndicesRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} indicesTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesSMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close values to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesSMA(indicesTicker: string, timestamp?: string, timespan?: GetIndicesSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get a Snapshot of indices data for said tickers * @summary Indices Snapshot * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {string} [ticker] Search a range of tickers lexicographically. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {GetIndicesSnapshotOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetIndicesSnapshotSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesSnapshot(tickerAnyOf?: string, ticker?: string, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: GetIndicesSnapshotOrderEnum, limit?: number, sort?: GetIndicesSnapshotSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the last trade tick for a cryptocurrency pair. * @summary Last Trade for a Crypto Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastCryptoTrade(from: string, to: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the last quote tick for a forex currency pair. * @summary Last Quote for a Currency Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastCurrencyQuote(from: string, to: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the most recent trade for a given options contract. * @summary Last Trade * @param {string} optionsTicker The ticker symbol of the options contract. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastOptionsTrade(optionsTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the most recent NBBO (Quote) tick for a given stock. * @summary Last Quote * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastStocksQuote(stocksTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the most recent trade for a given stock. * @summary Last Trade * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastStocksTrade(stocksTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get upcoming market holidays and their open/close times. * @summary Market Holidays * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketHolidays(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>>; /** * Get the current trading status of the exchanges and overall financial markets. * @summary Market Status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the snapshot of an option contract for a stock equity. * @summary Option Contract * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {string} optionContract The option contract identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionContract(underlyingAsset: string, optionContract: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get aggregate bars for an option contract over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} optionsTicker The ticker symbol of the options contract. * @param {number} multiplier The size of the timespan multiplier. * @param {GetOptionsAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsAggregates(optionsTicker: string, multiplier: number, timespan: GetOptionsAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetOptionsAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the snapshot of all options contracts for an underlying ticker. * @summary Options Chain * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {number} [strikePrice] Query by strike price of a contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {GetOptionsChainContractTypeEnum} [contractType] Query by the type of contract. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {GetOptionsChainOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetOptionsChainSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsChain(underlyingAsset: string, strikePrice?: number, expirationDate?: string, contractType?: GetOptionsChainContractTypeEnum, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, order?: GetOptionsChainOrderEnum, limit?: number, sort?: GetOptionsChainSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get an options contract * @summary Options Contract * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsContract(optionsTicker: string, asOf?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} optionsTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsEMA(optionsTicker: string, timestamp?: string, timespan?: GetOptionsEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} optionsTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetOptionsMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsMACD(optionsTicker: string, timestamp?: string, timespan?: GetOptionsMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetOptionsMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the open, close and afterhours prices of an options contract on a certain date. * @summary Daily Open/Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsOpenClose(optionsTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get quotes for an options ticker symbol in a given time range. * @summary Quotes * @param {string} optionsTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsQuotes(optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsQuotesOrderEnum, limit?: number, sort?: GetOptionsQuotesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} optionsTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetOptionsRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsRSI(optionsTicker: string, timestamp?: string, timespan?: GetOptionsRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} optionsTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsSMA(optionsTicker: string, timestamp?: string, timespan?: GetOptionsSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get trades for an options ticker symbol in a given time range. * @summary Trades * @param {string} optionsTicker The options ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsTrades(optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsTradesOrderEnum, limit?: number, sort?: GetOptionsTradesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. * @summary Previous Close * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousCryptoAggregates(cryptoTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified forex pair. * @summary Previous Close * @param {string} forexTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousForexAggregates(forexTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified index. * @summary Previous Close * @param {string} indicesTicker The ticker symbol of Index. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousIndicesAggregates(indicesTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified option contract. * @summary Previous Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousOptionsAggregates(optionsTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified stock ticker. * @summary Previous Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousStocksAggregates(stocksTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get a list of tickers related to the queried ticker based on News and Returns data. * @summary Related Companies * @param {string} ticker The ticker symbol to search. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelatedCompanies(ticker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get everything needed to visualize the tick-by-tick movement of a list of tickers. * @summary Summaries * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSnapshotSummary(tickerAnyOf?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get snapshots for assets of all types * @summary Universal Snapshot * @param {string} [ticker] Search a range of tickers lexicographically. * @param {GetSnapshotsTypeEnum} [type] Query by the type of asset. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {GetSnapshotsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetSnapshotsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSnapshots(ticker?: string, type?: GetSnapshotsTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, tickerAnyOf?: string, order?: GetSnapshotsOrderEnum, limit?: number, sort?: GetSnapshotsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get aggregate bars for a stock over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {number} multiplier The size of the timespan multiplier. * @param {GetStocksAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksAggregates(stocksTicker: string, multiplier: number, timespan: GetStocksAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetStocksAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksEMA(stockTicker: string, timestamp?: string, timespan?: GetStocksEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get moving average convergence/divergence (MACD) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetStocksMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksMACD(stockTicker: string, timestamp?: string, timespan?: GetStocksMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetStocksMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the open, close and afterhours prices of a stock symbol on a certain date. * @summary Daily Open/Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksOpenClose(stocksTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get NBBO quotes for a ticker symbol in a given time range. * @summary Quotes (NBBO) * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksQuotes(stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksQuotesOrderEnum, limit?: number, sort?: GetStocksQuotesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get relative strength index (RSI) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetStocksRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksRSI(stockTicker: string, timestamp?: string, timespan?: GetStocksRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get simple moving average (SMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSMA(stockTicker: string, timestamp?: string, timespan?: GetStocksSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close. This output will only include tickers with a trading volume of 10,000 or more.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetStocksSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotDirection(direction: GetStocksSnapshotDirectionDirectionEnum, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the most up-to-date market data for a single traded stock ticker.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary Ticker * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotTicker(stocksTicker: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the most up-to-date market data for all traded stock symbols.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotTickers(tickers?: Array, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get trades for a ticker symbol in a given time range. * @summary Trades * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksTrades(stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksTradesOrderEnum, limit?: number, sort?: GetStocksTradesSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [daysToCover] Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. Value must be a floating point number. * @param {string} [daysToCoverAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [daysToCoverGt] Filter greater than the value. Value must be a floating point number. * @param {number} [daysToCoverGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [daysToCoverLt] Filter less than the value. Value must be a floating point number. * @param {number} [daysToCoverLte] Filter less than or equal to the value. Value must be a floating point number. * @param {string} [settlementDate] The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. * @param {string} [settlementDateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [settlementDateGt] Filter greater than the value. * @param {string} [settlementDateGte] Filter greater than or equal to the value. * @param {string} [settlementDateLt] Filter less than the value. * @param {string} [settlementDateLte] Filter less than or equal to the value. * @param {number} [avgDailyVolume] The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer. * @param {string} [avgDailyVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [avgDailyVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [avgDailyVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [avgDailyVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [avgDailyVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksV1ShortInterest(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, daysToCover?: number, daysToCoverAnyOf?: string, daysToCoverGt?: number, daysToCoverGte?: number, daysToCoverLt?: number, daysToCoverLte?: number, settlementDate?: string, settlementDateAnyOf?: string, settlementDateGt?: string, settlementDateGte?: string, settlementDateLt?: string, settlementDateLte?: string, avgDailyVolume?: number, avgDailyVolumeAnyOf?: string, avgDailyVolumeGt?: number, avgDailyVolumeGte?: number, avgDailyVolumeLt?: number, avgDailyVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [date] The date of trade activity reported in the format YYYY-MM-DD * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [shortVolumeRatio] The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number. * @param {string} [shortVolumeRatioAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [shortVolumeRatioGt] Filter greater than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLt] Filter less than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [totalVolume] Total reported volume across all venues for the ticker on the given date. Value must be an integer. * @param {string} [totalVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [totalVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [totalVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [totalVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [totalVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksV1ShortVolume(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, shortVolumeRatio?: number, shortVolumeRatioAnyOf?: string, shortVolumeRatioGt?: number, shortVolumeRatioGte?: number, shortVolumeRatioLt?: number, shortVolumeRatioLte?: number, totalVolume?: number, totalVolumeAnyOf?: string, totalVolumeGt?: number, totalVolumeGte?: number, totalVolumeLt?: number, totalVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTicker(ticker: string, date?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [type] The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop. * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [typeGt] Filter greater than the value. * @param {string} [typeGte] Filter greater than or equal to the value. * @param {string} [typeLt] Filter less than the value. * @param {string} [typeLte] Filter less than or equal to the value. * @param {string} [status] The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed. * @param {string} [statusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [statusGt] Filter greater than the value. * @param {string} [statusGte] Filter greater than or equal to the value. * @param {string} [statusLt] Filter less than the value. * @param {string} [statusLte] Filter less than or equal to the value. * @param {string} [ticker] The company\'s stock symbol. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [isin] Standard international identifier for the company\'s common stock. * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [isinGt] Filter greater than the value. * @param {string} [isinGte] Filter greater than or equal to the value. * @param {string} [isinLt] Filter less than the value. * @param {string} [isinLte] Filter less than or equal to the value. * @param {string} [tradingVenue] MIC (Market Identifier Code) of the exchange where the company\'s stock is listed. * @param {string} [tradingVenueAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tradingVenueGt] Filter greater than the value. * @param {string} [tradingVenueGte] Filter greater than or equal to the value. * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. * @param {number} [tmxCompanyIdLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [tmxRecordId] The unique alphanumeric identifier for the event record used by TMX. * @param {string} [tmxRecordIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tmxRecordIdGt] Filter greater than the value. * @param {string} [tmxRecordIdGte] Filter greater than or equal to the value. * @param {string} [tmxRecordIdLt] Filter less than the value. * @param {string} [tmxRecordIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * List all conditions that Polygon.io uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. * @param {number} [id] Filter for conditions with a given ID. * @param {ListConditionsSipEnum} [sip] Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned. * @param {ListConditionsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListConditionsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConditions(assetClass?: ListConditionsAssetClassEnum, dataType?: ListConditionsDataTypeEnum, id?: number, sip?: ListConditionsSipEnum, order?: ListConditionsOrderEnum, limit?: number, sort?: ListConditionsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get a list of historical cash dividends, including the ticker symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount. * @summary Dividends v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [exDividendDate] Query by ex-dividend date with the format YYYY-MM-DD. * @param {string} [recordDate] Query by record date with the format YYYY-MM-DD. * @param {string} [declarationDate] Query by declaration date with the format YYYY-MM-DD. * @param {string} [payDate] Query by pay date with the format YYYY-MM-DD. * @param {ListDividendsFrequencyEnum} [frequency] Query by the number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly). * @param {number} [cashAmount] Query by the cash amount of the dividend. * @param {ListDividendsDividendTypeEnum} [dividendType] Query by the type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [exDividendDateGte] Range by ex_dividend_date. * @param {string} [exDividendDateGt] Range by ex_dividend_date. * @param {string} [exDividendDateLte] Range by ex_dividend_date. * @param {string} [exDividendDateLt] Range by ex_dividend_date. * @param {string} [recordDateGte] Range by record_date. * @param {string} [recordDateGt] Range by record_date. * @param {string} [recordDateLte] Range by record_date. * @param {string} [recordDateLt] Range by record_date. * @param {string} [declarationDateGte] Range by declaration_date. * @param {string} [declarationDateGt] Range by declaration_date. * @param {string} [declarationDateLte] Range by declaration_date. * @param {string} [declarationDateLt] Range by declaration_date. * @param {string} [payDateGte] Range by pay_date. * @param {string} [payDateGt] Range by pay_date. * @param {string} [payDateLte] Range by pay_date. * @param {string} [payDateLt] Range by pay_date. * @param {number} [cashAmountGte] Range by cash_amount. * @param {number} [cashAmountGt] Range by cash_amount. * @param {number} [cashAmountLte] Range by cash_amount. * @param {number} [cashAmountLt] Range by cash_amount. * @param {ListDividendsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListDividendsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDividends(ticker?: string, exDividendDate?: string, recordDate?: string, declarationDate?: string, payDate?: string, frequency?: ListDividendsFrequencyEnum, cashAmount?: number, dividendType?: ListDividendsDividendTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, exDividendDateGte?: string, exDividendDateGt?: string, exDividendDateLte?: string, exDividendDateLt?: string, recordDateGte?: string, recordDateGt?: string, recordDateLte?: string, recordDateLt?: string, declarationDateGte?: string, declarationDateGt?: string, declarationDateLte?: string, declarationDateLt?: string, payDateGte?: string, payDateGt?: string, payDateLte?: string, payDateLt?: string, cashAmountGte?: number, cashAmountGt?: number, cashAmountLte?: number, cashAmountLt?: number, order?: ListDividendsOrderEnum, limit?: number, sort?: ListDividendsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * List all exchanges that Polygon.io knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listExchanges(assetClass?: ListExchangesAssetClassEnum, locale?: ListExchangesLocaleEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get historical financial data for a stock ticker. The financials data is extracted from XBRL from company SEC filings using the methodology outlined here. * @summary Stock Financials vX * @param {string} [ticker] Query by company ticker. * @param {string} [cik] Query by central index key (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/edgar/searchedgar/cik.htm\">CIK</a>) Number * @param {string} [companyName] Query by company name. * @param {string} [sic] Query by standard industrial classification (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list\">SIC</a>) * @param {string} [filingDate] Query by the date when the filing with financials data was filed in YYYY-MM-DD format. Best used when querying over date ranges to find financials based on filings that happen in a time period. Examples: To get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01 To get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01 * @param {string} [periodOfReportDate] The period of report for the filing with financials data in YYYY-MM-DD format. * @param {ListFinancialsTimeframeEnum} [timeframe] Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4 * @param {boolean} [includeSources] Whether or not to include the `xpath` and `formula` attributes for each financial data point. See the `xpath` and `formula` response attributes for more info. False by default. * @param {string} [companyNameSearch] Search by company_name. * @param {string} [filingDateGte] Search by filing_date. * @param {string} [filingDateGt] Search by filing_date. * @param {string} [filingDateLte] Search by filing_date. * @param {string} [filingDateLt] Search by filing_date. * @param {string} [periodOfReportDateGte] Search by period_of_report_date. * @param {string} [periodOfReportDateGt] Search by period_of_report_date. * @param {string} [periodOfReportDateLte] Search by period_of_report_date. * @param {string} [periodOfReportDateLt] Search by period_of_report_date. * @param {ListFinancialsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 100. * @param {ListFinancialsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFinancials(ticker?: string, cik?: string, companyName?: string, sic?: string, filingDate?: string, periodOfReportDate?: string, timeframe?: ListFinancialsTimeframeEnum, includeSources?: boolean, companyNameSearch?: string, filingDateGte?: string, filingDateGt?: string, filingDateLte?: string, filingDateLt?: string, periodOfReportDateGte?: string, periodOfReportDateGt?: string, periodOfReportDateLte?: string, periodOfReportDateLt?: string, order?: ListFinancialsOrderEnum, limit?: number, sort?: ListFinancialsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * The IPOs API provides access to detailed information about Initial Public Offerings (IPOs), including both upcoming and historical events. With this API, you can query for a comprehensive list of IPOs, along with key details such as the issuer name, ticker symbol, ISIN, IPO date, number of shares offered, expected price range, and final offering price. You can filter the results by status to focus on new, rumors, pending, historical, and more. * @summary IPOs * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, TSLA represents Tesla Inc. * @param {string} [usCode] Specify a us_code. This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. * @param {string} [isin] Specify an International Securities Identification Number (ISIN). This is a unique twelve-digit code that is assigned to every security issuance in the world. * @param {string} [listingDate] Specify a listing date. This is the first trading date for the newly listed entity. * @param {ListIPOsIpoStatusEnum} [ipoStatus] Specify an IPO status. * @param {string} [listingDateGte] Range by listing_date. * @param {string} [listingDateGt] Range by listing_date. * @param {string} [listingDateLte] Range by listing_date. * @param {string} [listingDateLt] Range by listing_date. * @param {ListIPOsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListIPOsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listIPOs(ticker?: string, usCode?: string, isin?: string, listingDate?: string, ipoStatus?: ListIPOsIpoStatusEnum, listingDateGte?: string, listingDateGt?: string, listingDateLte?: string, listingDateLt?: string, order?: ListIPOsOrderEnum, limit?: number, sort?: ListIPOsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source. * @summary Ticker News * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {ListNewsPublishedUtcParameter} [publishedUtc] Return results published on, before, or after this date. * @param {string} [tickerGte] Search by ticker. * @param {string} [tickerGt] Search by ticker. * @param {string} [tickerLte] Search by ticker. * @param {string} [tickerLt] Search by ticker. * @param {ListNewsPublishedUtcParameter} [publishedUtcGte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcGt] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLt] Search by published_utc. * @param {ListNewsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListNewsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNews(ticker?: string, publishedUtc?: ListNewsPublishedUtcParameter, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, publishedUtcGte?: ListNewsPublishedUtcParameter, publishedUtcGt?: ListNewsPublishedUtcParameter, publishedUtcLte?: ListNewsPublishedUtcParameter, publishedUtcLt?: ListNewsPublishedUtcParameter, order?: ListNewsOrderEnum, limit?: number, sort?: ListNewsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {number} [strikePrice] Query by strike price of a contract. * @param {boolean} [expired] Query for expired contracts. Default is false. * @param {string} [underlyingTickerGte] Range by underlying_ticker. * @param {string} [underlyingTickerGt] Range by underlying_ticker. * @param {string} [underlyingTickerLte] Range by underlying_ticker. * @param {string} [underlyingTickerLt] Range by underlying_ticker. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {ListOptionsContractsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListOptionsContractsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOptionsContracts(underlyingTicker?: string, ticker?: string, contractType?: ListOptionsContractsContractTypeEnum, expirationDate?: string, asOf?: string, strikePrice?: number, expired?: boolean, underlyingTickerGte?: string, underlyingTickerGt?: string, underlyingTickerLte?: string, underlyingTickerLt?: string, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, order?: ListOptionsContractsOrderEnum, limit?: number, sort?: ListOptionsContractsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Get a list of historical stock splits, including the ticker symbol, the execution date, and the factors of the split ratio. * @summary Stock Splits v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [executionDate] Query by execution date with the format YYYY-MM-DD. * @param {boolean | null} [reverseSplit] Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. By default this filter is not used. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [executionDateGte] Range by execution_date. * @param {string} [executionDateGt] Range by execution_date. * @param {string} [executionDateLte] Range by execution_date. * @param {string} [executionDateLt] Range by execution_date. * @param {ListStockSplitsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListStockSplitsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listStockSplits(ticker?: string, executionDate?: string, reverseSplit?: boolean | null, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, executionDateGte?: string, executionDateGt?: string, executionDateLte?: string, executionDateLt?: string, order?: ListStockSplitsOrderEnum, limit?: number, sort?: ListStockSplitsSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * List all ticker types that Polygon.io has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTickerTypes(assetClass?: ListTickerTypesAssetClassEnum, locale?: ListTickerTypesLocaleEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; /** * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. * @param {string} [cik] Specify the CIK of the asset you want to search for. Find more information about CIK codes [at their website](https://www.sec.gov/edgar/searchedgar/cik.htm). Defaults to empty string which queries all CIKs. * @param {string} [date] Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date. * @param {string} [search] Search for terms within the ticker and/or company name. * @param {boolean} [active] Specify if the tickers returned should be actively traded on the queried date. Default is true. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {ListTickersOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 100 and max is 1000. * @param {ListTickersSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTickers(ticker?: string, type?: ListTickersTypeEnum, market?: ListTickersMarketEnum, exchange?: string, cusip?: string, cik?: string, date?: string, search?: string, active?: boolean, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: ListTickersOrderEnum, limit?: number, sort?: ListTickersSortEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise>; }; /** * DefaultApi - factory interface * @export */ declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker Full Book (L2) * @param {string} ticker The cryptocurrency ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetCryptoSnapshotTickerBook(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get historic trade ticks for a cryptocurrency pair. * @summary Historic Crypto Trades * @param {string} from The \"from\" symbol of the crypto pair. * @param {string} to The \"to\" symbol of the crypto pair. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricCryptoTrades(from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get historic ticks for a forex currency pair. * @summary Historic Forex Ticks * @param {string} from The \"from\" symbol of the currency pair. Example: For **USD/JPY** the `from` would be **USD**. * @param {string} to The \"to\" symbol of the currency pair. Example: For **USD/JPY** the `to` would be **JPY**. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricForexQuotes(from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get NBBO quotes for a given ticker symbol on a specified date. * @summary Quotes (NBBO) * @param {string} ticker The ticker symbol we want quotes for. * @param {string} date The date/day of the quotes to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricStocksQuotes(ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a given ticker symbol on a specified date. * @summary Trades * @param {string} ticker The ticker symbol we want trades for. * @param {string} date The date/day of the trades to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deprecatedGetHistoricStocksTrades(ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [firm] The name of the research firm or investment bank issuing the rating. * @param {string} [firmAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmGt] Filter greater than the value. * @param {string} [firmGte] Filter greater than or equal to the value. * @param {string} [firmLt] Filter less than the value. * @param {string} [firmLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for the firm record. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [benzingaRatingId] The identifier used by Benzinga for the rating record. * @param {string} [benzingaRatingIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaRatingIdGt] Filter greater than the value. * @param {string} [benzingaRatingIdGte] Filter greater than or equal to the value. * @param {string} [benzingaRatingIdLt] Filter less than the value. * @param {string} [benzingaRatingIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1AnalystInsights(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, firm?: string, firmAnyOf?: string, firmGt?: string, firmGte?: string, firmLt?: string, firmLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, benzingaRatingId?: string, benzingaRatingIdAnyOf?: string, benzingaRatingIdGt?: string, benzingaRatingIdGte?: string, benzingaRatingIdLt?: string, benzingaRatingIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms. * @param {string} [benzingaId] The identifier used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The unique identifier assigned by Benzinga to the research firm or investment bank. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [firmName] The name of the research firm or investment bank issuing the ratings. * @param {string} [firmNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmNameGt] Filter greater than the value. * @param {string} [firmNameGte] Filter greater than or equal to the value. * @param {string} [firmNameLt] Filter less than the value. * @param {string} [firmNameLte] Filter less than or equal to the value. * @param {string} [fullName] The full name of the analyst associated with the ratings. * @param {string} [fullNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fullNameGt] Filter greater than the value. * @param {string} [fullNameGte] Filter greater than or equal to the value. * @param {string} [fullNameLt] Filter less than the value. * @param {string} [fullNameLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'full_name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Analysts(benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, firmName?: string, firmNameAnyOf?: string, firmNameGt?: string, firmNameGte?: string, firmNameLt?: string, firmNameLte?: string, fullName?: string, fullNameAnyOf?: string, fullNameGt?: string, fullNameGte?: string, fullNameLt?: string, fullNameLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. * @param {string} ticker The requested ticker. * @param {string} [date] The publication date of the news article. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company reporting earnings. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateStatusGt] Filter greater than the value. * @param {string} [dateStatusGte] Filter greater than or equal to the value. * @param {string} [dateStatusLt] Filter less than the value. * @param {string} [dateStatusLte] Filter less than or equal to the value. * @param {number} [epsSurprisePercent] The percentage difference between the actual and estimated EPS. Value must be a floating point number. * @param {string} [epsSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [epsSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercent] The percentage difference between the actual and estimated revenue. Value must be a floating point number. * @param {string} [revenueSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [revenueSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [fiscalYear] The fiscal year in which the earnings period falls. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Earnings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, dateStatus?: string, dateStatusAnyOf?: string, dateStatusGt?: string, dateStatusGte?: string, dateStatusLt?: string, dateStatusLte?: string, epsSurprisePercent?: number, epsSurprisePercentAnyOf?: string, epsSurprisePercentGt?: number, epsSurprisePercentGte?: number, epsSurprisePercentLt?: number, epsSurprisePercentLte?: number, revenueSurprisePercent?: number, revenueSurprisePercentAnyOf?: string, revenueSurprisePercentGt?: number, revenueSurprisePercentGte?: number, revenueSurprisePercentLt?: number, revenueSurprisePercentLte?: number, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Firms(benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the guidance was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company issuing guidance. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [positioning] Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are \'primary\' (the emphasized figure) and \'secondary\' (a supporting or alternate figure) * @param {string} [positioningAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [positioningGt] Filter greater than the value. * @param {string} [positioningGte] Filter greater than or equal to the value. * @param {string} [positioningLt] Filter less than the value. * @param {string} [positioningLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {number} [fiscalYear] The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Guidance(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, positioning?: string, positioningAnyOf?: string, positioningGt?: string, positioningGte?: string, positioningLt?: string, positioningLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. * @param {string} [publishedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [publishedGt] Filter greater than the value. * @param {string} [publishedGte] Filter greater than or equal to the value. * @param {string} [publishedLt] Filter less than the value. * @param {string} [publishedLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [tickers] Filter for arrays that contain the value. * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channels] Filter for arrays that contain the value. * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tags] Filter for arrays that contain the value. * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [author] The name of the journalist or entity that authored the news article. * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [authorGt] Filter greater than the value. * @param {string} [authorGte] Filter greater than or equal to the value. * @param {string} [authorLt] Filter less than the value. * @param {string} [authorLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1News(published?: string, publishedAnyOf?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [priceTargetAction] The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets. * @param {string} [priceTargetActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [priceTargetActionGt] Filter greater than the value. * @param {string} [priceTargetActionGte] Filter greater than or equal to the value. * @param {string} [priceTargetActionLt] Filter less than the value. * @param {string} [priceTargetActionLte] Filter less than or equal to the value. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaAnalystId] The identifer used by Benzinga for this analyst. * @param {string} [benzingaAnalystIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaAnalystIdGt] Filter greater than the value. * @param {string} [benzingaAnalystIdGte] Filter greater than or equal to the value. * @param {string} [benzingaAnalystIdLt] Filter less than the value. * @param {string} [benzingaAnalystIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for this firm. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetCryptoAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoAggregates(cryptoTicker: string, multiplier: number, timespan: GetCryptoAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetCryptoAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} cryptoTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoEMA(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoEMATimespanEnum, window?: number, seriesType?: GetCryptoEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} cryptoTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetCryptoMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate MACD data. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoMACD(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoMACDTimespanEnum, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetCryptoMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close prices of a cryptocurrency symbol on a certain day. * @summary Daily Open/Close * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoOpenClose(from: string, to: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} cryptoTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoRSI(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoRSITimespanEnum, window?: number, seriesType?: GetCryptoRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} cryptoTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSMA(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoSMATimespanEnum, window?: number, seriesType?: GetCryptoSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current top 20 gainers or losers of the day in cryptocurrency markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetCryptoSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotDirection(direction: GetCryptoSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker Ticker of the snapshot * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotTicker(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoSnapshotTickers(tickers?: Array, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a crypto ticker symbol in a given time range. * @summary Trades * @param {string} cryptoTicker The ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetCryptoTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetCryptoTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCryptoTrades(cryptoTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetCryptoTradesOrderEnum, limit?: number, sort?: GetCryptoTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. * @summary Real-time Currency Conversion * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {number} [amount] The amount to convert, with a decimal. * @param {GetCurrencyConversionPrecisionEnum} [precision] The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCurrencyConversion(from: string, to: string, amount?: number, precision?: GetCurrencyConversionPrecisionEnum, options?: RawAxiosRequestConfig): Promise; /** * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. * @summary Ticker Events * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvents(id: string, types?: string, options?: RawAxiosRequestConfig): Promise; /** * A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1Inflation(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1InflationExpectations(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities. * @param {string} [date] Calendar date of the yield observation (YYYY-MM-DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFedV1TreasuryYields(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for a forex pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} forexTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetForexAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexAggregates(forexTicker: string, multiplier: number, timespan: GetForexAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetForexAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} fxTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexEMA(fxTicker: string, timestamp?: string, timespan?: GetForexEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} fxTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetForexMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexMACD(fxTicker: string, timestamp?: string, timespan?: GetForexMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetForexMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get BBO quotes for a ticker symbol in a given time range. * @summary Quotes (BBO) * @param {string} fxTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetForexQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetForexQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexQuotes(fxTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetForexQuotesOrderEnum, limit?: number, sort?: GetForexQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} fxTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetForexRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexRSI(fxTicker: string, timestamp?: string, timespan?: GetForexRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} fxTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSMA(fxTicker: string, timestamp?: string, timespan?: GetForexSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current top 20 gainers or losers of the day in forex markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetForexSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotDirection(direction: GetForexSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker The forex ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotTicker(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getForexSnapshotTickers(tickers?: Array, options?: RawAxiosRequestConfig): Promise; /** * Get aggregates for a contract in a given time range. * @summary Aggregates * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [windowStartGte] Range by window_start. * @param {string} [windowStartGt] Range by window_start. * @param {string} [windowStartLte] Range by window_start. * @param {string} [windowStartLt] Range by window_start. * @param {GetFuturesAggregatesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesAggregates(ticker: string, resolution?: string, windowStart?: string, limit?: number, windowStartGte?: string, windowStartGt?: string, windowStartLte?: string, windowStartLt?: string, sort?: GetFuturesAggregatesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Contract Details endpoint returns the details for a single contract at a specific point in time. * @summary Contract Details * @param {string} ticker The ticker symbol of the contract to retrieve. * @param {string} [asOf] The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesContractDetails(ticker: string, asOf?: string, options?: RawAxiosRequestConfig): Promise; /** * The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract\'s ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date. * @summary Contracts * @param {string} [productCode] A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product. * @param {string} [firstTradeDate] The first day that a contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [lastTradeDate] The last day that the contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [asOf] Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today). * @param {GetFuturesContractsActiveEnum} [active] Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract\'s \'first_trade_date\' and less-than-or-equal-to its \'last_trade_date\', then the contract was active. If the date queried is greater-than-or-equal-to the contract\'s \'last_trade_date\' or less-than-or-equal-to its \'first_trade_date\', then the contract was inactive. * @param {GetFuturesContractsTypeEnum} [type] The type of contract, one of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesContractsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesContracts(productCode?: string, firstTradeDate?: string, lastTradeDate?: string, asOf?: string, active?: GetFuturesContractsActiveEnum, type?: GetFuturesContractsTypeEnum, limit?: number, sort?: GetFuturesContractsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps. * @summary Daily Schedules * @param {string} [sessionEndDate] The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to \'today\' in Central Time. e.g. If a request is made from Pacific Time on \'2025-01-01\' at 11:00 pm with no \'session_end_date\' a default value of `2025-01-02` will be used. * @param {string} [tradingVenue] The trading venue (MIC) of the exchange for the schedules. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesDailySchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesDailySchedules(sessionEndDate?: string, tradingVenue?: string, limit?: number, sort?: GetFuturesDailySchedulesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The market status endpoint returns the current status of the futures market for the given product code(s). * @summary Market Status * @param {string} [productCodeAnyOf] The product code(s) to return market statuses for. Multiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes. * @param {string} [productCode] The product code to return market statuses for. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesMarketStatusesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesMarketStatuses(productCodeAnyOf?: string, productCode?: string, limit?: number, sort?: GetFuturesMarketStatusesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Product Details endpoint returns the details for a single product as of a specific day. * @summary Product Details * @param {string} productCode The unique identifier for a product. * @param {GetFuturesProductDetailsTypeEnum} [type] The type of product to return. One of \"single\" or \"combo\" (default=single). * @param {string} [asOf] A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product\'s data at that point-in-time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProductDetails(productCode: string, type?: GetFuturesProductDetailsTypeEnum, asOf?: string, options?: RawAxiosRequestConfig): Promise; /** * The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps. * @summary Product Schedules * @param {string} productCode The product code for the futures product. * @param {string} [sessionEndDate] The date on which the schedule\'s trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesProductSchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProductSchedules(productCode: string, sessionEndDate?: string, limit?: number, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesProductSchedulesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product\'s name, exchange, sector, sub-sector, asset class, asset sub-class, and type. * @summary Products * @param {string} [name] Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive. * @param {string} [asOf] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). * @param {string} [tradingVenue] The trading venue (MIC) for the exchange on which the products trades. * @param {GetFuturesProductsSectorEnum} [sector] The sector to which the products belong. * @param {GetFuturesProductsSubSectorEnum} [subSector] The sub-sector to which the products belong. * @param {GetFuturesProductsAssetClassEnum} [assetClass] The asset class to which the products belong. * @param {GetFuturesProductsAssetSubClassEnum} [assetSubClass] The asset sub-class to which the products belong. * @param {GetFuturesProductsTypeEnum} [type] The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, maximum=1000, minimum=1). * @param {string} [nameSearch] Search by name. * @param {GetFuturesProductsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesProducts(name?: string, asOf?: string, tradingVenue?: string, sector?: GetFuturesProductsSectorEnum, subSector?: GetFuturesProductsSubSectorEnum, assetClass?: GetFuturesProductsAssetClassEnum, assetSubClass?: GetFuturesProductsAssetSubClassEnum, type?: GetFuturesProductsTypeEnum, limit?: number, nameSearch?: string, sort?: GetFuturesProductsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get quotes for a contract in a given time range. * @summary Quotes * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesQuotesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesQuotes(ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a contract in a given time range. * @summary Trades * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesTradesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFuturesTrades(ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedCryptoAggregates(date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire forex markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedForexAggregates(date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGroupedStocksAggregates(date: string, adjusted?: boolean, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for an index over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} indicesTicker The ticker symbol of Index. * @param {number} multiplier The size of the timespan multiplier. * @param {GetIndicesAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesAggregates(indicesTicker: string, multiplier: number, timespan: GetIndicesAggregatesTimespanEnum, from: string, to: string, sort?: GetIndicesAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} indicesTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesEMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close values to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesEMA(indicesTicker: string, timestamp?: string, timespan?: GetIndicesEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} indicesTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetIndicesMACDSeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close values to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesMACD(indicesTicker: string, timestamp?: string, timespan?: GetIndicesMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetIndicesMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close and afterhours values of a index symbol on a certain date. * @summary Daily Open/Close * @param {string} indicesTicker The ticker symbol of Index. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesOpenClose(indicesTicker: string, date: string, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} indicesTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetIndicesRSISeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close values to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesRSI(indicesTicker: string, timestamp?: string, timespan?: GetIndicesRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} indicesTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesSMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close values to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesSMA(indicesTicker: string, timestamp?: string, timespan?: GetIndicesSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get a Snapshot of indices data for said tickers * @summary Indices Snapshot * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {string} [ticker] Search a range of tickers lexicographically. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {GetIndicesSnapshotOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetIndicesSnapshotSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getIndicesSnapshot(tickerAnyOf?: string, ticker?: string, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: GetIndicesSnapshotOrderEnum, limit?: number, sort?: GetIndicesSnapshotSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the last trade tick for a cryptocurrency pair. * @summary Last Trade for a Crypto Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastCryptoTrade(from: string, to: string, options?: RawAxiosRequestConfig): Promise; /** * Get the last quote tick for a forex currency pair. * @summary Last Quote for a Currency Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastCurrencyQuote(from: string, to: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent trade for a given options contract. * @summary Last Trade * @param {string} optionsTicker The ticker symbol of the options contract. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastOptionsTrade(optionsTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent NBBO (Quote) tick for a given stock. * @summary Last Quote * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastStocksQuote(stocksTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent trade for a given stock. * @summary Last Trade * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLastStocksTrade(stocksTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get upcoming market holidays and their open/close times. * @summary Market Holidays * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketHolidays(options?: RawAxiosRequestConfig): Promise>; /** * Get the current trading status of the exchanges and overall financial markets. * @summary Market Status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMarketStatus(options?: RawAxiosRequestConfig): Promise; /** * Get the snapshot of an option contract for a stock equity. * @summary Option Contract * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {string} optionContract The option contract identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionContract(underlyingAsset: string, optionContract: string, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for an option contract over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} optionsTicker The ticker symbol of the options contract. * @param {number} multiplier The size of the timespan multiplier. * @param {GetOptionsAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsAggregates(optionsTicker: string, multiplier: number, timespan: GetOptionsAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetOptionsAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the snapshot of all options contracts for an underlying ticker. * @summary Options Chain * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {number} [strikePrice] Query by strike price of a contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {GetOptionsChainContractTypeEnum} [contractType] Query by the type of contract. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {GetOptionsChainOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetOptionsChainSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsChain(underlyingAsset: string, strikePrice?: number, expirationDate?: string, contractType?: GetOptionsChainContractTypeEnum, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, order?: GetOptionsChainOrderEnum, limit?: number, sort?: GetOptionsChainSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get an options contract * @summary Options Contract * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsContract(optionsTicker: string, asOf?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} optionsTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsEMA(optionsTicker: string, timestamp?: string, timespan?: GetOptionsEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} optionsTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetOptionsMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsMACD(optionsTicker: string, timestamp?: string, timespan?: GetOptionsMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetOptionsMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close and afterhours prices of an options contract on a certain date. * @summary Daily Open/Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsOpenClose(optionsTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get quotes for an options ticker symbol in a given time range. * @summary Quotes * @param {string} optionsTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsQuotes(optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsQuotesOrderEnum, limit?: number, sort?: GetOptionsQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} optionsTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetOptionsRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsRSI(optionsTicker: string, timestamp?: string, timespan?: GetOptionsRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} optionsTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsSMA(optionsTicker: string, timestamp?: string, timespan?: GetOptionsSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get trades for an options ticker symbol in a given time range. * @summary Trades * @param {string} optionsTicker The options ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOptionsTrades(optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsTradesOrderEnum, limit?: number, sort?: GetOptionsTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. * @summary Previous Close * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousCryptoAggregates(cryptoTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified forex pair. * @summary Previous Close * @param {string} forexTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousForexAggregates(forexTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified index. * @summary Previous Close * @param {string} indicesTicker The ticker symbol of Index. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousIndicesAggregates(indicesTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified option contract. * @summary Previous Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousOptionsAggregates(optionsTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified stock ticker. * @summary Previous Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPreviousStocksAggregates(stocksTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get a list of tickers related to the queried ticker based on News and Returns data. * @summary Related Companies * @param {string} ticker The ticker symbol to search. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRelatedCompanies(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get everything needed to visualize the tick-by-tick movement of a list of tickers. * @summary Summaries * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSnapshotSummary(tickerAnyOf?: string, options?: RawAxiosRequestConfig): Promise; /** * Get snapshots for assets of all types * @summary Universal Snapshot * @param {string} [ticker] Search a range of tickers lexicographically. * @param {GetSnapshotsTypeEnum} [type] Query by the type of asset. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {GetSnapshotsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetSnapshotsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSnapshots(ticker?: string, type?: GetSnapshotsTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, tickerAnyOf?: string, order?: GetSnapshotsOrderEnum, limit?: number, sort?: GetSnapshotsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for a stock over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {number} multiplier The size of the timespan multiplier. * @param {GetStocksAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksAggregates(stocksTicker: string, multiplier: number, timespan: GetStocksAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetStocksAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksEMA(stockTicker: string, timestamp?: string, timespan?: GetStocksEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get moving average convergence/divergence (MACD) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetStocksMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksMACD(stockTicker: string, timestamp?: string, timespan?: GetStocksMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetStocksMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close and afterhours prices of a stock symbol on a certain date. * @summary Daily Open/Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksOpenClose(stocksTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get NBBO quotes for a ticker symbol in a given time range. * @summary Quotes (NBBO) * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksQuotes(stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksQuotesOrderEnum, limit?: number, sort?: GetStocksQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get relative strength index (RSI) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetStocksRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksRSI(stockTicker: string, timestamp?: string, timespan?: GetStocksRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get simple moving average (SMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSMA(stockTicker: string, timestamp?: string, timespan?: GetStocksSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close. This output will only include tickers with a trading volume of 10,000 or more.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetStocksSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotDirection(direction: GetStocksSnapshotDirectionDirectionEnum, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the most up-to-date market data for a single traded stock ticker.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary Ticker * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotTicker(stocksTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most up-to-date market data for all traded stock symbols.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksSnapshotTickers(tickers?: Array, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a ticker symbol in a given time range. * @summary Trades * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksTrades(stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksTradesOrderEnum, limit?: number, sort?: GetStocksTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [daysToCover] Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. Value must be a floating point number. * @param {string} [daysToCoverAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [daysToCoverGt] Filter greater than the value. Value must be a floating point number. * @param {number} [daysToCoverGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [daysToCoverLt] Filter less than the value. Value must be a floating point number. * @param {number} [daysToCoverLte] Filter less than or equal to the value. Value must be a floating point number. * @param {string} [settlementDate] The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. * @param {string} [settlementDateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [settlementDateGt] Filter greater than the value. * @param {string} [settlementDateGte] Filter greater than or equal to the value. * @param {string} [settlementDateLt] Filter less than the value. * @param {string} [settlementDateLte] Filter less than or equal to the value. * @param {number} [avgDailyVolume] The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer. * @param {string} [avgDailyVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [avgDailyVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [avgDailyVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [avgDailyVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [avgDailyVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksV1ShortInterest(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, daysToCover?: number, daysToCoverAnyOf?: string, daysToCoverGt?: number, daysToCoverGte?: number, daysToCoverLt?: number, daysToCoverLte?: number, settlementDate?: string, settlementDateAnyOf?: string, settlementDateGt?: string, settlementDateGte?: string, settlementDateLt?: string, settlementDateLte?: string, avgDailyVolume?: number, avgDailyVolumeAnyOf?: string, avgDailyVolumeGt?: number, avgDailyVolumeGte?: number, avgDailyVolumeLt?: number, avgDailyVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [date] The date of trade activity reported in the format YYYY-MM-DD * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [shortVolumeRatio] The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number. * @param {string} [shortVolumeRatioAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [shortVolumeRatioGt] Filter greater than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLt] Filter less than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [totalVolume] Total reported volume across all venues for the ticker on the given date. Value must be an integer. * @param {string} [totalVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [totalVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [totalVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [totalVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [totalVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStocksV1ShortVolume(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, shortVolumeRatio?: number, shortVolumeRatioAnyOf?: string, shortVolumeRatioGt?: number, shortVolumeRatioGte?: number, shortVolumeRatioLt?: number, shortVolumeRatioLte?: number, totalVolume?: number, totalVolumeAnyOf?: string, totalVolumeGt?: number, totalVolumeGte?: number, totalVolumeLt?: number, totalVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTicker(ticker: string, date?: string, options?: RawAxiosRequestConfig): Promise; /** * * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [type] The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop. * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [typeGt] Filter greater than the value. * @param {string} [typeGte] Filter greater than or equal to the value. * @param {string} [typeLt] Filter less than the value. * @param {string} [typeLte] Filter less than or equal to the value. * @param {string} [status] The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed. * @param {string} [statusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [statusGt] Filter greater than the value. * @param {string} [statusGte] Filter greater than or equal to the value. * @param {string} [statusLt] Filter less than the value. * @param {string} [statusLte] Filter less than or equal to the value. * @param {string} [ticker] The company\'s stock symbol. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [isin] Standard international identifier for the company\'s common stock. * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [isinGt] Filter greater than the value. * @param {string} [isinGte] Filter greater than or equal to the value. * @param {string} [isinLt] Filter less than the value. * @param {string} [isinLte] Filter less than or equal to the value. * @param {string} [tradingVenue] MIC (Market Identifier Code) of the exchange where the company\'s stock is listed. * @param {string} [tradingVenueAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tradingVenueGt] Filter greater than the value. * @param {string} [tradingVenueGte] Filter greater than or equal to the value. * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. * @param {number} [tmxCompanyIdLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [tmxRecordId] The unique alphanumeric identifier for the event record used by TMX. * @param {string} [tmxRecordIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tmxRecordIdGt] Filter greater than the value. * @param {string} [tmxRecordIdGte] Filter greater than or equal to the value. * @param {string} [tmxRecordIdLt] Filter less than the value. * @param {string} [tmxRecordIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * List all conditions that Polygon.io uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. * @param {number} [id] Filter for conditions with a given ID. * @param {ListConditionsSipEnum} [sip] Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned. * @param {ListConditionsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListConditionsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listConditions(assetClass?: ListConditionsAssetClassEnum, dataType?: ListConditionsDataTypeEnum, id?: number, sip?: ListConditionsSipEnum, order?: ListConditionsOrderEnum, limit?: number, sort?: ListConditionsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get a list of historical cash dividends, including the ticker symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount. * @summary Dividends v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [exDividendDate] Query by ex-dividend date with the format YYYY-MM-DD. * @param {string} [recordDate] Query by record date with the format YYYY-MM-DD. * @param {string} [declarationDate] Query by declaration date with the format YYYY-MM-DD. * @param {string} [payDate] Query by pay date with the format YYYY-MM-DD. * @param {ListDividendsFrequencyEnum} [frequency] Query by the number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly). * @param {number} [cashAmount] Query by the cash amount of the dividend. * @param {ListDividendsDividendTypeEnum} [dividendType] Query by the type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [exDividendDateGte] Range by ex_dividend_date. * @param {string} [exDividendDateGt] Range by ex_dividend_date. * @param {string} [exDividendDateLte] Range by ex_dividend_date. * @param {string} [exDividendDateLt] Range by ex_dividend_date. * @param {string} [recordDateGte] Range by record_date. * @param {string} [recordDateGt] Range by record_date. * @param {string} [recordDateLte] Range by record_date. * @param {string} [recordDateLt] Range by record_date. * @param {string} [declarationDateGte] Range by declaration_date. * @param {string} [declarationDateGt] Range by declaration_date. * @param {string} [declarationDateLte] Range by declaration_date. * @param {string} [declarationDateLt] Range by declaration_date. * @param {string} [payDateGte] Range by pay_date. * @param {string} [payDateGt] Range by pay_date. * @param {string} [payDateLte] Range by pay_date. * @param {string} [payDateLt] Range by pay_date. * @param {number} [cashAmountGte] Range by cash_amount. * @param {number} [cashAmountGt] Range by cash_amount. * @param {number} [cashAmountLte] Range by cash_amount. * @param {number} [cashAmountLt] Range by cash_amount. * @param {ListDividendsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListDividendsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listDividends(ticker?: string, exDividendDate?: string, recordDate?: string, declarationDate?: string, payDate?: string, frequency?: ListDividendsFrequencyEnum, cashAmount?: number, dividendType?: ListDividendsDividendTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, exDividendDateGte?: string, exDividendDateGt?: string, exDividendDateLte?: string, exDividendDateLt?: string, recordDateGte?: string, recordDateGt?: string, recordDateLte?: string, recordDateLt?: string, declarationDateGte?: string, declarationDateGt?: string, declarationDateLte?: string, declarationDateLt?: string, payDateGte?: string, payDateGt?: string, payDateLte?: string, payDateLt?: string, cashAmountGte?: number, cashAmountGt?: number, cashAmountLte?: number, cashAmountLt?: number, order?: ListDividendsOrderEnum, limit?: number, sort?: ListDividendsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * List all exchanges that Polygon.io knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listExchanges(assetClass?: ListExchangesAssetClassEnum, locale?: ListExchangesLocaleEnum, options?: RawAxiosRequestConfig): Promise; /** * Get historical financial data for a stock ticker. The financials data is extracted from XBRL from company SEC filings using the methodology outlined here. * @summary Stock Financials vX * @param {string} [ticker] Query by company ticker. * @param {string} [cik] Query by central index key (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/edgar/searchedgar/cik.htm\">CIK</a>) Number * @param {string} [companyName] Query by company name. * @param {string} [sic] Query by standard industrial classification (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list\">SIC</a>) * @param {string} [filingDate] Query by the date when the filing with financials data was filed in YYYY-MM-DD format. Best used when querying over date ranges to find financials based on filings that happen in a time period. Examples: To get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01 To get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01 * @param {string} [periodOfReportDate] The period of report for the filing with financials data in YYYY-MM-DD format. * @param {ListFinancialsTimeframeEnum} [timeframe] Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4 * @param {boolean} [includeSources] Whether or not to include the `xpath` and `formula` attributes for each financial data point. See the `xpath` and `formula` response attributes for more info. False by default. * @param {string} [companyNameSearch] Search by company_name. * @param {string} [filingDateGte] Search by filing_date. * @param {string} [filingDateGt] Search by filing_date. * @param {string} [filingDateLte] Search by filing_date. * @param {string} [filingDateLt] Search by filing_date. * @param {string} [periodOfReportDateGte] Search by period_of_report_date. * @param {string} [periodOfReportDateGt] Search by period_of_report_date. * @param {string} [periodOfReportDateLte] Search by period_of_report_date. * @param {string} [periodOfReportDateLt] Search by period_of_report_date. * @param {ListFinancialsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 100. * @param {ListFinancialsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFinancials(ticker?: string, cik?: string, companyName?: string, sic?: string, filingDate?: string, periodOfReportDate?: string, timeframe?: ListFinancialsTimeframeEnum, includeSources?: boolean, companyNameSearch?: string, filingDateGte?: string, filingDateGt?: string, filingDateLte?: string, filingDateLt?: string, periodOfReportDateGte?: string, periodOfReportDateGt?: string, periodOfReportDateLte?: string, periodOfReportDateLt?: string, order?: ListFinancialsOrderEnum, limit?: number, sort?: ListFinancialsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The IPOs API provides access to detailed information about Initial Public Offerings (IPOs), including both upcoming and historical events. With this API, you can query for a comprehensive list of IPOs, along with key details such as the issuer name, ticker symbol, ISIN, IPO date, number of shares offered, expected price range, and final offering price. You can filter the results by status to focus on new, rumors, pending, historical, and more. * @summary IPOs * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, TSLA represents Tesla Inc. * @param {string} [usCode] Specify a us_code. This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. * @param {string} [isin] Specify an International Securities Identification Number (ISIN). This is a unique twelve-digit code that is assigned to every security issuance in the world. * @param {string} [listingDate] Specify a listing date. This is the first trading date for the newly listed entity. * @param {ListIPOsIpoStatusEnum} [ipoStatus] Specify an IPO status. * @param {string} [listingDateGte] Range by listing_date. * @param {string} [listingDateGt] Range by listing_date. * @param {string} [listingDateLte] Range by listing_date. * @param {string} [listingDateLt] Range by listing_date. * @param {ListIPOsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListIPOsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listIPOs(ticker?: string, usCode?: string, isin?: string, listingDate?: string, ipoStatus?: ListIPOsIpoStatusEnum, listingDateGte?: string, listingDateGt?: string, listingDateLte?: string, listingDateLt?: string, order?: ListIPOsOrderEnum, limit?: number, sort?: ListIPOsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source. * @summary Ticker News * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {ListNewsPublishedUtcParameter} [publishedUtc] Return results published on, before, or after this date. * @param {string} [tickerGte] Search by ticker. * @param {string} [tickerGt] Search by ticker. * @param {string} [tickerLte] Search by ticker. * @param {string} [tickerLt] Search by ticker. * @param {ListNewsPublishedUtcParameter} [publishedUtcGte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcGt] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLt] Search by published_utc. * @param {ListNewsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListNewsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listNews(ticker?: string, publishedUtc?: ListNewsPublishedUtcParameter, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, publishedUtcGte?: ListNewsPublishedUtcParameter, publishedUtcGt?: ListNewsPublishedUtcParameter, publishedUtcLte?: ListNewsPublishedUtcParameter, publishedUtcLt?: ListNewsPublishedUtcParameter, order?: ListNewsOrderEnum, limit?: number, sort?: ListNewsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {number} [strikePrice] Query by strike price of a contract. * @param {boolean} [expired] Query for expired contracts. Default is false. * @param {string} [underlyingTickerGte] Range by underlying_ticker. * @param {string} [underlyingTickerGt] Range by underlying_ticker. * @param {string} [underlyingTickerLte] Range by underlying_ticker. * @param {string} [underlyingTickerLt] Range by underlying_ticker. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {ListOptionsContractsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListOptionsContractsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOptionsContracts(underlyingTicker?: string, ticker?: string, contractType?: ListOptionsContractsContractTypeEnum, expirationDate?: string, asOf?: string, strikePrice?: number, expired?: boolean, underlyingTickerGte?: string, underlyingTickerGt?: string, underlyingTickerLte?: string, underlyingTickerLt?: string, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, order?: ListOptionsContractsOrderEnum, limit?: number, sort?: ListOptionsContractsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get a list of historical stock splits, including the ticker symbol, the execution date, and the factors of the split ratio. * @summary Stock Splits v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [executionDate] Query by execution date with the format YYYY-MM-DD. * @param {boolean | null} [reverseSplit] Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. By default this filter is not used. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [executionDateGte] Range by execution_date. * @param {string} [executionDateGt] Range by execution_date. * @param {string} [executionDateLte] Range by execution_date. * @param {string} [executionDateLt] Range by execution_date. * @param {ListStockSplitsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListStockSplitsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listStockSplits(ticker?: string, executionDate?: string, reverseSplit?: boolean | null, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, executionDateGte?: string, executionDateGt?: string, executionDateLte?: string, executionDateLt?: string, order?: ListStockSplitsOrderEnum, limit?: number, sort?: ListStockSplitsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * List all ticker types that Polygon.io has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTickerTypes(assetClass?: ListTickerTypesAssetClassEnum, locale?: ListTickerTypesLocaleEnum, options?: RawAxiosRequestConfig): Promise; /** * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. * @param {string} [cik] Specify the CIK of the asset you want to search for. Find more information about CIK codes [at their website](https://www.sec.gov/edgar/searchedgar/cik.htm). Defaults to empty string which queries all CIKs. * @param {string} [date] Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date. * @param {string} [search] Search for terms within the ticker and/or company name. * @param {boolean} [active] Specify if the tickers returned should be actively traded on the queried date. Default is true. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {ListTickersOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 100 and max is 1000. * @param {ListTickersSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTickers(ticker?: string, type?: ListTickersTypeEnum, market?: ListTickersMarketEnum, exchange?: string, cusip?: string, cik?: string, date?: string, search?: string, active?: boolean, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: ListTickersOrderEnum, limit?: number, sort?: ListTickersSortEnum, options?: RawAxiosRequestConfig): Promise; }; /** * DefaultApi - object-oriented interface * @export * @class DefaultApi * @extends {BaseAPI} */ declare class DefaultApi extends BaseAPI { /** * Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker Full Book (L2) * @param {string} ticker The cryptocurrency ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deprecatedGetCryptoSnapshotTickerBook(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get historic trade ticks for a cryptocurrency pair. * @summary Historic Crypto Trades * @param {string} from The \"from\" symbol of the crypto pair. * @param {string} to The \"to\" symbol of the crypto pair. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deprecatedGetHistoricCryptoTrades(from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get historic ticks for a forex currency pair. * @summary Historic Forex Ticks * @param {string} from The \"from\" symbol of the currency pair. Example: For **USD/JPY** the `from` would be **USD**. * @param {string} to The \"to\" symbol of the currency pair. Example: For **USD/JPY** the `to` would be **JPY**. * @param {string} date The date/day of the historic ticks to retrieve. * @param {number} [offset] The 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. * @param {number} [limit] Limit the size of the response, max 10000. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deprecatedGetHistoricForexQuotes(from: string, to: string, date: string, offset?: number, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get NBBO quotes for a given ticker symbol on a specified date. * @summary Quotes (NBBO) * @param {string} ticker The ticker symbol we want quotes for. * @param {string} date The date/day of the quotes to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deprecatedGetHistoricStocksQuotes(ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a given ticker symbol on a specified date. * @summary Trades * @param {string} ticker The ticker symbol we want trades for. * @param {string} date The date/day of the trades to retrieve in the format YYYY-MM-DD. * @param {number} [timestamp] The 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. * @param {number} [timestampLimit] The maximum timestamp allowed in the results. * @param {boolean} [reverse] Reverse the order of the results. * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deprecatedGetHistoricStocksTrades(ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [firm] The name of the research firm or investment bank issuing the rating. * @param {string} [firmAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmGt] Filter greater than the value. * @param {string} [firmGte] Filter greater than or equal to the value. * @param {string} [firmLt] Filter less than the value. * @param {string} [firmLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for the firm record. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [benzingaRatingId] The identifier used by Benzinga for the rating record. * @param {string} [benzingaRatingIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaRatingIdGt] Filter greater than the value. * @param {string} [benzingaRatingIdGte] Filter greater than or equal to the value. * @param {string} [benzingaRatingIdLt] Filter less than the value. * @param {string} [benzingaRatingIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1AnalystInsights(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, firm?: string, firmAnyOf?: string, firmGt?: string, firmGte?: string, firmLt?: string, firmLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, benzingaRatingId?: string, benzingaRatingIdAnyOf?: string, benzingaRatingIdGt?: string, benzingaRatingIdGte?: string, benzingaRatingIdLt?: string, benzingaRatingIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms. * @param {string} [benzingaId] The identifier used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The unique identifier assigned by Benzinga to the research firm or investment bank. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {string} [firmName] The name of the research firm or investment bank issuing the ratings. * @param {string} [firmNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [firmNameGt] Filter greater than the value. * @param {string} [firmNameGte] Filter greater than or equal to the value. * @param {string} [firmNameLt] Filter less than the value. * @param {string} [firmNameLte] Filter less than or equal to the value. * @param {string} [fullName] The full name of the analyst associated with the ratings. * @param {string} [fullNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fullNameGt] Filter greater than the value. * @param {string} [fullNameGte] Filter greater than or equal to the value. * @param {string} [fullNameLt] Filter less than the value. * @param {string} [fullNameLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'full_name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1Analysts(benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, firmName?: string, firmNameAnyOf?: string, firmNameGt?: string, firmNameGte?: string, firmNameLt?: string, firmNameLte?: string, fullName?: string, fullNameAnyOf?: string, fullNameGt?: string, fullNameGte?: string, fullNameLt?: string, fullNameLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. * @param {string} ticker The requested ticker. * @param {string} [date] The publication date of the news article. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company reporting earnings. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateStatusGt] Filter greater than the value. * @param {string} [dateStatusGte] Filter greater than or equal to the value. * @param {string} [dateStatusLt] Filter less than the value. * @param {string} [dateStatusLte] Filter less than or equal to the value. * @param {number} [epsSurprisePercent] The percentage difference between the actual and estimated EPS. Value must be a floating point number. * @param {string} [epsSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [epsSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [epsSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercent] The percentage difference between the actual and estimated revenue. Value must be a floating point number. * @param {string} [revenueSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [revenueSurprisePercentGt] Filter greater than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLt] Filter less than the value. Value must be a floating point number. * @param {number} [revenueSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [fiscalYear] The fiscal year in which the earnings period falls. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1Earnings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, dateStatus?: string, dateStatusAnyOf?: string, dateStatusGt?: string, dateStatusGte?: string, dateStatusLt?: string, dateStatusLte?: string, epsSurprisePercent?: number, epsSurprisePercentAnyOf?: string, epsSurprisePercentGt?: number, epsSurprisePercentGte?: number, epsSurprisePercentLt?: number, epsSurprisePercentLte?: number, revenueSurprisePercent?: number, revenueSurprisePercentAnyOf?: string, revenueSurprisePercentGt?: number, revenueSurprisePercentGte?: number, revenueSurprisePercentLt?: number, revenueSurprisePercentLte?: number, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'name\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1Firms(benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the guidance was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company issuing guidance. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [positioning] Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are \'primary\' (the emphasized figure) and \'secondary\' (a supporting or alternate figure) * @param {string} [positioningAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [positioningGt] Filter greater than the value. * @param {string} [positioningGte] Filter greater than or equal to the value. * @param {string} [positioningLt] Filter less than the value. * @param {string} [positioningLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {number} [fiscalYear] The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer. * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [fiscalPeriod] The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4. * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [fiscalPeriodGt] Filter greater than the value. * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1Guidance(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, positioning?: string, positioningAnyOf?: string, positioningGt?: string, positioningGte?: string, positioningLt?: string, positioningLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. * @param {string} [publishedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [publishedGt] Filter greater than the value. * @param {string} [publishedGte] Filter greater than or equal to the value. * @param {string} [publishedLt] Filter less than the value. * @param {string} [publishedLte] Filter less than or equal to the value. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [tickers] Filter for arrays that contain the value. * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channels] Filter for arrays that contain the value. * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tags] Filter for arrays that contain the value. * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [author] The name of the journalist or entity that authored the news article. * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [authorGt] Filter greater than the value. * @param {string} [authorGte] Filter greater than or equal to the value. * @param {string} [authorLt] Filter less than the value. * @param {string} [authorLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1News(published?: string, publishedAnyOf?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers. * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [ticker] The stock symbol of the company being rated. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [lastUpdatedGt] Filter greater than the value. * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. * @param {string} [lastUpdatedLt] Filter less than the value. * @param {string} [lastUpdatedLte] Filter less than or equal to the value. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. * @param {string} [ratingActionGte] Filter greater than or equal to the value. * @param {string} [ratingActionLt] Filter less than the value. * @param {string} [ratingActionLte] Filter less than or equal to the value. * @param {string} [priceTargetAction] The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets. * @param {string} [priceTargetActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [priceTargetActionGt] Filter greater than the value. * @param {string} [priceTargetActionGte] Filter greater than or equal to the value. * @param {string} [priceTargetActionLt] Filter less than the value. * @param {string} [priceTargetActionLte] Filter less than or equal to the value. * @param {string} [benzingaId] The identifer used by Benzinga for this record. * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaIdGt] Filter greater than the value. * @param {string} [benzingaIdGte] Filter greater than or equal to the value. * @param {string} [benzingaIdLt] Filter less than the value. * @param {string} [benzingaIdLte] Filter less than or equal to the value. * @param {string} [benzingaAnalystId] The identifer used by Benzinga for this analyst. * @param {string} [benzingaAnalystIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaAnalystIdGt] Filter greater than the value. * @param {string} [benzingaAnalystIdGte] Filter greater than or equal to the value. * @param {string} [benzingaAnalystIdLt] Filter less than the value. * @param {string} [benzingaAnalystIdLte] Filter less than or equal to the value. * @param {string} [benzingaFirmId] The identifer used by Benzinga for this firm. * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [benzingaFirmIdGt] Filter greater than the value. * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetCryptoAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoAggregates(cryptoTicker: string, multiplier: number, timespan: GetCryptoAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetCryptoAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} cryptoTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoEMA(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoEMATimespanEnum, window?: number, seriesType?: GetCryptoEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} cryptoTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetCryptoMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate MACD data. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoMACD(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoMACDTimespanEnum, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetCryptoMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close prices of a cryptocurrency symbol on a certain day. * @summary Daily Open/Close * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoOpenClose(from: string, to: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} cryptoTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoRSI(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoRSITimespanEnum, window?: number, seriesType?: GetCryptoRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} cryptoTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetCryptoSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetCryptoSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetCryptoSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoSMA(cryptoTicker: string, timestamp?: string, timespan?: GetCryptoSMATimespanEnum, window?: number, seriesType?: GetCryptoSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current top 20 gainers or losers of the day in cryptocurrency markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetCryptoSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoSnapshotDirection(direction: GetCryptoSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker Ticker of the snapshot * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoSnapshotTicker(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoSnapshotTickers(tickers?: Array, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a crypto ticker symbol in a given time range. * @summary Trades * @param {string} cryptoTicker The ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetCryptoTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetCryptoTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCryptoTrades(cryptoTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetCryptoTradesOrderEnum, limit?: number, sort?: GetCryptoTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. * @summary Real-time Currency Conversion * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {number} [amount] The amount to convert, with a decimal. * @param {GetCurrencyConversionPrecisionEnum} [precision] The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCurrencyConversion(from: string, to: string, amount?: number, precision?: GetCurrencyConversionPrecisionEnum, options?: RawAxiosRequestConfig): Promise; /** * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. * @summary Ticker Events * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getEvents(id: string, types?: string, options?: RawAxiosRequestConfig): Promise; /** * A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFedV1Inflation(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons. * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFedV1InflationExpectations(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities. * @param {string} [date] Calendar date of the yield observation (YYYY-MM-DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFedV1TreasuryYields(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for a forex pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} forexTicker The ticker symbol of the currency pair. * @param {number} multiplier The size of the timespan multiplier. * @param {GetForexAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexAggregates(forexTicker: string, multiplier: number, timespan: GetForexAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetForexAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} fxTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexEMA(fxTicker: string, timestamp?: string, timespan?: GetForexEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} fxTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetForexMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexMACD(fxTicker: string, timestamp?: string, timespan?: GetForexMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetForexMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get BBO quotes for a ticker symbol in a given time range. * @summary Quotes (BBO) * @param {string} fxTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetForexQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetForexQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexQuotes(fxTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetForexQuotesOrderEnum, limit?: number, sort?: GetForexQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} fxTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetForexRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexRSI(fxTicker: string, timestamp?: string, timespan?: GetForexRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} fxTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetForexSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetForexSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetForexSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexSMA(fxTicker: string, timestamp?: string, timespan?: GetForexSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current top 20 gainers or losers of the day in forex markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetForexSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexSnapshotDirection(direction: GetForexSnapshotDirectionDirectionEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. * @summary Ticker * @param {string} ticker The forex ticker. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexSnapshotTicker(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getForexSnapshotTickers(tickers?: Array, options?: RawAxiosRequestConfig): Promise; /** * Get aggregates for a contract in a given time range. * @summary Aggregates * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [windowStartGte] Range by window_start. * @param {string} [windowStartGt] Range by window_start. * @param {string} [windowStartLte] Range by window_start. * @param {string} [windowStartLt] Range by window_start. * @param {GetFuturesAggregatesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesAggregates(ticker: string, resolution?: string, windowStart?: string, limit?: number, windowStartGte?: string, windowStartGt?: string, windowStartLte?: string, windowStartLt?: string, sort?: GetFuturesAggregatesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Contract Details endpoint returns the details for a single contract at a specific point in time. * @summary Contract Details * @param {string} ticker The ticker symbol of the contract to retrieve. * @param {string} [asOf] The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesContractDetails(ticker: string, asOf?: string, options?: RawAxiosRequestConfig): Promise; /** * The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract\'s ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date. * @summary Contracts * @param {string} [productCode] A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product. * @param {string} [firstTradeDate] The first day that a contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [lastTradeDate] The last day that the contract was tradeable. A date with the format YYYY-MM-DD. * @param {string} [asOf] Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today). * @param {GetFuturesContractsActiveEnum} [active] Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract\'s \'first_trade_date\' and less-than-or-equal-to its \'last_trade_date\', then the contract was active. If the date queried is greater-than-or-equal-to the contract\'s \'last_trade_date\' or less-than-or-equal-to its \'first_trade_date\', then the contract was inactive. * @param {GetFuturesContractsTypeEnum} [type] The type of contract, one of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesContractsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesContracts(productCode?: string, firstTradeDate?: string, lastTradeDate?: string, asOf?: string, active?: GetFuturesContractsActiveEnum, type?: GetFuturesContractsTypeEnum, limit?: number, sort?: GetFuturesContractsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps. * @summary Daily Schedules * @param {string} [sessionEndDate] The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to \'today\' in Central Time. e.g. If a request is made from Pacific Time on \'2025-01-01\' at 11:00 pm with no \'session_end_date\' a default value of `2025-01-02` will be used. * @param {string} [tradingVenue] The trading venue (MIC) of the exchange for the schedules. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesDailySchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesDailySchedules(sessionEndDate?: string, tradingVenue?: string, limit?: number, sort?: GetFuturesDailySchedulesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The market status endpoint returns the current status of the futures market for the given product code(s). * @summary Market Status * @param {string} [productCodeAnyOf] The product code(s) to return market statuses for. Multiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes. * @param {string} [productCode] The product code to return market statuses for. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {GetFuturesMarketStatusesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesMarketStatuses(productCodeAnyOf?: string, productCode?: string, limit?: number, sort?: GetFuturesMarketStatusesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Product Details endpoint returns the details for a single product as of a specific day. * @summary Product Details * @param {string} productCode The unique identifier for a product. * @param {GetFuturesProductDetailsTypeEnum} [type] The type of product to return. One of \"single\" or \"combo\" (default=single). * @param {string} [asOf] A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product\'s data at that point-in-time. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesProductDetails(productCode: string, type?: GetFuturesProductDetailsTypeEnum, asOf?: string, options?: RawAxiosRequestConfig): Promise; /** * The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps. * @summary Product Schedules * @param {string} productCode The product code for the futures product. * @param {string} [sessionEndDate] The date on which the schedule\'s trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time. * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesProductSchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesProductSchedules(productCode: string, sessionEndDate?: string, limit?: number, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesProductSchedulesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product\'s name, exchange, sector, sub-sector, asset class, asset sub-class, and type. * @summary Products * @param {string} [name] Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive. * @param {string} [asOf] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). * @param {string} [tradingVenue] The trading venue (MIC) for the exchange on which the products trades. * @param {GetFuturesProductsSectorEnum} [sector] The sector to which the products belong. * @param {GetFuturesProductsSubSectorEnum} [subSector] The sub-sector to which the products belong. * @param {GetFuturesProductsAssetClassEnum} [assetClass] The asset class to which the products belong. * @param {GetFuturesProductsAssetSubClassEnum} [assetSubClass] The asset sub-class to which the products belong. * @param {GetFuturesProductsTypeEnum} [type] The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all). * @param {number} [limit] The number of results to return per page (default=100, maximum=1000, minimum=1). * @param {string} [nameSearch] Search by name. * @param {GetFuturesProductsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesProducts(name?: string, asOf?: string, tradingVenue?: string, sector?: GetFuturesProductsSectorEnum, subSector?: GetFuturesProductsSubSectorEnum, assetClass?: GetFuturesProductsAssetClassEnum, assetSubClass?: GetFuturesProductsAssetSubClassEnum, type?: GetFuturesProductsTypeEnum, limit?: number, nameSearch?: string, sort?: GetFuturesProductsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get quotes for a contract in a given time range. * @summary Quotes * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesQuotesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesQuotes(ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a contract in a given time range. * @summary Trades * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {string} [sessionEndDateGte] Range by session_end_date. * @param {string} [sessionEndDateGt] Range by session_end_date. * @param {string} [sessionEndDateLte] Range by session_end_date. * @param {string} [sessionEndDateLt] Range by session_end_date. * @param {GetFuturesTradesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getFuturesTrades(ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getGroupedCryptoAggregates(date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire forex markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getGroupedForexAggregates(date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets. * @summary Grouped Daily (Bars) * @param {string} date The beginning date for the aggregate window. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getGroupedStocksAggregates(date: string, adjusted?: boolean, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for an index over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} indicesTicker The ticker symbol of Index. * @param {number} multiplier The size of the timespan multiplier. * @param {GetIndicesAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getIndicesAggregates(indicesTicker: string, multiplier: number, timespan: GetIndicesAggregatesTimespanEnum, from: string, to: string, sort?: GetIndicesAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} indicesTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesEMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close values to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getIndicesEMA(indicesTicker: string, timestamp?: string, timespan?: GetIndicesEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} indicesTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetIndicesMACDSeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close values to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getIndicesMACD(indicesTicker: string, timestamp?: string, timespan?: GetIndicesMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetIndicesMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close and afterhours values of a index symbol on a certain date. * @summary Daily Open/Close * @param {string} indicesTicker The ticker symbol of Index. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getIndicesOpenClose(indicesTicker: string, date: string, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} indicesTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetIndicesRSISeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close values to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getIndicesRSI(indicesTicker: string, timestamp?: string, timespan?: GetIndicesRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} indicesTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetIndicesSMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close values to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetIndicesSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getIndicesSMA(indicesTicker: string, timestamp?: string, timespan?: GetIndicesSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get a Snapshot of indices data for said tickers * @summary Indices Snapshot * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {string} [ticker] Search a range of tickers lexicographically. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {GetIndicesSnapshotOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetIndicesSnapshotSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getIndicesSnapshot(tickerAnyOf?: string, ticker?: string, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: GetIndicesSnapshotOrderEnum, limit?: number, sort?: GetIndicesSnapshotSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the last trade tick for a cryptocurrency pair. * @summary Last Trade for a Crypto Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLastCryptoTrade(from: string, to: string, options?: RawAxiosRequestConfig): Promise; /** * Get the last quote tick for a forex currency pair. * @summary Last Quote for a Currency Pair * @param {string} from The \"from\" symbol of the pair. * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLastCurrencyQuote(from: string, to: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent trade for a given options contract. * @summary Last Trade * @param {string} optionsTicker The ticker symbol of the options contract. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLastOptionsTrade(optionsTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent NBBO (Quote) tick for a given stock. * @summary Last Quote * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLastStocksQuote(stocksTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent trade for a given stock. * @summary Last Trade * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLastStocksTrade(stocksTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get upcoming market holidays and their open/close times. * @summary Market Holidays * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getMarketHolidays(options?: RawAxiosRequestConfig): Promise; /** * Get the current trading status of the exchanges and overall financial markets. * @summary Market Status * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getMarketStatus(options?: RawAxiosRequestConfig): Promise; /** * Get the snapshot of an option contract for a stock equity. * @summary Option Contract * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {string} optionContract The option contract identifier. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionContract(underlyingAsset: string, optionContract: string, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for an option contract over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} optionsTicker The ticker symbol of the options contract. * @param {number} multiplier The size of the timespan multiplier. * @param {GetOptionsAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsAggregates(optionsTicker: string, multiplier: number, timespan: GetOptionsAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetOptionsAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the snapshot of all options contracts for an underlying ticker. * @summary Options Chain * @param {string} underlyingAsset The underlying ticker symbol of the option contract. * @param {number} [strikePrice] Query by strike price of a contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {GetOptionsChainContractTypeEnum} [contractType] Query by the type of contract. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {GetOptionsChainOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetOptionsChainSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsChain(underlyingAsset: string, strikePrice?: number, expirationDate?: string, contractType?: GetOptionsChainContractTypeEnum, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, order?: GetOptionsChainOrderEnum, limit?: number, sort?: GetOptionsChainSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get an options contract * @summary Options Contract * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsContract(optionsTicker: string, asOf?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} optionsTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsEMA(optionsTicker: string, timestamp?: string, timespan?: GetOptionsEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} optionsTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetOptionsMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsMACD(optionsTicker: string, timestamp?: string, timespan?: GetOptionsMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetOptionsMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close and afterhours prices of an options contract on a certain date. * @summary Daily Open/Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsOpenClose(optionsTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get quotes for an options ticker symbol in a given time range. * @summary Quotes * @param {string} optionsTicker The ticker symbol to get quotes for. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsQuotes(optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsQuotesOrderEnum, limit?: number, sort?: GetOptionsQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} optionsTicker The ticker symbol for which to get relative strength index (RSI) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetOptionsRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsRSI(optionsTicker: string, timestamp?: string, timespan?: GetOptionsRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} optionsTicker The ticker symbol for which to get simple moving average (SMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetOptionsSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetOptionsSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetOptionsSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsSMA(optionsTicker: string, timestamp?: string, timespan?: GetOptionsSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get trades for an options ticker symbol in a given time range. * @summary Trades * @param {string} optionsTicker The options ticker symbol to get trades for. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetOptionsTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetOptionsTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getOptionsTrades(optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsTradesOrderEnum, limit?: number, sort?: GetOptionsTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. * @summary Previous Close * @param {string} cryptoTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getPreviousCryptoAggregates(cryptoTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified forex pair. * @summary Previous Close * @param {string} forexTicker The ticker symbol of the currency pair. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getPreviousForexAggregates(forexTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified index. * @summary Previous Close * @param {string} indicesTicker The ticker symbol of Index. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getPreviousIndicesAggregates(indicesTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified option contract. * @summary Previous Close * @param {string} optionsTicker The ticker symbol of the options contract. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getPreviousOptionsAggregates(optionsTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified stock ticker. * @summary Previous Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getPreviousStocksAggregates(stocksTicker: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get a list of tickers related to the queried ticker based on News and Returns data. * @summary Related Companies * @param {string} ticker The ticker symbol to search. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getRelatedCompanies(ticker: string, options?: RawAxiosRequestConfig): Promise; /** * Get everything needed to visualize the tick-by-tick movement of a list of tickers. * @summary Summaries * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getSnapshotSummary(tickerAnyOf?: string, options?: RawAxiosRequestConfig): Promise; /** * Get snapshots for assets of all types * @summary Universal Snapshot * @param {string} [ticker] Search a range of tickers lexicographically. * @param {GetSnapshotsTypeEnum} [type] Query by the type of asset. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {GetSnapshotsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. * @param {GetSnapshotsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getSnapshots(ticker?: string, type?: GetSnapshotsTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, tickerAnyOf?: string, order?: GetSnapshotsOrderEnum, limit?: number, sort?: GetSnapshotsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get aggregate bars for a stock over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. * @summary Aggregates (Bars) * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {number} multiplier The size of the timespan multiplier. * @param {GetStocksAggregatesTimespanEnum} timespan The size of the time window. * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksAggregates(stocksTicker: string, multiplier: number, timespan: GetStocksAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetStocksAggregatesSortEnum, limit?: number, options?: RawAxiosRequestConfig): Promise; /** * Get the exponential moving average (EMA) for a ticker symbol over a given time range. * @summary Exponential Moving Average (EMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksEMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksEMA(stockTicker: string, timestamp?: string, timespan?: GetStocksEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get moving average convergence/divergence (MACD) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksMACDTimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [shortWindow] The short window size used to calculate MACD data. * @param {number} [longWindow] The long window size used to calculate MACD data. * @param {number} [signalWindow] The window size used to calculate the MACD signal line. * @param {GetStocksMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksMACD(stockTicker: string, timestamp?: string, timespan?: GetStocksMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetStocksMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the open, close and afterhours prices of a stock symbol on a certain date. * @summary Daily Open/Close * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksOpenClose(stocksTicker: string, date: string, adjusted?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get NBBO quotes for a ticker symbol in a given time range. * @summary Quotes (NBBO) * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksQuotesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksQuotesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksQuotes(stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksQuotesOrderEnum, limit?: number, sort?: GetStocksQuotesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the relative strength index (RSI) for a ticker symbol over a given time range. * @summary Relative Strength Index (RSI) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get relative strength index (RSI) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksRSITimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the relative strength index (RSI). * @param {GetStocksRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksRSI(stockTicker: string, timestamp?: string, timespan?: GetStocksRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the simple moving average (SMA) for a ticker symbol over a given time range. * @summary Simple Moving Average (SMA) * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get simple moving average (SMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetStocksSMATimespanEnum} [timespan] The size of the aggregate time window. * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. * @param {GetStocksSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. * @param {GetStocksSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksSMA(stockTicker: string, timestamp?: string, timespan?: GetStocksSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close. This output will only include tickers with a trading volume of 10,000 or more.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. * @summary Gainers/Losers * @param {GetStocksSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksSnapshotDirection(direction: GetStocksSnapshotDirectionDirectionEnum, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get the most up-to-date market data for a single traded stock ticker.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary Ticker * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksSnapshotTicker(stocksTicker: string, options?: RawAxiosRequestConfig): Promise; /** * Get the most up-to-date market data for all traded stock symbols.

Note: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. * @summary All Tickers * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers. * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksSnapshotTickers(tickers?: Array, includeOtc?: boolean, options?: RawAxiosRequestConfig): Promise; /** * Get trades for a ticker symbol in a given time range. * @summary Trades * @param {string} stockTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. * @param {string} [timestampLte] Range by timestamp. * @param {string} [timestampLt] Range by timestamp. * @param {GetStocksTradesOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. * @param {GetStocksTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksTrades(stockTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetStocksTradesOrderEnum, limit?: number, sort?: GetStocksTradesSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [daysToCover] Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. Value must be a floating point number. * @param {string} [daysToCoverAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [daysToCoverGt] Filter greater than the value. Value must be a floating point number. * @param {number} [daysToCoverGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [daysToCoverLt] Filter less than the value. Value must be a floating point number. * @param {number} [daysToCoverLte] Filter less than or equal to the value. Value must be a floating point number. * @param {string} [settlementDate] The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. * @param {string} [settlementDateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [settlementDateGt] Filter greater than the value. * @param {string} [settlementDateGte] Filter greater than or equal to the value. * @param {string} [settlementDateLt] Filter less than the value. * @param {string} [settlementDateLte] Filter less than or equal to the value. * @param {number} [avgDailyVolume] The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer. * @param {string} [avgDailyVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [avgDailyVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [avgDailyVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [avgDailyVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [avgDailyVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksV1ShortInterest(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, daysToCover?: number, daysToCoverAnyOf?: string, daysToCoverGt?: number, daysToCoverGte?: number, daysToCoverLt?: number, daysToCoverLte?: number, settlementDate?: string, settlementDateAnyOf?: string, settlementDateGt?: string, settlementDateGte?: string, settlementDateLt?: string, settlementDateLte?: string, avgDailyVolume?: number, avgDailyVolumeAnyOf?: string, avgDailyVolumeGt?: number, avgDailyVolumeGte?: number, avgDailyVolumeLt?: number, avgDailyVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [date] The date of trade activity reported in the format YYYY-MM-DD * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {number} [shortVolumeRatio] The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number. * @param {string} [shortVolumeRatioAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. * @param {number} [shortVolumeRatioGt] Filter greater than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioGte] Filter greater than or equal to the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLt] Filter less than the value. Value must be a floating point number. * @param {number} [shortVolumeRatioLte] Filter less than or equal to the value. Value must be a floating point number. * @param {number} [totalVolume] Total reported volume across all venues for the ticker on the given date. Value must be an integer. * @param {string} [totalVolumeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [totalVolumeGt] Filter greater than the value. Value must be an integer. * @param {number} [totalVolumeGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [totalVolumeLt] Filter less than the value. Value must be an integer. * @param {number} [totalVolumeLte] Filter less than or equal to the value. Value must be an integer. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'10\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStocksV1ShortVolume(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, shortVolumeRatio?: number, shortVolumeRatioAnyOf?: string, shortVolumeRatioGt?: number, shortVolumeRatioGte?: number, shortVolumeRatioLt?: number, shortVolumeRatioLte?: number, totalVolume?: number, totalVolumeAnyOf?: string, totalVolumeGt?: number, totalVolumeGte?: number, totalVolumeLt?: number, totalVolumeLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getTicker(ticker: string, date?: string, options?: RawAxiosRequestConfig): Promise; /** * * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. * @param {string} [type] The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop. * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [typeGt] Filter greater than the value. * @param {string} [typeGte] Filter greater than or equal to the value. * @param {string} [typeLt] Filter less than the value. * @param {string} [typeLte] Filter less than or equal to the value. * @param {string} [status] The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed. * @param {string} [statusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [statusGt] Filter greater than the value. * @param {string} [statusGte] Filter greater than or equal to the value. * @param {string} [statusLt] Filter less than the value. * @param {string} [statusLte] Filter less than or equal to the value. * @param {string} [ticker] The company\'s stock symbol. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. * @param {string} [tickerGte] Filter greater than or equal to the value. * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {string} [isin] Standard international identifier for the company\'s common stock. * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [isinGt] Filter greater than the value. * @param {string} [isinGte] Filter greater than or equal to the value. * @param {string} [isinLt] Filter less than the value. * @param {string} [isinLte] Filter less than or equal to the value. * @param {string} [tradingVenue] MIC (Market Identifier Code) of the exchange where the company\'s stock is listed. * @param {string} [tradingVenueAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tradingVenueGt] Filter greater than the value. * @param {string} [tradingVenueGte] Filter greater than or equal to the value. * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. * @param {number} [tmxCompanyIdLte] Filter less than or equal to the value. Value must be an integer. * @param {string} [tmxRecordId] The unique alphanumeric identifier for the event record used by TMX. * @param {string} [tmxRecordIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tmxRecordIdGt] Filter greater than the value. * @param {string} [tmxRecordIdGte] Filter greater than or equal to the value. * @param {string} [tmxRecordIdLt] Filter less than the value. * @param {string} [tmxRecordIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise; /** * List all conditions that Polygon.io uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. * @param {number} [id] Filter for conditions with a given ID. * @param {ListConditionsSipEnum} [sip] Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned. * @param {ListConditionsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListConditionsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listConditions(assetClass?: ListConditionsAssetClassEnum, dataType?: ListConditionsDataTypeEnum, id?: number, sip?: ListConditionsSipEnum, order?: ListConditionsOrderEnum, limit?: number, sort?: ListConditionsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get a list of historical cash dividends, including the ticker symbol, declaration date, ex-dividend date, record date, pay date, frequency, and amount. * @summary Dividends v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [exDividendDate] Query by ex-dividend date with the format YYYY-MM-DD. * @param {string} [recordDate] Query by record date with the format YYYY-MM-DD. * @param {string} [declarationDate] Query by declaration date with the format YYYY-MM-DD. * @param {string} [payDate] Query by pay date with the format YYYY-MM-DD. * @param {ListDividendsFrequencyEnum} [frequency] Query by the number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly). * @param {number} [cashAmount] Query by the cash amount of the dividend. * @param {ListDividendsDividendTypeEnum} [dividendType] Query by the type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [exDividendDateGte] Range by ex_dividend_date. * @param {string} [exDividendDateGt] Range by ex_dividend_date. * @param {string} [exDividendDateLte] Range by ex_dividend_date. * @param {string} [exDividendDateLt] Range by ex_dividend_date. * @param {string} [recordDateGte] Range by record_date. * @param {string} [recordDateGt] Range by record_date. * @param {string} [recordDateLte] Range by record_date. * @param {string} [recordDateLt] Range by record_date. * @param {string} [declarationDateGte] Range by declaration_date. * @param {string} [declarationDateGt] Range by declaration_date. * @param {string} [declarationDateLte] Range by declaration_date. * @param {string} [declarationDateLt] Range by declaration_date. * @param {string} [payDateGte] Range by pay_date. * @param {string} [payDateGt] Range by pay_date. * @param {string} [payDateLte] Range by pay_date. * @param {string} [payDateLt] Range by pay_date. * @param {number} [cashAmountGte] Range by cash_amount. * @param {number} [cashAmountGt] Range by cash_amount. * @param {number} [cashAmountLte] Range by cash_amount. * @param {number} [cashAmountLt] Range by cash_amount. * @param {ListDividendsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListDividendsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listDividends(ticker?: string, exDividendDate?: string, recordDate?: string, declarationDate?: string, payDate?: string, frequency?: ListDividendsFrequencyEnum, cashAmount?: number, dividendType?: ListDividendsDividendTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, exDividendDateGte?: string, exDividendDateGt?: string, exDividendDateLte?: string, exDividendDateLt?: string, recordDateGte?: string, recordDateGt?: string, recordDateLte?: string, recordDateLt?: string, declarationDateGte?: string, declarationDateGt?: string, declarationDateLte?: string, declarationDateLt?: string, payDateGte?: string, payDateGt?: string, payDateLte?: string, payDateLt?: string, cashAmountGte?: number, cashAmountGt?: number, cashAmountLte?: number, cashAmountLt?: number, order?: ListDividendsOrderEnum, limit?: number, sort?: ListDividendsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * List all exchanges that Polygon.io knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listExchanges(assetClass?: ListExchangesAssetClassEnum, locale?: ListExchangesLocaleEnum, options?: RawAxiosRequestConfig): Promise; /** * Get historical financial data for a stock ticker. The financials data is extracted from XBRL from company SEC filings using the methodology outlined here. * @summary Stock Financials vX * @param {string} [ticker] Query by company ticker. * @param {string} [cik] Query by central index key (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/edgar/searchedgar/cik.htm\">CIK</a>) Number * @param {string} [companyName] Query by company name. * @param {string} [sic] Query by standard industrial classification (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list\">SIC</a>) * @param {string} [filingDate] Query by the date when the filing with financials data was filed in YYYY-MM-DD format. Best used when querying over date ranges to find financials based on filings that happen in a time period. Examples: To get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01 To get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01 * @param {string} [periodOfReportDate] The period of report for the filing with financials data in YYYY-MM-DD format. * @param {ListFinancialsTimeframeEnum} [timeframe] Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4 * @param {boolean} [includeSources] Whether or not to include the `xpath` and `formula` attributes for each financial data point. See the `xpath` and `formula` response attributes for more info. False by default. * @param {string} [companyNameSearch] Search by company_name. * @param {string} [filingDateGte] Search by filing_date. * @param {string} [filingDateGt] Search by filing_date. * @param {string} [filingDateLte] Search by filing_date. * @param {string} [filingDateLt] Search by filing_date. * @param {string} [periodOfReportDateGte] Search by period_of_report_date. * @param {string} [periodOfReportDateGt] Search by period_of_report_date. * @param {string} [periodOfReportDateLte] Search by period_of_report_date. * @param {string} [periodOfReportDateLt] Search by period_of_report_date. * @param {ListFinancialsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 100. * @param {ListFinancialsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listFinancials(ticker?: string, cik?: string, companyName?: string, sic?: string, filingDate?: string, periodOfReportDate?: string, timeframe?: ListFinancialsTimeframeEnum, includeSources?: boolean, companyNameSearch?: string, filingDateGte?: string, filingDateGt?: string, filingDateLte?: string, filingDateLt?: string, periodOfReportDateGte?: string, periodOfReportDateGt?: string, periodOfReportDateLte?: string, periodOfReportDateLt?: string, order?: ListFinancialsOrderEnum, limit?: number, sort?: ListFinancialsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * The IPOs API provides access to detailed information about Initial Public Offerings (IPOs), including both upcoming and historical events. With this API, you can query for a comprehensive list of IPOs, along with key details such as the issuer name, ticker symbol, ISIN, IPO date, number of shares offered, expected price range, and final offering price. You can filter the results by status to focus on new, rumors, pending, historical, and more. * @summary IPOs * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, TSLA represents Tesla Inc. * @param {string} [usCode] Specify a us_code. This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. * @param {string} [isin] Specify an International Securities Identification Number (ISIN). This is a unique twelve-digit code that is assigned to every security issuance in the world. * @param {string} [listingDate] Specify a listing date. This is the first trading date for the newly listed entity. * @param {ListIPOsIpoStatusEnum} [ipoStatus] Specify an IPO status. * @param {string} [listingDateGte] Range by listing_date. * @param {string} [listingDateGt] Range by listing_date. * @param {string} [listingDateLte] Range by listing_date. * @param {string} [listingDateLt] Range by listing_date. * @param {ListIPOsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListIPOsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listIPOs(ticker?: string, usCode?: string, isin?: string, listingDate?: string, ipoStatus?: ListIPOsIpoStatusEnum, listingDateGte?: string, listingDateGt?: string, listingDateLte?: string, listingDateLt?: string, order?: ListIPOsOrderEnum, limit?: number, sort?: ListIPOsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source. * @summary Ticker News * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {ListNewsPublishedUtcParameter} [publishedUtc] Return results published on, before, or after this date. * @param {string} [tickerGte] Search by ticker. * @param {string} [tickerGt] Search by ticker. * @param {string} [tickerLte] Search by ticker. * @param {string} [tickerLt] Search by ticker. * @param {ListNewsPublishedUtcParameter} [publishedUtcGte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcGt] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLte] Search by published_utc. * @param {ListNewsPublishedUtcParameter} [publishedUtcLt] Search by published_utc. * @param {ListNewsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListNewsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listNews(ticker?: string, publishedUtc?: ListNewsPublishedUtcParameter, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, publishedUtcGte?: ListNewsPublishedUtcParameter, publishedUtcGt?: ListNewsPublishedUtcParameter, publishedUtcLte?: ListNewsPublishedUtcParameter, publishedUtcLt?: ListNewsPublishedUtcParameter, order?: ListNewsOrderEnum, limit?: number, sort?: ListNewsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {number} [strikePrice] Query by strike price of a contract. * @param {boolean} [expired] Query for expired contracts. Default is false. * @param {string} [underlyingTickerGte] Range by underlying_ticker. * @param {string} [underlyingTickerGt] Range by underlying_ticker. * @param {string} [underlyingTickerLte] Range by underlying_ticker. * @param {string} [underlyingTickerLt] Range by underlying_ticker. * @param {string} [expirationDateGte] Range by expiration_date. * @param {string} [expirationDateGt] Range by expiration_date. * @param {string} [expirationDateLte] Range by expiration_date. * @param {string} [expirationDateLt] Range by expiration_date. * @param {number} [strikePriceGte] Range by strike_price. * @param {number} [strikePriceGt] Range by strike_price. * @param {number} [strikePriceLte] Range by strike_price. * @param {number} [strikePriceLt] Range by strike_price. * @param {ListOptionsContractsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListOptionsContractsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listOptionsContracts(underlyingTicker?: string, ticker?: string, contractType?: ListOptionsContractsContractTypeEnum, expirationDate?: string, asOf?: string, strikePrice?: number, expired?: boolean, underlyingTickerGte?: string, underlyingTickerGt?: string, underlyingTickerLte?: string, underlyingTickerLt?: string, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, order?: ListOptionsContractsOrderEnum, limit?: number, sort?: ListOptionsContractsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * Get a list of historical stock splits, including the ticker symbol, the execution date, and the factors of the split ratio. * @summary Stock Splits v3 * @param {string} [ticker] Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [executionDate] Query by execution date with the format YYYY-MM-DD. * @param {boolean | null} [reverseSplit] Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split. By default this filter is not used. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {string} [executionDateGte] Range by execution_date. * @param {string} [executionDateGt] Range by execution_date. * @param {string} [executionDateLte] Range by execution_date. * @param {string} [executionDateLt] Range by execution_date. * @param {ListStockSplitsOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 1000. * @param {ListStockSplitsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listStockSplits(ticker?: string, executionDate?: string, reverseSplit?: boolean | null, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, executionDateGte?: string, executionDateGt?: string, executionDateLte?: string, executionDateLt?: string, order?: ListStockSplitsOrderEnum, limit?: number, sort?: ListStockSplitsSortEnum, options?: RawAxiosRequestConfig): Promise; /** * List all ticker types that Polygon.io has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listTickerTypes(assetClass?: ListTickerTypesAssetClassEnum, locale?: ListTickerTypesLocaleEnum, options?: RawAxiosRequestConfig): Promise; /** * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. * @param {string} [cik] Specify the CIK of the asset you want to search for. Find more information about CIK codes [at their website](https://www.sec.gov/edgar/searchedgar/cik.htm). Defaults to empty string which queries all CIKs. * @param {string} [date] Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date. * @param {string} [search] Search for terms within the ticker and/or company name. * @param {boolean} [active] Specify if the tickers returned should be actively traded on the queried date. Default is true. * @param {string} [tickerGte] Range by ticker. * @param {string} [tickerGt] Range by ticker. * @param {string} [tickerLte] Range by ticker. * @param {string} [tickerLt] Range by ticker. * @param {ListTickersOrderEnum} [order] Order results based on the `sort` field. * @param {number} [limit] Limit the number of results returned, default is 100 and max is 1000. * @param {ListTickersSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listTickers(ticker?: string, type?: ListTickersTypeEnum, market?: ListTickersMarketEnum, exchange?: string, cusip?: string, cik?: string, date?: string, search?: string, active?: boolean, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: ListTickersOrderEnum, limit?: number, sort?: ListTickersSortEnum, options?: RawAxiosRequestConfig): Promise; } /** * @export * @enum {string} */ declare enum GetCryptoAggregatesTimespanEnum { Second = "second", Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetCryptoAggregatesSortEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetCryptoEMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetCryptoEMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetCryptoEMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetCryptoMACDTimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetCryptoMACDSeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetCryptoMACDOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetCryptoRSITimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetCryptoRSISeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetCryptoRSIOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetCryptoSMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetCryptoSMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetCryptoSMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetCryptoSnapshotDirectionDirectionEnum { Gainers = "gainers", Losers = "losers" } /** * @export * @enum {string} */ declare enum GetCryptoTradesOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetCryptoTradesSortEnum { Timestamp = "timestamp" } /** * @export * @enum {string} */ declare enum GetCurrencyConversionPrecisionEnum { NUMBER_0 = 0, NUMBER_1 = 1, NUMBER_2 = 2, NUMBER_3 = 3, NUMBER_4 = 4 } /** * @export * @enum {string} */ declare enum GetForexAggregatesTimespanEnum { Second = "second", Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetForexAggregatesSortEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetForexEMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetForexEMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetForexEMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetForexMACDTimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetForexMACDSeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetForexMACDOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetForexQuotesOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetForexQuotesSortEnum { Timestamp = "timestamp" } /** * @export * @enum {string} */ declare enum GetForexRSITimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetForexRSISeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetForexRSIOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetForexSMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetForexSMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetForexSMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetForexSnapshotDirectionDirectionEnum { Gainers = "gainers", Losers = "losers" } /** * @export * @enum {string} */ declare enum GetFuturesAggregatesSortEnum { WindowStartAsc = "window_start.asc", WindowStartDesc = "window_start.desc" } /** * @export * @enum {string} */ declare enum GetFuturesContractsActiveEnum { All = "all", True = "true", False = "false" } /** * @export * @enum {string} */ declare enum GetFuturesContractsTypeEnum { All = "all", Single = "single", Combo = "combo" } /** * @export * @enum {string} */ declare enum GetFuturesContractsSortEnum { ProductCodeAsc = "product_code.asc", ProductCodeDesc = "product_code.desc", FirstTradeDateAsc = "first_trade_date.asc", FirstTradeDateDesc = "first_trade_date.desc", LastTradeDateAsc = "last_trade_date.asc", LastTradeDateDesc = "last_trade_date.desc" } /** * @export * @enum {string} */ declare enum GetFuturesDailySchedulesSortEnum { TradingVenueAsc = "trading_venue.asc", TradingVenueDesc = "trading_venue.desc" } /** * @export * @enum {string} */ declare enum GetFuturesMarketStatusesSortEnum { ProductCodeAsc = "product_code.asc", ProductCodeDesc = "product_code.desc" } /** * @export * @enum {string} */ declare enum GetFuturesProductDetailsTypeEnum { Single = "single", Combo = "combo" } /** * @export * @enum {string} */ declare enum GetFuturesProductSchedulesSortEnum { SessionEndDateAsc = "session_end_date.asc", SessionEndDateDesc = "session_end_date.desc" } /** * @export * @enum {string} */ declare enum GetFuturesProductsSectorEnum { Asia = "asia", Base = "base", Biofuels = "biofuels", Coal = "coal", CrossRates = "cross_rates", CrudeOil = "crude_oil", CustomIndex = "custom_index", Dairy = "dairy", DjUbsCi = "dj_ubs_ci", Electricity = "electricity", Emissions = "emissions", Europe = "europe", Fertilizer = "fertilizer", Forestry = "forestry", GrainsAndOilseeds = "grains_and_oilseeds", IntlIndex = "intl_index", LiqNatGasLng = "liq_nat_gas_lng", Livestock = "livestock", LongTermGov = "long_term_gov", LongTermNonGov = "long_term_non_gov", Majors = "majors", Minors = "minors", NatGas = "nat_gas", NatGasLiqPetro = "nat_gas_liq_petro", Precious = "precious", RefinedProducts = "refined_products", SAndPGsci = "s_and_p_gsci", SelSectorIndex = "sel_sector_index", ShortTermGov = "short_term_gov", ShortTermNonGov = "short_term_non_gov", Softs = "softs", Us = "us", UsIndex = "us_index", WetBulk = "wet_bulk" } /** * @export * @enum {string} */ declare enum GetFuturesProductsSubSectorEnum { Asian = "asian", Canadian = "canadian", Cat = "cat", CoolingDegreeDays = "cooling_degree_days", Ercot = "ercot", European = "european", Gulf = "gulf", HeatingDegreeDays = "heating_degree_days", IsoNe = "iso_ne", LargeCapIndex = "large_cap_index", MidCapIndex = "mid_cap_index", Miso = "miso", NorthAmerican = "north_american", Nyiso = "nyiso", Pjm = "pjm", SmallCapIndex = "small_cap_index", West = "west", WesternPower = "western_power" } /** * @export * @enum {string} */ declare enum GetFuturesProductsAssetClassEnum { AltInvestment = "alt_investment", Commodity = "commodity", Financials = "financials" } /** * @export * @enum {string} */ declare enum GetFuturesProductsAssetSubClassEnum { Agricultural = "agricultural", CommodityIndex = "commodity_index", Energy = "energy", Equity = "equity", ForeignExchange = "foreign_exchange", Freight = "freight", Housing = "housing", InterestRate = "interest_rate", Metals = "metals", Weather = "weather" } /** * @export * @enum {string} */ declare enum GetFuturesProductsTypeEnum { All = "all", Single = "single", Combo = "combo" } /** * @export * @enum {string} */ declare enum GetFuturesProductsSortEnum { NameAsc = "name.asc", NameDesc = "name.desc", TradingVenueAsc = "trading_venue.asc", TradingVenueDesc = "trading_venue.desc", SectorAsc = "sector.asc", SectorDesc = "sector.desc", SubSectorAsc = "sub_sector.asc", SubSectorDesc = "sub_sector.desc", AssetClassAsc = "asset_class.asc", AssetClassDesc = "asset_class.desc", AssetSubClassAsc = "asset_sub_class.asc", AssetSubClassDesc = "asset_sub_class.desc", TypeAsc = "type.asc", TypeDesc = "type.desc" } /** * @export * @enum {string} */ declare enum GetFuturesQuotesSortEnum { TimestampAsc = "timestamp.asc", TimestampDesc = "timestamp.desc" } /** * @export * @enum {string} */ declare enum GetFuturesTradesSortEnum { TimestampAsc = "timestamp.asc", TimestampDesc = "timestamp.desc" } /** * @export * @enum {string} */ declare enum GetIndicesAggregatesTimespanEnum { Second = "second", Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetIndicesAggregatesSortEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetIndicesEMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetIndicesEMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetIndicesEMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetIndicesMACDTimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetIndicesMACDSeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetIndicesMACDOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetIndicesRSITimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetIndicesRSISeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetIndicesRSIOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetIndicesSMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetIndicesSMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetIndicesSMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetIndicesSnapshotOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetIndicesSnapshotSortEnum { Ticker = "ticker" } /** * @export * @enum {string} */ declare enum GetOptionsAggregatesTimespanEnum { Second = "second", Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetOptionsAggregatesSortEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsChainContractTypeEnum { Call = "call", Put = "put" } /** * @export * @enum {string} */ declare enum GetOptionsChainOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsChainSortEnum { Ticker = "ticker", ExpirationDate = "expiration_date", StrikePrice = "strike_price" } /** * @export * @enum {string} */ declare enum GetOptionsEMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetOptionsEMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetOptionsEMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsMACDTimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetOptionsMACDSeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetOptionsMACDOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsQuotesOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsQuotesSortEnum { Timestamp = "timestamp" } /** * @export * @enum {string} */ declare enum GetOptionsRSITimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetOptionsRSISeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetOptionsRSIOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsSMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetOptionsSMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetOptionsSMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsTradesOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetOptionsTradesSortEnum { Timestamp = "timestamp" } /** * @export * @enum {string} */ declare enum GetSnapshotsTypeEnum { Stocks = "stocks", Options = "options", Crypto = "crypto", Fx = "fx", Indices = "indices" } /** * @export * @enum {string} */ declare enum GetSnapshotsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetSnapshotsSortEnum { Ticker = "ticker" } /** * @export * @enum {string} */ declare enum GetStocksAggregatesTimespanEnum { Second = "second", Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetStocksAggregatesSortEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetStocksEMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetStocksEMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetStocksEMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetStocksMACDTimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetStocksMACDSeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetStocksMACDOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetStocksQuotesOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetStocksQuotesSortEnum { Timestamp = "timestamp" } /** * @export * @enum {string} */ declare enum GetStocksRSITimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetStocksRSISeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetStocksRSIOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetStocksSMATimespanEnum { Minute = "minute", Hour = "hour", Day = "day", Week = "week", Month = "month", Quarter = "quarter", Year = "year" } /** * @export * @enum {string} */ declare enum GetStocksSMASeriesTypeEnum { Open = "open", High = "high", Low = "low", Close = "close" } /** * @export * @enum {string} */ declare enum GetStocksSMAOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetStocksSnapshotDirectionDirectionEnum { Gainers = "gainers", Losers = "losers" } /** * @export * @enum {string} */ declare enum GetStocksTradesOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum GetStocksTradesSortEnum { Timestamp = "timestamp" } /** * @export * @enum {string} */ declare enum ListConditionsAssetClassEnum { Stocks = "stocks", Options = "options", Crypto = "crypto", Fx = "fx" } /** * @export * @enum {string} */ declare enum ListConditionsDataTypeEnum { Trade = "trade", Bbo = "bbo", Nbbo = "nbbo" } /** * @export * @enum {string} */ declare enum ListConditionsSipEnum { Cta = "CTA", Utp = "UTP", Opra = "OPRA" } /** * @export * @enum {string} */ declare enum ListConditionsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListConditionsSortEnum { AssetClass = "asset_class", Id = "id", Type = "type", Name = "name", DataTypes = "data_types", Legacy = "legacy" } /** * @export * @enum {string} */ declare enum ListDividendsFrequencyEnum { NUMBER_0 = 0, NUMBER_1 = 1, NUMBER_2 = 2, NUMBER_4 = 4, NUMBER_12 = 12, NUMBER_24 = 24, NUMBER_52 = 52 } /** * @export * @enum {string} */ declare enum ListDividendsDividendTypeEnum { Cd = "CD", Sc = "SC", Lt = "LT", St = "ST" } /** * @export * @enum {string} */ declare enum ListDividendsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListDividendsSortEnum { ExDividendDate = "ex_dividend_date", PayDate = "pay_date", DeclarationDate = "declaration_date", RecordDate = "record_date", CashAmount = "cash_amount", Ticker = "ticker" } /** * @export * @enum {string} */ declare enum ListExchangesAssetClassEnum { Stocks = "stocks", Options = "options", Crypto = "crypto", Fx = "fx", Futures = "futures" } /** * @export * @enum {string} */ declare enum ListExchangesLocaleEnum { Us = "us", Global = "global" } /** * @export * @enum {string} */ declare enum ListFinancialsTimeframeEnum { Annual = "annual", Quarterly = "quarterly", Ttm = "ttm" } /** * @export * @enum {string} */ declare enum ListFinancialsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListFinancialsSortEnum { FilingDate = "filing_date", PeriodOfReportDate = "period_of_report_date" } /** * @export * @enum {string} */ declare enum ListIPOsIpoStatusEnum { DirectListingProcess = "direct_listing_process", History = "history", New = "new", Pending = "pending", Postponed = "postponed", Rumor = "rumor", Withdrawn = "withdrawn" } /** * @export * @enum {string} */ declare enum ListIPOsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListIPOsSortEnum { ListingDate = "listing_date", Ticker = "ticker", LastUpdated = "last_updated", SecurityType = "security_type", IssuerName = "issuer_name", CurrencyCode = "currency_code", Isin = "isin", UsCode = "us_code", FinalIssuePrice = "final_issue_price", MinSharesOffered = "min_shares_offered", MaxSharesOffered = "max_shares_offered", LowestOfferPrice = "lowest_offer_price", HighestOfferPrice = "highest_offer_price", TotalOfferSize = "total_offer_size", SharesOutstanding = "shares_outstanding", PrimaryExchange = "primary_exchange", LotSize = "lot_size", SecurityDescription = "security_description", IpoStatus = "ipo_status", AnnouncedDate = "announced_date" } /** * @export * @enum {string} */ declare enum ListNewsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListNewsSortEnum { PublishedUtc = "published_utc" } /** * @export * @enum {string} */ declare enum ListOptionsContractsContractTypeEnum { Call = "call", Put = "put" } /** * @export * @enum {string} */ declare enum ListOptionsContractsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListOptionsContractsSortEnum { Ticker = "ticker", UnderlyingTicker = "underlying_ticker", ExpirationDate = "expiration_date", StrikePrice = "strike_price" } /** * @export * @enum {string} */ declare enum ListStockSplitsOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListStockSplitsSortEnum { ExecutionDate = "execution_date", Ticker = "ticker" } /** * @export * @enum {string} */ declare enum ListTickerTypesAssetClassEnum { Stocks = "stocks", Options = "options", Crypto = "crypto", Fx = "fx", Indices = "indices" } /** * @export * @enum {string} */ declare enum ListTickerTypesLocaleEnum { Us = "us", Global = "global" } /** * @export * @enum {string} */ declare enum ListTickersTypeEnum { Cs = "CS", Adrc = "ADRC", Adrp = "ADRP", Adrr = "ADRR", Unit = "UNIT", Right = "RIGHT", Pfd = "PFD", Fund = "FUND", Sp = "SP", Warrant = "WARRANT", Index = "INDEX", Etf = "ETF", Etn = "ETN", Os = "OS", Gdr = "GDR", Other = "OTHER", Nyrs = "NYRS", Agen = "AGEN", Eqlk = "EQLK", Bond = "BOND", Adrw = "ADRW", Basket = "BASKET", Lt = "LT" } /** * @export * @enum {string} */ declare enum ListTickersMarketEnum { Stocks = "stocks", Crypto = "crypto", Fx = "fx", Otc = "otc", Indices = "indices" } /** * @export * @enum {string} */ declare enum ListTickersOrderEnum { Asc = "asc", Desc = "desc" } /** * @export * @enum {string} */ declare enum ListTickersSortEnum { Ticker = "ticker", Name = "name", Market = "market", Locale = "locale", PrimaryExchange = "primary_exchange", Type = "type", CurrencySymbol = "currency_symbol", CurrencyName = "currency_name", BaseCurrencySymbol = "base_currency_symbol", BaseCurrencyName = "base_currency_name", Cik = "cik", CompositeFigi = "composite_figi", ShareClassFigi = "share_class_figi", LastUpdatedUtc = "last_updated_utc", DelistedUtc = "delisted_utc" } interface IAggegateForexEvent { ev: string; pair: string; o: number; c: number; h: number; l: number; v: number; s: number; e: number; } interface IQuoteForexEvent { ev: string; p: string; x: string; a: number; b: number; t: number; } interface IFMVForexEvent { ev: string; fmv: string; sym: string; t: number; } declare const getForexWebsocket: (apiKey: string, apiBase?: string) => websocket.w3cwebsocket; interface IAggregateIndexEvent { ev: string; sym: string; o: number; op: number; c: number; h: number; l: number; s: number; e: number; } interface IIndexValueEvent { ev: string; val: string; T: string; t: number; } declare const getIndicesWebsocket: (apiKey: string, apiBase?: string) => websocket.w3cwebsocket; interface IAggregateStockEvent { ev: string; sym: string; v: number; av: number; op: number; vw: number; o: number; c: number; h: number; l: number; a: number; z: number; s: number; e: number; } interface ITradeStockEvent { ev: string; sym: string; x: string; i: number; z: number; p: number; s: number; c: number[]; t: number; } interface IQuoteStockEvent { ev: string; sym: string; bx: string; bp: number; bs: number; ax: string; ap: number; as: number; c: number; t: number; z: number; } interface ILULDStockEvent { ev: string; T: string; h: number; l: number; i: number; z: number; t: number; q: number; } interface IFMVStockEvent { ev: string; fmv: string; sym: string; t: number; } declare const getStocksWebsocket: (apiKey: string, apiBase?: string) => websocket.w3cwebsocket; interface IAggregateCryptoEvent { ev: string; pair: string; o: number; c: number; h: number; l: number; v: number; s: number; e: number; } interface ITradeCryptoEvent { ev: string; pair: string; p: number; t: number; s: number; c: number[]; i: string; x: number; r: number; } interface IQuoteCryptoEvent { ev: string; pair: string; bp: number; bs: number; ap: number; as: number; t: number; x: number; r: number; } interface IFMVCryptoEvent { ev: string; fmv: string; sym: string; t: number; } declare const getCryptoWebsocket: (apiKey: string, apiBase?: string) => websocket.w3cwebsocket; interface IAggregateOptionsEvent { ev: string; sym: string; v: number; av: number; op: number; vw: number; o: number; c: number; h: number; l: number; a: number; z: number; s: number; e: number; } interface ITradeOptionsEvent { ev: string; sym: string; x: string; p: number; s: number; c: number[]; t: number; q: number; } declare type IQuoteOptionsEvent = { ev: string; sym: string; bx: number; ax: number; bp: number; ap: number; bs: number; as: number; t: number; q: number; }; interface IFMVOptionsEvent { ev: string; fmv: string; sym: string; t: number; } declare const getOptionsWebsocket: (apiKey: string, apiBase?: string) => websocket.w3cwebsocket; interface IAggregateFuturesEvent { ev: string; sym: string; v: number; dv: number; o: number; c: number; h: number; l: number; n: number; s: number; e: number; } interface ITradeFuturesEvent { ev: string; sym: string; p: number; s: number; t: number; q: number; } interface IQuoteFuturesEvent { ev: string; sym: string; bp: number; bs: number; bt: number; ap: number; as: number; at: number; t: number; } declare const getFuturesWebsocket: (apiKey: string, apiBase?: string, exchange?: string) => websocket.w3cwebsocket; interface IWebsocketClient { crypto: () => websocket.w3cwebsocket; forex: () => websocket.w3cwebsocket; indices: () => websocket.w3cwebsocket; options: () => websocket.w3cwebsocket; stocks: () => websocket.w3cwebsocket; futures: () => websocket.w3cwebsocket; } declare const websocketClient: (apiKey: string, apiBase?: string, exchange?: string) => IWebsocketClient; interface IPolygonClient { rest: DefaultApi; websockets: IWebsocketClient; } declare const restClient: (apikey: string, restApiBase?: string, globalFetchOptions?: { pagination?: boolean; }) => DefaultApi; declare const polygonClient: (apiKey: string, restApiBase?: string, websocketApiBase?: string, globalFetchOptions?: { pagination: boolean; }) => IPolygonClient; export { type Company, type ConditionTypeMap, Configuration, type ConfigurationParameters, type CryptoExchangeInner, type CryptoGroupedResults, type CryptoHistoricTrades, type CryptoLastTrade, type CryptoLastTradeLast, type CryptoOpenClose, type CryptoSnapshotMinute, type CryptoSnapshotTicker, type CryptoSnapshotTickerFullBook, type CryptoSnapshotTickers, type CryptoTick, DefaultApi, DefaultApiAxiosParamCreator, DefaultApiFactory, DefaultApiFp, type DeprecatedGetCryptoSnapshotTickerBook200Response, type DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfData, type DeprecatedGetCryptoSnapshotTickerBook200ResponseAllOfDataAsksInner, type DeprecatedGetHistoricCryptoTrades200Response, type DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner, type DeprecatedGetHistoricForexQuotes200Response, type DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner, type DeprecatedGetHistoricStocksQuotes200Response, type DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner, type DeprecatedGetHistoricStocksTrades200Response, type DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner, type ExchangeInner, type Financial, type Financials, FinancialsPeriodEnum, type ForexConversion, type ForexConversionLast, type ForexGroupedResults, type ForexHistoricTrades, type ForexPairLastQuote, type ForexPreviousClose, type ForexSnapshotLastQuote, type ForexSnapshotPrevDay, type ForexSnapshotTicker, type ForexSnapshotTickers, type ForexTickerResults, type GetBenzingaV1AnalystInsights200Response, type GetBenzingaV1AnalystInsights200ResponseResultsInner, GetBenzingaV1AnalystInsights200ResponseStatusEnum, type GetBenzingaV1AnalystInsights400Response, GetBenzingaV1AnalystInsights400ResponseStatusEnum, type GetBenzingaV1Analysts200Response, type GetBenzingaV1Analysts200ResponseResultsInner, GetBenzingaV1Analysts200ResponseStatusEnum, type GetBenzingaV1ConsensusRatings200Response, type GetBenzingaV1ConsensusRatings200ResponseResultsInner, GetBenzingaV1ConsensusRatings200ResponseStatusEnum, type GetBenzingaV1Earnings200Response, type GetBenzingaV1Earnings200ResponseResultsInner, GetBenzingaV1Earnings200ResponseStatusEnum, type GetBenzingaV1Firms200Response, type GetBenzingaV1Firms200ResponseResultsInner, GetBenzingaV1Firms200ResponseStatusEnum, type GetBenzingaV1Guidance200Response, type GetBenzingaV1Guidance200ResponseResultsInner, GetBenzingaV1Guidance200ResponseStatusEnum, type GetBenzingaV1News200Response, type GetBenzingaV1News200ResponseResultsInner, GetBenzingaV1News200ResponseStatusEnum, type GetBenzingaV1Ratings200Response, type GetBenzingaV1Ratings200ResponseResultsInner, GetBenzingaV1Ratings200ResponseStatusEnum, type GetCryptoAggregates200Response, type GetCryptoAggregates200ResponseAllOfResultsInner, GetCryptoAggregatesSortEnum, GetCryptoAggregatesTimespanEnum, type GetCryptoEMA200Response, type GetCryptoEMA200ResponseResults, type GetCryptoEMA200ResponseResultsUnderlying, type GetCryptoEMA200ResponseResultsUnderlyingAggregatesInner, type GetCryptoEMA200ResponseResultsValuesInner, GetCryptoEMAOrderEnum, GetCryptoEMASeriesTypeEnum, GetCryptoEMATimespanEnum, type GetCryptoMACD200Response, type GetCryptoMACD200ResponseResults, type GetCryptoMACD200ResponseResultsValuesInner, GetCryptoMACDOrderEnum, GetCryptoMACDSeriesTypeEnum, GetCryptoMACDTimespanEnum, type GetCryptoOpenClose200Response, type GetCryptoRSI200Response, type GetCryptoRSI200ResponseResults, GetCryptoRSIOrderEnum, GetCryptoRSISeriesTypeEnum, GetCryptoRSITimespanEnum, type GetCryptoSMA200Response, type GetCryptoSMA200ResponseResults, GetCryptoSMAOrderEnum, GetCryptoSMASeriesTypeEnum, GetCryptoSMATimespanEnum, type GetCryptoSnapshotDirection200Response, GetCryptoSnapshotDirectionDirectionEnum, type GetCryptoSnapshotTicker200Response, type GetCryptoSnapshotTicker200ResponseAllOfTicker, type GetCryptoSnapshotTickers200Response, type GetCryptoSnapshotTickers200ResponseAllOfTickersInner, type GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay, type GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade, type GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin, type GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay, type GetCryptoTrades200Response, type GetCryptoTrades200ResponseResultsInner, GetCryptoTradesOrderEnum, GetCryptoTradesSortEnum, type GetCurrencyConversion200Response, type GetCurrencyConversion200ResponseLast, GetCurrencyConversionPrecisionEnum, type GetEvents200Response, type GetEvents200ResponseResults, type GetEvents200ResponseResultsEventsInner, type GetEvents200ResponseResultsEventsInnerOneOf, type GetEvents200ResponseResultsEventsInnerOneOfTickerChange, type GetFedV1Inflation200Response, type GetFedV1Inflation200ResponseResultsInner, GetFedV1Inflation200ResponseStatusEnum, type GetFedV1InflationExpectations200Response, type GetFedV1InflationExpectations200ResponseResultsInner, GetFedV1InflationExpectations200ResponseStatusEnum, type GetFedV1TreasuryYields200Response, type GetFedV1TreasuryYields200ResponseResultsInner, GetFedV1TreasuryYields200ResponseStatusEnum, GetForexAggregatesSortEnum, GetForexAggregatesTimespanEnum, GetForexEMAOrderEnum, GetForexEMASeriesTypeEnum, GetForexEMATimespanEnum, GetForexMACDOrderEnum, GetForexMACDSeriesTypeEnum, GetForexMACDTimespanEnum, type GetForexQuotes200Response, type GetForexQuotes200ResponseResultsInner, GetForexQuotesOrderEnum, GetForexQuotesSortEnum, GetForexRSIOrderEnum, GetForexRSISeriesTypeEnum, GetForexRSITimespanEnum, GetForexSMAOrderEnum, GetForexSMASeriesTypeEnum, GetForexSMATimespanEnum, GetForexSnapshotDirectionDirectionEnum, type GetForexSnapshotTicker200Response, type GetForexSnapshotTicker200ResponseAllOfTicker, type GetForexSnapshotTickers200Response, type GetForexSnapshotTickers200ResponseAllOfTickersInner, type GetForexSnapshotTickers200ResponseAllOfTickersInnerDay, type GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote, type GetForexSnapshotTickers200ResponseAllOfTickersInnerMin, type GetFuturesAggregates200Response, type GetFuturesAggregates200ResponseResultsInner, GetFuturesAggregatesSortEnum, type GetFuturesContractDetails200Response, type GetFuturesContracts200Response, type GetFuturesContracts200ResponseResultsInner, GetFuturesContractsActiveEnum, GetFuturesContractsSortEnum, GetFuturesContractsTypeEnum, type GetFuturesDailySchedules200Response, GetFuturesDailySchedulesSortEnum, type GetFuturesMarketStatuses200Response, type GetFuturesMarketStatuses200ResponseResultsInner, GetFuturesMarketStatuses200ResponseResultsInnerMarketStatusEnum, GetFuturesMarketStatusesSortEnum, type GetFuturesProductDetails200Response, GetFuturesProductDetailsTypeEnum, type GetFuturesProductSchedules200Response, type GetFuturesProductSchedules200ResponseResultsInner, type GetFuturesProductSchedules200ResponseResultsInnerScheduleInner, GetFuturesProductSchedules200ResponseResultsInnerScheduleInnerEventEnum, GetFuturesProductSchedulesSortEnum, type GetFuturesProducts200Response, type GetFuturesProducts200ResponseResultsInner, GetFuturesProducts200ResponseResultsInnerClearingChannelEnum, GetFuturesProductsAssetClassEnum, GetFuturesProductsAssetSubClassEnum, GetFuturesProductsSectorEnum, GetFuturesProductsSortEnum, GetFuturesProductsSubSectorEnum, GetFuturesProductsTypeEnum, type GetFuturesQuotes200Response, type GetFuturesQuotes200ResponseResultsInner, GetFuturesQuotesSortEnum, type GetFuturesTrades200Response, type GetFuturesTrades200ResponseResultsInner, GetFuturesTradesSortEnum, type GetGroupedCryptoAggregates200Response, type GetGroupedCryptoAggregates200ResponseAllOfResultsInner, type GetGroupedStocksAggregates200Response, type GetGroupedStocksAggregates200ResponseAllOfResultsInner, GetIndicesAggregatesSortEnum, GetIndicesAggregatesTimespanEnum, GetIndicesEMAOrderEnum, GetIndicesEMASeriesTypeEnum, GetIndicesEMATimespanEnum, GetIndicesMACDOrderEnum, GetIndicesMACDSeriesTypeEnum, GetIndicesMACDTimespanEnum, type GetIndicesOpenClose200Response, GetIndicesRSIOrderEnum, GetIndicesRSISeriesTypeEnum, GetIndicesRSITimespanEnum, GetIndicesSMAOrderEnum, GetIndicesSMASeriesTypeEnum, GetIndicesSMATimespanEnum, type GetIndicesSnapshot200Response, type GetIndicesSnapshot200ResponseResultsInner, type GetIndicesSnapshot200ResponseResultsInnerSession, GetIndicesSnapshot200ResponseResultsInnerTimeframeEnum, GetIndicesSnapshot200ResponseResultsInnerTypeEnum, GetIndicesSnapshotOrderEnum, GetIndicesSnapshotSortEnum, type GetLastCryptoTrade200Response, type GetLastCryptoTrade200ResponseLast, type GetLastCurrencyQuote200Response, type GetLastOptionsTrade200Response, type GetLastOptionsTrade200ResponseResults, type GetLastStocksQuote200Response, type GetLastStocksQuote200ResponseResults, type GetMarketHolidays200ResponseInner, type GetMarketStatus200Response, type GetMarketStatus200ResponseCurrencies, type GetMarketStatus200ResponseExchanges, type GetMarketStatus200ResponseIndicesGroups, type GetOptionContract200Response, GetOptionsAggregatesSortEnum, GetOptionsAggregatesTimespanEnum, type GetOptionsChain200Response, type GetOptionsChain200ResponseResultsInner, type GetOptionsChain200ResponseResultsInnerDay, type GetOptionsChain200ResponseResultsInnerDetails, GetOptionsChain200ResponseResultsInnerDetailsContractTypeEnum, GetOptionsChain200ResponseResultsInnerDetailsExerciseStyleEnum, type GetOptionsChain200ResponseResultsInnerLastQuote, GetOptionsChain200ResponseResultsInnerLastQuoteTimeframeEnum, type GetOptionsChain200ResponseResultsInnerLastTrade, GetOptionsChain200ResponseResultsInnerLastTradeTimeframeEnum, GetOptionsChainContractTypeEnum, GetOptionsChainOrderEnum, GetOptionsChainSortEnum, type GetOptionsContract200Response, GetOptionsEMAOrderEnum, GetOptionsEMASeriesTypeEnum, GetOptionsEMATimespanEnum, GetOptionsMACDOrderEnum, GetOptionsMACDSeriesTypeEnum, GetOptionsMACDTimespanEnum, type GetOptionsOpenClose200Response, type GetOptionsQuotes200Response, type GetOptionsQuotes200ResponseResultsInner, GetOptionsQuotesOrderEnum, GetOptionsQuotesSortEnum, GetOptionsRSIOrderEnum, GetOptionsRSISeriesTypeEnum, GetOptionsRSITimespanEnum, GetOptionsSMAOrderEnum, GetOptionsSMASeriesTypeEnum, GetOptionsSMATimespanEnum, type GetOptionsTrades200Response, type GetOptionsTrades200ResponseResultsInner, GetOptionsTradesOrderEnum, GetOptionsTradesSortEnum, type GetPreviousCryptoAggregates200Response, type GetPreviousForexAggregates200Response, type GetPreviousForexAggregates200ResponseAllOfResultsInner, type GetPreviousIndicesAggregates200Response, type GetPreviousIndicesAggregates200ResponseAllOfResultsInner, type GetRelatedCompanies200Response, type GetRelatedCompanies200ResponseResultsInner, type GetSnapshotSummary200Response, type GetSnapshotSummary200ResponseResultsInner, type GetSnapshotSummary200ResponseResultsInnerBranding, type GetSnapshotSummary200ResponseResultsInnerOptions, GetSnapshotSummary200ResponseResultsInnerOptionsContractTypeEnum, GetSnapshotSummary200ResponseResultsInnerOptionsExerciseStyleEnum, type GetSnapshotSummary200ResponseResultsInnerSession, GetSnapshotSummary200ResponseResultsInnerTypeEnum, type GetSnapshots200Response, type GetSnapshots200ResponseResultsInner, type GetSnapshots200ResponseResultsInnerDetails, GetSnapshots200ResponseResultsInnerDetailsContractTypeEnum, GetSnapshots200ResponseResultsInnerDetailsExerciseStyleEnum, type GetSnapshots200ResponseResultsInnerGreeks, type GetSnapshots200ResponseResultsInnerLastMinute, type GetSnapshots200ResponseResultsInnerLastQuote, GetSnapshots200ResponseResultsInnerLastQuoteTimeframeEnum, type GetSnapshots200ResponseResultsInnerLastTrade, GetSnapshots200ResponseResultsInnerLastTradeTimeframeEnum, GetSnapshots200ResponseResultsInnerTimeframeEnum, GetSnapshots200ResponseResultsInnerTypeEnum, type GetSnapshots200ResponseResultsInnerUnderlyingAsset, GetSnapshots200ResponseResultsInnerUnderlyingAssetTimeframeEnum, GetSnapshotsOrderEnum, GetSnapshotsSortEnum, GetSnapshotsTypeEnum, type GetStocksAggregates200Response, type GetStocksAggregates200ResponseAllOfResultsInner, GetStocksAggregatesSortEnum, GetStocksAggregatesTimespanEnum, GetStocksEMAOrderEnum, GetStocksEMASeriesTypeEnum, GetStocksEMATimespanEnum, GetStocksMACDOrderEnum, GetStocksMACDSeriesTypeEnum, GetStocksMACDTimespanEnum, type GetStocksQuotes200Response, type GetStocksQuotes200ResponseResultsInner, GetStocksQuotesOrderEnum, GetStocksQuotesSortEnum, GetStocksRSIOrderEnum, GetStocksRSISeriesTypeEnum, GetStocksRSITimespanEnum, GetStocksSMAOrderEnum, GetStocksSMASeriesTypeEnum, GetStocksSMATimespanEnum, type GetStocksSnapshotDirection200Response, GetStocksSnapshotDirectionDirectionEnum, type GetStocksSnapshotTicker200Response, type GetStocksSnapshotTicker200ResponseAllOfTicker, type GetStocksSnapshotTickers200Response, type GetStocksSnapshotTickers200ResponseAllOfTickersInner, type GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay, type GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote, type GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade, type GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin, type GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay, type GetStocksTrades200Response, type GetStocksTrades200ResponseResultsInner, GetStocksTradesOrderEnum, GetStocksTradesSortEnum, type GetStocksV1ShortInterest200Response, type GetStocksV1ShortInterest200ResponseResultsInner, GetStocksV1ShortInterest200ResponseStatusEnum, type GetStocksV1ShortVolume200Response, type GetStocksV1ShortVolume200ResponseResultsInner, GetStocksV1ShortVolume200ResponseStatusEnum, type GetTicker200Response, type GetTicker200ResponseResults, type GetTicker200ResponseResultsAddress, type GetTicker200ResponseResultsBranding, GetTicker200ResponseResultsLocaleEnum, GetTicker200ResponseResultsMarketEnum, type GetTmxV1CorporateEvents200Response, type GetTmxV1CorporateEvents200ResponseResultsInner, GetTmxV1CorporateEvents200ResponseStatusEnum, type IAggegateForexEvent, type IAggregateCryptoEvent, type IAggregateFuturesEvent, type IAggregateIndexEvent, type IAggregateOptionsEvent, type IAggregateStockEvent, type IFMVCryptoEvent, type IFMVForexEvent, type IFMVOptionsEvent, type IFMVStockEvent, type IIndexValueEvent, type ILULDStockEvent, type IPolygonClient, type IQuoteCryptoEvent, type IQuoteForexEvent, type IQuoteFuturesEvent, type IQuoteOptionsEvent, type IQuoteStockEvent, type ITradeCryptoEvent, type ITradeFuturesEvent, type ITradeOptionsEvent, type ITradeStockEvent, type IWebsocketClient, type IndexAggsBase, type IndicesGroupedResults, type IndicesOpenClose, type IndicesTickerResults, type IndicesTickerResultsResultsInner, type ListConditions200Response, type ListConditions200ResponseResultsInner, ListConditions200ResponseResultsInnerAssetClassEnum, ListConditions200ResponseResultsInnerDataTypesEnum, type ListConditions200ResponseResultsInnerSipMapping, ListConditions200ResponseResultsInnerTypeEnum, type ListConditions200ResponseResultsInnerUpdateRules, type ListConditions200ResponseResultsInnerUpdateRulesConsolidated, type ListConditions200ResponseResultsInnerUpdateRulesMarketCenter, type ListConditions400Response, ListConditionsAssetClassEnum, ListConditionsDataTypeEnum, ListConditionsOrderEnum, ListConditionsSipEnum, ListConditionsSortEnum, type ListDividends200Response, type ListDividends200ResponseResultsInner, ListDividends200ResponseResultsInnerDividendTypeEnum, ListDividendsDividendTypeEnum, ListDividendsFrequencyEnum, ListDividendsOrderEnum, ListDividendsSortEnum, type ListExchanges200Response, type ListExchanges200ResponseResultsInner, ListExchanges200ResponseResultsInnerAssetClassEnum, ListExchanges200ResponseResultsInnerLocaleEnum, ListExchanges200ResponseResultsInnerTypeEnum, type ListExchanges400Response, ListExchangesAssetClassEnum, ListExchangesLocaleEnum, type ListFinancials200Response, type ListFinancials200ResponseResultsInner, type ListFinancials200ResponseResultsInnerFinancials, type ListFinancials200ResponseResultsInnerFinancialsBalanceSheet, ListFinancialsOrderEnum, ListFinancialsSortEnum, ListFinancialsTimeframeEnum, type ListIPOs200Response, type ListIPOs200ResponseResultsInner, ListIPOs200ResponseResultsInnerIpoStatusEnum, ListIPOsIpoStatusEnum, ListIPOsOrderEnum, ListIPOsSortEnum, type ListNews200Response, type ListNews200ResponseResultsInner, type ListNews200ResponseResultsInnerInsightsInner, ListNews200ResponseResultsInnerInsightsInnerSentimentEnum, type ListNews200ResponseResultsInnerPublisher, ListNewsOrderEnum, type ListNewsPublishedUtcParameter, ListNewsSortEnum, type ListOptionsContracts200Response, type ListOptionsContracts200ResponseResultsInner, type ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner, ListOptionsContracts200ResponseResultsInnerExerciseStyleEnum, ListOptionsContractsContractTypeEnum, ListOptionsContractsOrderEnum, ListOptionsContractsSortEnum, type ListStockSplits200Response, type ListStockSplits200ResponseResultsInner, ListStockSplitsOrderEnum, ListStockSplitsSortEnum, type ListTickerTypes200Response, type ListTickerTypes200ResponseResultsInner, ListTickerTypes200ResponseResultsInnerAssetClassEnum, ListTickerTypes200ResponseResultsInnerLocaleEnum, ListTickerTypesAssetClassEnum, ListTickerTypesLocaleEnum, type ListTickers200Response, type ListTickers200ResponseResultsInner, ListTickers200ResponseResultsInnerLocaleEnum, ListTickers200ResponseResultsInnerMarketEnum, ListTickersMarketEnum, ListTickersOrderEnum, ListTickersSortEnum, ListTickersTypeEnum, type Locales, type LocalesResultsInner, type MapKey, MapKeyTypeEnum, type MarketHolidayInner, type MarketStatus, type MarketStatusCurrencies, type MarketStatusExchanges, type Markets, type MarketsResultsInner, type ModelDate, type ModelMap, type NewsInner, type PaginationHooksBase, type RatingSection, type RequestIdBase, type SnapshotMinOHLCV, type SnapshotOHLCV, type SnapshotOHLCVVW, type SnapshotOHLCVVWOtc, type StandardBase, type StatusBase, type StatusCountBase, type StocksGroupedResults, type StocksOpenClose, type StocksSnapshotLastQuote, type StocksSnapshotMinute, type StocksSnapshotMinuteOTC, type StocksSnapshotTicker, type StocksSnapshotTickers, type StocksTickerResultsOTC, type StocksV2Base, type StocksV2NBBO, type StocksV2NBBOs, type StocksV2Trade, type StocksV2Trades, type TickerBase, type TickerResults, type TradeDetailsMapItem, type V1LastBase, type V2AggsBase, type V2LastBase, type V2TicksBase, polygonClient as default, getCryptoWebsocket, getForexWebsocket, getFuturesWebsocket, getIndicesWebsocket, getOptionsWebsocket, getStocksWebsocket, polygonClient, restClient, websocketClient };