# Functions
APIKey sets an APIKey as an option.
EdgeUserAgent sets the Launchpad optional header denoting the Edge User's UserAgent.
Header sets a header as an option.
QueryParam sets a query param as an option.
RequiredEdgeHeaders sets the required headers for the Launchpad product.
WithTrace enables or disables request tracing.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HeaderEdgeID is a required Launchpad header.
HeaderEdgeIPAddress is a required Launchpad header.
HeaderEdgeUserAgent is an optional Launchpad header.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Agg is an aggregation of all the activity on a specified ticker between the start and end timestamps.
BaseResponse has all possible attributes that any response can use.
Branding contains information related to a company's brand.
CompanyAddress contains information on the physical address of a company.
Condition contains detailed information on a specified condition.
CryptoTrade is a trade for a crypto pair.
DayOptionContractSnapshot contains the most recent day agg for an option contract.
DaySnapshot is the most recent day agg for a ticker.
Details contains all the information that might come back in the details attribute of a SnapshotResponse.
Dividend contains detailed information on a specified stock dividend.
ErrorResponse represents an API response with an error status code.
Exchange contains detailed information on a specified stock Exchange.
ForexQuote is a BBO for a forex currency pair.
FullBookSnapshot is the level 2 book of a single crypto ticker.
GetAggsParams is the set of parameters for the GetAggs method.
GetAggsResponse is the response returned by the GetAggs method.
GetAllTickersSnapshotParams is the set of parameters for the GetAllTickersSnapshot method.
GetAllTickersSnapshotResponse is the response returned by the GetAllTickersSnapshot method.
GetCryptoFullBookSnapshotParams is the set of parameters for the GetCryptoFullBookSnapshot method.
GetCryptoFullBookSnapshotResponse is the response returned by the GetCryptoFullBookSnapshot method.
GetDailyOpenCloseAggParams is the set of parameters for the GetDailyOpenCloseAgg method.
GetDailyOpenCloseAggResponse is the response for the GetDailyOpenCloseAgg method.
GetEMAParams is the set of parameters for the GetEMA method.
No description provided by the author
GetExchangesParams is the set of parameters for the GetExchanges method.
GetExchangesResponse is the response returned by the GetExchanges method.
GetGainersLosersSnapshotParams is the set of parameters for the GetGainersLosersSnapshot method.
GetGainersLosersSnapshotResponse is the response returned by the GetGainersLosersSnapshot method.
GetGroupedDailyAggsParams is the set of parameters for the GetGroupedDailyAggs method.
GetGroupedDailyAggsResponse is the response returned by the GetGroupedDailyAggs method.
GetIndicesSnapshotParams is the set of parameters for the GetIndicesSnapshot method.
GetIndicesSnapshotResponse is the response returned by the GetIndicesSnapshot method.
GetLastCryptoTradeParams is the set of parameters for the GetLastCryptoTrade method.
GetLastCryptoTradeResponse is the response returned by the GetLastCryptoTrade method.
GetLastForexQuoteParams is the set of parameters for the GetLastForexQuote method.
GetLastForexQuoteResponse is the response returned by the GetLastForexQuote method.
GetLastQuoteParams is the set of parameters for the GetLastQuote method.
GetLastQuoteResponse is the response returned by the GetLastQuote method.
GetLastTradeParams is the set of parameters for GetLastTrade method.
GetLastTradeResponse is the response returned by the GetLastTradeResponse method.
GetMACDParams is the set of parameters for the GetMACD method.
No description provided by the author
GetMarketStatusResponse is the response returned by the GetMarketStatus method.
GetOptionContractSnapshotParams is the set of parameters for the GetOptionContractSnapshot method.
GetOptionContractSnapshotResponse is the response returned by the GetOptionContractSnapshot method.
GetOptionsContract is the set of parameters for the GetOptionsContract method.
GetOptionsContractResponse is the response returned by the GetOptionsContract method.
GetPreviousCloseAggParams is the set of parameters for the GetPreviousCloseAgg method.
GetPreviousCloseAggResponse is the response returned by the GetPreviousCloseAgg method.
GetRealTimeCurrencyConversionParams is the set of parameters for the GetRealTimeCurrencyConversion method.
GetRealTimeCurrencyConversionResponse is the response returned by the GetRealTimeCurrencyConversion method.
GetRSIParams is the set of parameters for the GetRSI method.
No description provided by the author
GetSMAParams is the set of parameters for the GetSMA method.
GetAggsResponse is the response returned by the GetAggs method.
No description provided by the author
No description provided by the author
GetTickerDetailsParams is the set of parameters for the GetTickerDetails method.
GetTickerDetailsResponse is the response returned by the GetTickerDetails method.
GetTickerEventsParams is the set of parameters for the GetTickerEvents method.
GetTickerEventsResponse is the response returned by the GetTickerEvents method.
GetTickerRelatedCompaniesParams is the set of parameters for the GetTickerRelatedCompanies method.
GetTickerDetailsResponse is the response returned by the GetTickerRelatedCompanies method.
GetTickerSnapshotParams is the set of parameters for the GetTickerSnapshot method.
GetTickerSnapshotResponse is the response returned by the GetTickerSnapshot method.
GetTickerTypesParams is the set of parameters for the GetTickerTypes method.
GetTickerTypesResponse is the response returned by the GetTickerTypes method.
Greeks contains the delta, gamma, vega, and theta of an option contract.
No description provided by the author
IndexSnapshot is a collection of data for an index ticker including the current session information and the most recent value.
Insights contains sentiment, reasoning, and the ticker symbol associated with the insight.
LastQuote is the most recent NBBO for a ticker symbol.
LastQuoteOptionContractSnapshot contains the most recent quote of an option contract.
LastQuoteSnapshot is the most recent quote for a ticker.
LastTrade is the most recent trade for a specified ticker.
No description provided by the author
LastTradeSnapshot is the most recent trade for a ticker.
ListAggsParams is the set of parameters for the ListAggs method.
ListAggsResponse is the response returned by the ListAggs method.
ListConditionsParams is the set of parameters for the ListConditions method.
ListConditionsResponse is the response returned by the ListConditions method.
ListDividendsParams is the set of parameters for the ListDividends method.
ListDividendsResponse is the response returned by the ListDividends method.
ListOptionsChainParams is a set of parameters for the ListOptionsChainSnapshot method.
No description provided by the author
ListOptionsContracts is the set of parameters for the ListOptionsContracts method.
No description provided by the author
ListQuotesParams is the set of parameters for the ListQuotes method.
ListQuotesResponse is the response returned by the ListQuotes method.
ListSplitsParams is the set of parameters for the ListSplits method.
ListSplitsResponse is the response returned by the ListSplits method.
ListStockFinancialsParams is the set of parameters for the ListStockFinancials method.
ListStockFinancialsResponse is the response returned by the ListFinancials method.
ListTickerNewsParams is the set of parameters for the ListTickerNews method.
ListTickerNewsResponse is the response returned by the ListTickerNews method.
ListTickersParams is the set of parameters for the ListTickers method.
ListTickersResponse is the response returned by the ListTickers method.
ListTradesParams is the set of parameters for the ListTrades method.
ListTradesResponse is the response returned by the ListTrades method.
ListUniversalSnapshotsParams is a set of parameters for the ListUniversalSnapshots method.
ListUniversalSnapshotsResponse is the response returned by the ListUniversalSnapshots method.
No description provided by the author
No description provided by the author
MarketHoliday represents a market holiday for a specific exchange.
MinuteSnapshot is the most recent minute agg for a ticker.
OptionContractSnapshot is a collection of data for an option contract ticker including the current day aggregate and the most recent quote.
OptionDetails contains more detailed information about an option contract.
easyjson:json.
OptionsContract contains detailed information on a specified options contract.
OrderBookQuote contains quote information for a crypto ticker.
PaginationHooks are links to next and/or previous pages.
Publisher contains information on a new article publisher.
Quote is an NBBO for a ticker symbol in a given time range.
RelatedCompany represents a related ticker based on news or sec filings.
RequestOptions are used to configure client calls.
No description provided by the author
No description provided by the author
No description provided by the author
SIPMapping maps a condition to symbols for each SIP.
SnapshotLastQuote contains all the information that might come back in the last_quote attribute of a SnapshotResponse.
SnapshotLastTrade contains all the information that might come back in the last_trade attribute of a SnapshotResponse.
SnapshotResponseModel contains all the information that might come back in a SnapshotResponse.
Split contains detailed information on a specified stock split.
StockFinancial contains detailed information on a specified stock financial.
No description provided by the author
Ticker contains detailed information on a specified ticker symbol.
TickerChangeEvent represents the data relevant to a ticker_change typed event.
TickerEvent contains the data for the different type of ticker events that could occur.
TickerEventResult is the data for a ticker event.
TickerNews contains information on a ticker news article.
TickerSnapshot is a collection of data for a ticker including the current minute, day, and previous day's aggregate, as well as the last trade and quote.
TickerType represents a type of ticker with a code that the API understands.
Trade contains trade data for a specified ticker symbol.
An underlying or deliverable associated with an option contract.
UnderlyingAsset contains information on the underlying stock for this options contract.
No description provided by the author
UpdateRules is a list of aggregation rules.
# Type aliases
AssetClass is an identifier for a group of similar financial instruments.
Comparator is the type of comparison to make for a specific query parameter.
ContractType is the type of contract.
DataType is the type of data.
Date represents a short date string of the following format: "2006-01-02".
Direction is the direction of the snapshot results to return.
DividendType is the type of dividend.
Financial aliases nested data points of information for a stock financial.
Frequency is the number of times a dividend is paid out over the course of one year.
GetMarketHolidaysResponse is the response returned by the GetMarketHolidays method.
Deprecated: Please use UniversalSnapshot types instead of AssetSnapshot types.
Deprecated: Please use UniversalSnapshot types instead of AssetSnapshot types.
No description provided by the author
Locale is the market location.
MarketType is the type of market.
Millis represents a Unix time in milliseconds since January 1, 1970 UTC.
NameComparator is the type of comparison to make for the company_name query parameter in Stock Financials.
Nanos represents a Unix time in nanoseconds since January 1, 1970 UTC.
Order the results.
RequestOption changes the configuration of RequestOptions.
No description provided by the author
No description provided by the author
SIP is the type of Securies Information Processor.
Sort is a query param type that specifies how the results should be sorted.
Time represents a long date string of the following format: "2006-01-02T15:04:05.000Z".
TimeFrame is the type of time frame query parameter for stock financials.
Timespan is the size of the time window.