models

package

Go to main page

Versions in this module

v1

v1.16.9

Jan 8, 2025

v1.16.8

Jan 7, 2025

v1.16.7

Oct 22, 2024

Changes in this version

type Session

+ RegularTradingChange float64

+ RegularTradingChangePercent float64

v1.16.6

Sep 4, 2024

v1.16.5

Jul 18, 2024

Changes in this version

+ type GetTickerRelatedCompaniesParams struct

+ Ticker string

+ type GetTickerRelatedCompaniesResponse struct

+ Results []RelatedCompany

+ type Insights struct

+ Sentiment string

+ SentimentReasoning string

+ Ticker string

type ListDividendsParams

+ func (p ListDividendsParams) WithPayDate(c Comparator, q Date) *ListDividendsParams

type ListOptionsChainParams

+ StrikePriceGT *float64

+ StrikePriceGTE *float64

+ StrikePriceLT *float64

+ StrikePriceLTE *float64

+ type RelatedCompany struct

+ Ticker string

type TickerNews

+ Insights []Insights

v1.16.4

Jan 2, 2024

v1.16.2

Dec 14, 2023

v1.16.1

Dec 5, 2023

v1.16.0

Nov 27, 2023

v1.15.0

Oct 25, 2023

Changes in this version

type OptionContractSnapshot

+ FairMarketValue float64

type SnapshotResponseModel

+ FairMarketValue float64

type TickerSnapshot

+ FairMarketValue float64

v1.14.1

Aug 22, 2023

Changes in this version

type GetEMAParams

+ Limit *int

+ func (p GetEMAParams) WithLimit(q int) *GetEMAParams

type GetMACDParams

+ Limit *int

+ func (p GetMACDParams) WithLimit(q int) *GetMACDParams

type GetRSIParams

+ Limit *int

+ func (p GetRSIParams) WithLimit(q int) *GetRSIParams

type GetSMAParams

+ Limit *int

+ func (p GetSMAParams) WithLimit(q int) *GetSMAParams

v1.14.0

Jul 25, 2023

Changes in this version

type Timespan

+ const Second

v1.13.1

Jun 26, 2023

Changes in this version

type RequestOption

+ func WithTrace(trace bool) RequestOption

type RequestOptions

+ Trace bool

v1.13.0

Jun 12, 2023

v1.12.2

Jun 6, 2023

v1.12.1

May 24, 2023

Changes in this version

+ type ListUniversalSnapshotsParams struct

+ Ticker *string

+ TickerAnyOf *string

+ TickerGT *string

+ TickerGTE *string

+ TickerLT *string

+ TickerLTE *string

+ Type *string

+ func (p ListUniversalSnapshotsParams) WithTicker(q string) *ListUniversalSnapshotsParams

+ func (p ListUniversalSnapshotsParams) WithTickerAnyOf(q string) *ListUniversalSnapshotsParams

+ func (p ListUniversalSnapshotsParams) WithTickersByComparison(c Comparator, q string) *ListUniversalSnapshotsParams

+ func (p ListUniversalSnapshotsParams) WithType(q string) *ListUniversalSnapshotsParams

+ type ListUniversalSnapshotsResponse struct

+ Results []SnapshotResponseModel

type MinuteSnapshot

+ NumberOfTransactions float64

+ Timestamp Millis

type Session

+ Price float64

type SnapshotLastQuote

+ Exchange int64

type SnapshotLastTrade

+ ParticipantTimestamp int64

type SnapshotResponseModel

+ LastUpdated int64

+ Timeframe string

+ Value float64

v1.12.0

May 11, 2023

Changes in this version

+ type Details struct

+ ContractType string

+ ExerciseStyle string

+ ExpirationDate string

+ SharesPerContract float64

+ StrikePrice float64

+ type ListAssetSnapshotsParams struct

+ Ticker *string

+ TickerAnyOf *string

+ TickerGT *string

+ TickerGTE *string

+ TickerLT *string

+ TickerLTE *string

+ Type *string

+ func (p ListAssetSnapshotsParams) WithTicker(q string) *ListAssetSnapshotsParams

+ func (p ListAssetSnapshotsParams) WithTickerAnyOf(q string) *ListAssetSnapshotsParams

+ func (p ListAssetSnapshotsParams) WithTickersByComparison(c Comparator, q string) *ListAssetSnapshotsParams

+ func (p ListAssetSnapshotsParams) WithType(q string) *ListAssetSnapshotsParams

+ type ListAssetSnapshotsResponse struct

+ Results []SnapshotResponseModel

+ type SnapshotLastQuote struct

+ Ask float64

+ AskSize float64

+ Bid float64

+ BidSize float64

+ LastUpdated int64

+ Midpoint float64

+ Timeframe string

+ type SnapshotLastTrade struct

+ Conditions []int32

+ Exchange int32

+ ID string

+ LastUpdated int64

+ Price float64

+ Size uint32

+ Timeframe string

+ Timestamp int64

+ type SnapshotResponseModel struct

+ BreakEvenPrice float64

+ Details Details

+ Error string

+ Greeks Greeks

+ ImpliedVolatility float64

+ LastQuote SnapshotLastQuote

+ LastTrade SnapshotLastTrade

+ MarketStatus string

+ Message string

+ Name string

+ OpenInterest float64

+ Session Session

+ Ticker string

+ Type string

+ UnderlyingAsset UnderlyingAsset

type Sort

+ const FilingDate

+ const PeriodOfReportDate

v1.11.1

Mar 21, 2023

v1.11.0

Mar 13, 2023

Changes in this version

type AssetClass

+ const AssetIndices

+ type GetIndicesSnapshotParams struct

+ TickerAnyOf *string

+ func (p GetIndicesSnapshotParams) WithTickerAnyOf(tickers ...string) *GetIndicesSnapshotParams

+ type GetIndicesSnapshotResponse struct

+ Results []IndexSnapshot

type GetMarketStatusResponse

+ IndicesGroups map[string]string

+ type IndexSession struct

+ Change float64

+ ChangePercent float64

+ Close float64

+ High float64

+ Low float64

+ Open float64

+ PreviousClose float64

+ type IndexSnapshot struct

+ MarketStatus string

+ Name string

+ Session IndexSession

+ Ticker string

+ Type string

+ Value float64

type Ticker

+ SourceFeed string

type UnderlyingAsset

+ Value float64

v1.10.0

Feb 22, 2023

Changes in this version

+ type LastTradeOptionContractSnapshot struct

+ Conditions []int32

+ Exchange int32

+ Price float64

+ Size float64

+ Timeframe string

+ Timestamp Nanos

type OptionContractSnapshot

+ LastTrade LastTradeOptionContractSnapshot

v1.9.0

Jan 30, 2023

Changes in this version

+ type ListAggsParams struct

+ Adjusted *bool

+ From Millis

+ Limit *int

+ Multiplier int

+ Order *Order

+ Ticker string

+ Timespan Timespan

+ To Millis

+ func (p ListAggsParams) WithAdjusted(q bool) *ListAggsParams

+ func (p ListAggsParams) WithLimit(q int) *ListAggsParams

+ func (p ListAggsParams) WithOrder(q Order) *ListAggsParams

+ type ListAggsResponse struct

+ Adjusted bool

+ QueryCount int

+ Results []Agg

+ ResultsCount int

+ Ticker string

v1.8.0

Jan 10, 2023

Changes in this version

+ type GetTickerEventsParams struct

+ ID string

+ Types *string

+ func (p GetTickerEventsParams) WithTypes(types ...string) *GetTickerEventsParams

+ type GetTickerEventsResponse struct

+ Results []TickerEventResult

+ type TickerChangeEvent struct

+ Ticker string

+ type TickerEvent struct

+ Date string

+ TickerChange *TickerChangeEvent

+ Type string

+ type TickerEventResult struct

+ Events []TickerEvent

+ Name string

v1.7.0

Jan 5, 2023

Changes in this version

+ type ContractType string

+ const ContractCall

+ const ContractOther

+ const ContractPut

+ type ListOptionsChainParams struct

+ ContractType *ContractType

+ ExpirationDateEQ *Date

+ ExpirationDateGT *Date

+ ExpirationDateGTE *Date

+ ExpirationDateLT *Date

+ ExpirationDateLTE *Date

+ Limit *int

+ Order *Order

+ Sort *Sort

+ StrikePrice *float64

+ UnderlyingAsset string

+ func (o ListOptionsChainParams) WithContractType(contractType ContractType) *ListOptionsChainParams

+ func (o ListOptionsChainParams) WithExpirationDate(comparator Comparator, expirationDate Date) *ListOptionsChainParams

+ func (o ListOptionsChainParams) WithLimit(limit int) *ListOptionsChainParams

+ func (o ListOptionsChainParams) WithOrder(order Order) *ListOptionsChainParams

+ func (o ListOptionsChainParams) WithSort(sort Sort) *ListOptionsChainParams

+ func (o ListOptionsChainParams) WithStrikePrice(strikePrice float64) *ListOptionsChainParams

+ type ListOptionsChainSnapshotResponse struct

+ Results []OptionContractSnapshot

type Sort

+ const ExpirationDate

+ const StrikePrice

v1.6.0

Dec 12, 2022

Changes in this version

+ const HeaderEdgeID

+ const HeaderEdgeIPAddress

+ const HeaderEdgeUserAgent

+ type GetSummaryParams struct

+ TickerAnyOf *string

+ func (p GetSummaryParams) WithTickerAnyOf(tickers ...string) *GetSummaryParams

+ type GetSummaryResponse struct

+ Results []SummaryResult

+ type Options struct

+ ContractType string

+ ExerciseStyle string

+ ExpirationDate Date

+ SharesPerContract float64

+ StrikePrice float64

+ UnderlyingTicker string

type RequestOption

+ func EdgeUserAgent(userAgent string) RequestOption

+ func RequiredEdgeHeaders(edgeID, edgeIPAddress string) RequestOption

+ type Session struct

+ Change float64

+ ChangePercent float64

+ Close float64

+ EarlyTradingChange float64

+ EarlyTradingChangePercent float64

+ High float64

+ LateTradingChange float64

+ LateTradingChangePercent float64

+ Low float64

+ Open float64

+ PreviousClose float64

+ Volume float64

+ type SummaryResult struct

+ Branding Branding

+ Error string

+ MarketStatus string

+ Message string

+ Name string

+ Options Options

+ Price float64

+ Session Session

+ Ticker string

+ Type string

v1.6.0-rc.2

Dec 7, 2022

v1.6.0-rc

Dec 2, 2022

v1.5.0

Dec 2, 2022

v1.4.0

Oct 12, 2022

v1.3.0

Sep 8, 2022

Changes in this version

+ type GetEMAParams struct

+ Adjusted *bool

+ ExpandUnderlying *bool

+ Order *Order

+ SeriesType *SeriesType

+ Ticker string

+ Timespan *Timespan

+ TimestampEQ *Millis

+ TimestampGT *Millis

+ TimestampGTE *Millis

+ TimestampLT *Millis

+ TimestampLTE *Millis

+ Window *int

+ func (p GetEMAParams) WithAdjusted(q bool) *GetEMAParams

+ func (p GetEMAParams) WithExpandUnderlying(q bool) *GetEMAParams

+ func (p GetEMAParams) WithOrder(q Order) *GetEMAParams

+ func (p GetEMAParams) WithSeriesType(q SeriesType) *GetEMAParams

+ func (p GetEMAParams) WithTimespan(q Timespan) *GetEMAParams

+ func (p GetEMAParams) WithTimestamp(c Comparator, q Millis) *GetEMAParams

+ func (p GetEMAParams) WithWindow(q int) *GetEMAParams

+ type GetEMAResponse struct

+ Results SingleIndicatorResults

+ type GetMACDParams struct

+ Adjusted *bool

+ ExpandUnderlying *bool

+ LongWindow *int

+ Order *Order

+ SeriesType *SeriesType

+ ShortWindow *int

+ SignalWindow *int

+ Ticker string

+ Timespan *Timespan

+ TimestampEQ *Millis

+ TimestampGT *Millis

+ TimestampGTE *Millis

+ TimestampLT *Millis

+ TimestampLTE *Millis

+ func (p GetMACDParams) WithAdjusted(q bool) *GetMACDParams

+ func (p GetMACDParams) WithExpandUnderlying(q bool) *GetMACDParams

+ func (p GetMACDParams) WithLongWindow(q int) *GetMACDParams

+ func (p GetMACDParams) WithOrder(q Order) *GetMACDParams

+ func (p GetMACDParams) WithSeriesType(q SeriesType) *GetMACDParams

+ func (p GetMACDParams) WithShortWindow(q int) *GetMACDParams

+ func (p GetMACDParams) WithSignalWindow(q int) *GetMACDParams

+ func (p GetMACDParams) WithTimespan(q Timespan) *GetMACDParams

+ func (p GetMACDParams) WithTimestamp(c Comparator, q Millis) *GetMACDParams

+ type GetMACDResponse struct

+ Results MACDIndicatorResults

+ type GetRSIParams struct

+ Adjusted *bool

+ ExpandUnderlying *bool

+ Order *Order

+ SeriesType *SeriesType

+ Ticker string

+ Timespan *Timespan

+ TimestampEQ *Millis

+ TimestampGT *Millis

+ TimestampGTE *Millis

+ TimestampLT *Millis

+ TimestampLTE *Millis

+ Window *int

+ func (p GetRSIParams) WithAdjusted(q bool) *GetRSIParams

+ func (p GetRSIParams) WithExpandUnderlying(q bool) *GetRSIParams

+ func (p GetRSIParams) WithOrder(q Order) *GetRSIParams

+ func (p GetRSIParams) WithSeriesType(q SeriesType) *GetRSIParams

+ func (p GetRSIParams) WithTimespan(q Timespan) *GetRSIParams

+ func (p GetRSIParams) WithTimestamp(c Comparator, q Millis) *GetRSIParams

+ func (p GetRSIParams) WithWindow(q int) *GetRSIParams

+ type GetRSIResponse struct

+ Results SingleIndicatorResults

+ type GetSMAParams struct

+ Adjusted *bool

+ ExpandUnderlying *bool

+ Order *Order

+ SeriesType *SeriesType

+ Ticker string

+ Timespan *Timespan

+ TimestampEQ *Millis

+ TimestampGT *Millis

+ TimestampGTE *Millis

+ TimestampLT *Millis

+ TimestampLTE *Millis

+ Window *int

+ func (p GetSMAParams) WithAdjusted(q bool) *GetSMAParams

+ func (p GetSMAParams) WithExpandUnderlying(q bool) *GetSMAParams

+ func (p GetSMAParams) WithOrder(q Order) *GetSMAParams

+ func (p GetSMAParams) WithSeriesType(q SeriesType) *GetSMAParams

+ func (p GetSMAParams) WithTimespan(q Timespan) *GetSMAParams

+ func (p GetSMAParams) WithTimestamp(c Comparator, q Millis) *GetSMAParams

+ func (p GetSMAParams) WithWindow(q int) *GetSMAParams

+ type GetSMAResponse struct

+ Results SingleIndicatorResults

+ type MACDIndicatorResults struct

+ Underlying UnderlyingResults

+ Values MACDIndicatorValues

+ type MACDIndicatorValue struct

+ Histogram float64

+ Signal float64

+ Timestamp Millis

+ Value float64

+ type MACDIndicatorValues []MACDIndicatorValue

+ type SeriesType string

+ const Close

+ const High

+ const Low

+ const Open

+ type SingleIndicatorResults struct

+ Underlying UnderlyingResults

+ Values SingleIndicatorValues

+ type SingleIndicatorValue struct

+ Timestamp Millis

+ Value float64

+ type SingleIndicatorValues []SingleIndicatorValue

+ type UnderlyingResults struct

+ Aggregates []Agg

+ URL string

v1.2.0

Aug 3, 2022

Changes in this version

type GetGainersLosersSnapshotParams

+ IncludeOTC *bool

+ func (p GetGainersLosersSnapshotParams) WithIncludeOTC(q bool) *GetGainersLosersSnapshotParams

v1.1.0

Jun 24, 2022

Changes in this version

type Agg

+ OTC bool

type AssetClass

+ const AssetOTC

type DaySnapshot

+ OTC bool

type GetAllTickersSnapshotParams

+ IncludeOTC *bool

+ func (p GetAllTickersSnapshotParams) WithIncludeOTC(q bool) *GetAllTickersSnapshotParams

type GetDailyOpenCloseAggResponse

+ OTC bool

type GetGroupedDailyAggsParams

+ IncludeOTC *bool

+ func (p GetGroupedDailyAggsParams) WithIncludeOTC(q bool) *GetGroupedDailyAggsParams

type ListQuotesParams

+ func (p ListQuotesParams) WithDay(year int, month time.Month, day int) *ListQuotesParams

type ListTradesParams

+ func (p ListTradesParams) WithDay(year int, month time.Month, day int) *ListTradesParams

type MinuteSnapshot

+ OTC bool

v1.0.1

Jun 13, 2022

v1.0.0

May 23, 2022

v0

v0.11.0

May 19, 2022

v0.10.0

May 17, 2022

Changes in this version

+ type GetOptionsContractParams struct

+ AsOf *Date

+ Ticker string

+ func (p GetOptionsContractParams) WithAsOf(q Date) *GetOptionsContractParams

+ type GetOptionsContractResponse struct

+ Results OptionsContract

+ type ListOptionsContractsParams struct

+ AsOf *Date

+ ContractType *string

+ ExpirationDateEQ *Date

+ ExpirationDateGT *Date

+ ExpirationDateGTE *Date

+ ExpirationDateLT *Date

+ ExpirationDateLTE *Date

+ Expired *bool

+ Limit *int

+ Order *Order

+ Sort *Sort

+ StrikePriceEQ *float64

+ StrikePriceGT *float64

+ StrikePriceGTE *float64

+ StrikePriceLT *float64

+ StrikePriceLTE *float64

+ UnderlyingTickerEQ *string

+ UnderlyingTickerGT *string

+ UnderlyingTickerGTE *string

+ UnderlyingTickerLT *string

+ UnderlyingTickerLTE *string

+ func (p ListOptionsContractsParams) WithAsOf(q Date) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithContractType(q string) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithExpirationDate(c Comparator, q Date) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithExpired(q bool) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithLimit(q int) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithOrder(q Order) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithSort(q Sort) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithStrikePrice(c Comparator, q float64) *ListOptionsContractsParams

+ func (p ListOptionsContractsParams) WithUnderlyingTicker(c Comparator, q string) *ListOptionsContractsParams

+ type ListOptionsContractsResponse struct

+ Results []OptionsContract

+ type OptionsContract struct

+ AdditionalUnderlyings []Underlying

+ CFI string

+ ContractType string

+ Correction int32

+ ExerciseStyle string

+ ExpirationDate Date

+ PrimaryExchange string

+ SharesPerContract float64

+ StrikePrice float64

+ Ticker string

+ UnderlyingTicker string

+ type Underlying struct

+ Amount float64

+ Type string

+ Underlying string

v0.9.1

May 17, 2022

v0.9.0

May 16, 2022

Changes in this version

+ type FullBookSnapshot struct

+ AskCount float64

+ Asks []OrderBookQuote

+ BidCount float64

+ Bids []OrderBookQuote

+ Spread float64

+ Ticker string

+ Updated Nanos

type GetAggsParams

+ Timespan Timespan

+ type SIPMapping struct

+ CTA string

+ OPRA string

+ UTP string

+ type Timespan string

+ type UpdateRules struct

+ Consolidated struct{ ... }

+ MarketCenter struct{ ... }

v0.8.0

May 12, 2022

v0.7.1

May 6, 2022

v0.7.0

May 4, 2022

Changes in this version

+ type Financial map[string]struct

+ type ListStockFinancialsParams struct

+ CIK *string

+ CompanyNameFull *string

+ CompanyNameSearch *string

+ FilingDateEQ *Date

+ FilingDateGT *Date

+ FilingDateGTE *Date

+ FilingDateLT *Date

+ FilingDateLTE *Date

+ IncludeSources *bool

+ Limit *int

+ Order *Order

+ PeriodOfReportDateEQ *Date

+ PeriodOfReportDateGT *Date

+ PeriodOfReportDateGTE *Date

+ PeriodOfReportDateLT *Date

+ PeriodOfReportDateLTE *Date

+ SIC *string

+ Sort *Sort

+ Ticker *string

+ Timeframe *Timeframe

+ func (p ListStockFinancialsParams) WithCIK(q string) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithCompanyName(c NameComparator, q string) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithFilingDate(c Comparator, q Date) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithIncludeSources(q bool) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithLimit(q int) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithOrder(q Order) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithPeriodOfReportDate(c Comparator, q Date) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithSIC(q string) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithSort(q Sort) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithTicker(q string) *ListStockFinancialsParams

+ func (p ListStockFinancialsParams) WithTimeframe(q Timeframe) *ListStockFinancialsParams

+ type ListStockFinancialsResponse struct

+ Results []StockFinancial

+ type NameComparator string

+ const Full

+ const Search

+ type StockFinancial struct

+ CIK string

+ CompanyName string

+ EndDate string

+ FilingDate string

+ Financials map[string]Financial

+ FiscalPeriod string

+ FiscalYear string

+ SourceFilingFileUrl string

+ SourceFilingUrl string

+ StartDate string

+ type Timeframe string

+ const TFAnnual

+ const TFQuarterly

v0.6.0

May 3, 2022

v0.5.0

Apr 29, 2022

Changes in this version

+ type GetRealTimeCurrencyConversionParams struct

+ From string

+ To string

+ type GetRealTimeCurrencyConversionResponse struct

+ Converted float64

+ From string

+ InitialAmount float64

+ LastQuote ForexQuote

+ To string

v0.4.0

Apr 29, 2022

Changes in this version

+ type ListTickerNewsParams struct

+ Limit *int

+ Order *Order

+ PublishedUtcEQ *Millis

+ PublishedUtcGT *Millis

+ PublishedUtcGTE *Millis

+ PublishedUtcLT *Millis

+ PublishedUtcLTE *Millis

+ Sort *Sort

+ TickerEQ *string

+ TickerGT *string

+ TickerGTE *string

+ TickerLT *string

+ TickerLTE *string

+ func (p ListTickerNewsParams) WithLimit(q int) *ListTickerNewsParams

+ func (p ListTickerNewsParams) WithOrder(q Order) *ListTickerNewsParams

+ func (p ListTickerNewsParams) WithPublishedUTC(c Comparator, q Millis) *ListTickerNewsParams

+ func (p ListTickerNewsParams) WithSort(q Sort) *ListTickerNewsParams

+ func (p ListTickerNewsParams) WithTicker(c Comparator, q string) *ListTickerNewsParams

+ type ListTickerNewsResponse struct

+ Results []TickerNews

+ type Publisher struct

+ FaviconURL string

+ HomepageURL string

+ LogoURL string

+ Name string

type Sort

+ const PublishedUTC

+ type TickerNews struct

+ AMPURL string

+ ArticleURL string

+ Author string

+ Description string

+ ID string

+ ImageURL string

+ Keywords []string

+ PublishedUTC Time

+ Publisher Publisher

+ Tickers []string

+ Title string

v0.3.0

Apr 18, 2022

v0.2.0

Apr 11, 2022

Changes in this version

type PaginationHooks

+ func (p PaginationHooks) NextPage() string

v0.1.0

Apr 8, 2022

Changes in this version

+ const GetAggsPath

+ const GetAllTickersSnapshotPath

+ const GetCryptoFullBookSnapshotPath

+ const GetDailyOpenCloseAggPath

+ const GetExchangesPath

+ const GetGainersLosersSnapshotPath

+ const GetGroupedDailyAggsPath

+ const GetLastCryptoTradePath

+ const GetLastForexQuotePath

+ const GetLastQuotePath

+ const GetLastTradePath

+ const GetMarketHolidaysPath

+ const GetMarketStatusPath

+ const GetOptionContractSnapshotPath

+ const GetPreviousCloseAggPath

+ const GetTickerDetailsPath

+ const GetTickerSnapshotPath

+ const GetTickerTypesPath

+ const ListConditionsPath

+ const ListDividendsPath

+ const ListQuotesPath

+ const ListSplitsPath

+ const ListTickersPath

+ const ListTradesPath

+ type Agg struct

+ AccumulatedVolume float64

+ AggregateVWAP float64

+ AverageSize float64

+ Close float64

+ EndTimestamp *Millis

+ Exchange int32

+ High float64

+ Locale string

+ Low float64

+ Market string

+ OfficialOpenPrice float64

+ Open float64

+ StartTimestamp *Millis

+ Ticker string

+ Timestamp *Millis

+ Transactions int64

+ VWAP float64

+ Volume float64

+ type AssetClass string

+ const AssetCrypto

+ const AssetFx

+ const AssetOptions

+ const AssetStocks

+ type BaseResponse struct

+ Count int

+ ErrorMessage string

+ Message string

+ RequestID string

+ Status string

+ type Branding struct

+ AccentColor string

+ DarkColor string

+ IconURL string

+ LightColor string

+ LogoURL string

+ type CompanyAddress struct

+ Address1 string

+ Address2 string

+ City string

+ Country string

+ PostalCode string

+ State string

+ type Comparator string

+ const EQ

+ const GT

+ const GTE

+ const LT

+ const LTE

+ type Condition struct

+ Abbreviation string

+ AssetClass string

+ DataTypes []string

+ Description string

+ Exchange int64

+ ID int64

+ Legacy bool

+ Name string

+ SIPMapping map[string]string

+ Type string

+ UpdateRules map[string]map[string]bool

+ type CryptoTrade struct

+ Conditions []int

+ Exchange int

+ Price float64

+ Size float64

+ Timestamp *Nanos

+ type DataType string

+ const DataBBO

+ const DataNBBO

+ const DataTrade

+ type Date time.Time

+ func (d *Date) MarshalJSON() ([]byte, error)

+ func (d *Date) UnmarshalJSON(data []byte) error

+ type DayOptionContractSnapshot struct

+ Change float64

+ ChangePercent float64

+ Close float64

+ High float64

+ LastUpdated *Nanos

+ Low float64

+ Open float64

+ PreviousClose float64

+ VWAP float64

+ Volume float64

+ type DaySnapshot struct

+ Close float64

+ High float64

+ Low float64

+ Open float64

+ Volume float64

+ VolumeWeightedAverage float64

+ type Direction string

+ const Gainers

+ const Losers

+ type Dividend struct

+ CashAmount float64

+ DeclarationDate string

+ DividendType string

+ ExDividendDate string

+ Frequency int64

+ PayDate string

+ RecordDate string

+ Ticker string

+ type DividendType string

+ const DividendCD

+ const DividendLT

+ const DividendSC

+ const DividendST

+ type ErrorResponse struct

+ StatusCode int

+ func (e *ErrorResponse) Error() string

+ type Exchange struct

+ Acronym string

+ AssetClass string

+ ID int64

+ Locale string

+ MIC string

+ Name string

+ OperatingMIC string

+ ParticipantID string

+ Type string

+ URL string

+ type ForexQuote struct

+ Ask float64

+ Bid float64

+ Exchange int

+ Timestamp *Nanos

+ type Frequency int64

+ const Annually

+ const BiAnnually

+ const Monthly

+ const OneTime

+ const Quarterly

+ type GetAggsParams struct

+ Adjusted *bool

+ Explain *bool

+ From Millis

+ Limit *int

+ Multiplier int

+ Order *Order

+ Resolution Resolution

+ Ticker string

+ To Millis

+ func (p GetAggsParams) WithAdjusted(q bool) *GetAggsParams

+ func (p GetAggsParams) WithExplain(q bool) *GetAggsParams

+ func (p GetAggsParams) WithLimit(q int) *GetAggsParams

+ func (p GetAggsParams) WithOrder(q Order) *GetAggsParams

+ type GetAggsResponse struct

+ Adjusted bool

+ QueryCount int

+ Results []Agg

+ ResultsCount int

+ Ticker string

+ type GetAllTickersSnapshotParams struct

+ Locale MarketLocale

+ MarketType MarketType

+ Tickers *string

+ func (p GetAllTickersSnapshotParams) WithTickers(q string) *GetAllTickersSnapshotParams

+ type GetAllTickersSnapshotResponse struct

+ Tickers []TickerSnapshot

+ type GetCryptoFullBookSnapshotParams struct

+ Ticker string

+ type GetCryptoFullBookSnapshotResponse struct

+ Data SnapshotTickerFullBook

+ type GetDailyOpenCloseAggParams struct

+ Adjusted *bool

+ Date Date

+ Ticker string

+ func (p GetDailyOpenCloseAggParams) WithAdjusted(q bool) *GetDailyOpenCloseAggParams

+ type GetDailyOpenCloseAggResponse struct

+ AfterHours float64

+ Close float64

+ From string

+ High float64

+ Low float64

+ Open float64

+ PreMarket float64

+ Symbol string

+ Volume float64

+ type GetExchangesParams struct

+ AssetClass *AssetClass

+ Locale *MarketLocale

+ func (p GetExchangesParams) WithAssetClass(q AssetClass) *GetExchangesParams

+ func (p GetExchangesParams) WithLocale(q MarketLocale) *GetExchangesParams

+ type GetExchangesResponse struct

+ Results []Exchange

+ type GetGainersLosersSnapshotParams struct

+ Direction Direction

+ Locale MarketLocale

+ MarketType MarketType

+ type GetGainersLosersSnapshotResponse struct

+ Tickers []TickerSnapshot

+ type GetGroupedDailyAggsParams struct

+ Adjusted *bool

+ Date Date

+ Locale MarketLocale

+ MarketType MarketType

+ func (p GetGroupedDailyAggsParams) WithAdjusted(q bool) *GetGroupedDailyAggsParams

+ type GetGroupedDailyAggsResponse struct

+ Adjusted bool

+ QueryCount int

+ Results []Agg

+ ResultsCount int

+ Ticker string

+ type GetLastCryptoTradeParams struct

+ From string

+ To string

+ type GetLastCryptoTradeResponse struct

+ Last CryptoTrade

+ Symbol string

+ type GetLastForexQuoteParams struct

+ From string

+ To string

+ type GetLastForexQuoteResponse struct

+ Last ForexQuote

+ Symbol string

+ type GetLastQuoteParams struct

+ Ticker string

+ type GetLastQuoteResponse struct

+ Results LastQuote

+ type GetLastTradeParams struct

+ Ticker string

+ type GetLastTradeResponse struct

+ Results LastTrade

+ type GetMarketHolidaysResponse []MarketHoliday

+ type GetMarketStatusResponse struct

+ AfterHours bool

+ Currencies map[string]string

+ EarlyHours bool

+ Exchanges map[string]string

+ Market string

+ ServerTime *Time

+ type GetOptionContractSnapshotParams struct

+ OptionContract string

+ UnderlyingAsset string

+ type GetOptionContractSnapshotResponse struct

+ Results OptionContractSnapshot

+ type GetPreviousCloseAggParams struct

+ Adjusted *bool

+ Ticker string

+ func (p GetPreviousCloseAggParams) WithAdjusted(q bool) *GetPreviousCloseAggParams

+ type GetPreviousCloseAggResponse struct

+ Adjusted bool

+ QueryCount int

+ Results []Agg

+ ResultsCount int

+ Ticker string

+ type GetTickerDetailsParams struct

+ Date *Date

+ Ticker string

+ func (p GetTickerDetailsParams) WithDate(q Date) *GetTickerDetailsParams

+ type GetTickerDetailsResponse struct

+ Results Ticker

+ type GetTickerSnapshotParams struct

+ Locale MarketLocale

+ MarketType MarketType

+ Ticker string

+ type GetTickerSnapshotResponse struct

+ Snapshot TickerSnapshot

+ type GetTickerTypesParams struct

+ AssetClass *AssetClass

+ Locale *MarketLocale

+ func (p GetTickerTypesParams) WithAssetClass(q AssetClass) *GetTickerTypesParams

+ func (p GetTickerTypesParams) WithLocale(q MarketLocale) *GetTickerTypesParams

+ type GetTickerTypesResponse struct

+ Results []TickerType

+ type Greeks struct

+ Delta float64

+ Gamma float64

+ Theta float64

+ Vega float64

+ type Iter struct

+ func NewIter(ctx context.Context, uri string, query Query) Iter

+ func NewIterErr(ctx context.Context, err error) Iter

+ func (it *Iter) Err() error

+ func (it *Iter) Item() interface{}

+ func (it *Iter) Next() bool

+ type LastQuote struct

+ AskExchange int

+ AskPrice float64

+ AskSize float64

+ BidExchange int

+ BidPrice float64

+ BidSize float64

+ Conditions []int32

+ Indicators []int32

+ ParticipantTimestamp *Nanos

+ SequenceNumber *Nanos

+ SipTimestamp *Nanos

+ Tape int32

+ Ticker string

+ TrfTimestamp *Nanos

+ type LastQuoteOptionContractSnapshot struct

+ Ask float64

+ AskSize float64

+ Bid float64

+ BidSize float64

+ LastUpdated *Nanos

+ Midpoint float64

+ Timeframe string

+ type LastQuoteSnapshot struct

+ AskPrice float64

+ AskSize float64

+ BidPrice float64

+ BidSize float64

+ Timestamp *Nanos

+ type LastTrade struct

+ Conditions []int32

+ Correction uint32

+ Exchange int32

+ ID string

+ ParticipantTimestamp *Nanos

+ Price float64

+ SequenceNumber int64

+ Size uint32

+ TRF int32

+ TRFTimestamp *Nanos

+ Tape int32

+ Ticker string

+ Timestamp *Nanos

+ type LastTradeSnapshot struct

+ Conditions []int

+ ExchangeID int

+ Price float64

+ Size int

+ Timestamp *Nanos

+ TradeID string

+ type ListConditionsParams struct

+ AssetClass *AssetClass

+ DataType *DataType

+ ID *int64

+ Limit *int

+ Order *Order

+ SIP *SIP

+ Sort *Sort

+ func (p ListConditionsParams) WithAssetClass(q AssetClass) *ListConditionsParams

+ func (p ListConditionsParams) WithDataType(q DataType) *ListConditionsParams

+ func (p ListConditionsParams) WithID(q int64) *ListConditionsParams

+ func (p ListConditionsParams) WithLimit(q int) *ListConditionsParams

+ func (p ListConditionsParams) WithOrder(q Order) *ListConditionsParams

+ func (p ListConditionsParams) WithSIP(q SIP) *ListConditionsParams

+ func (p ListConditionsParams) WithSort(q Sort) *ListConditionsParams

+ type ListConditionsResponse struct

+ Results []Condition

+ type ListDividendsParams struct

+ CashAmountEQ *float64

+ CashAmountGT *float64

+ CashAmountGTE *float64

+ CashAmountLT *float64

+ CashAmountLTE *float64

+ DeclarationDateEQ *Date

+ DeclarationDateGT *Date

+ DeclarationDateGTE *Date

+ DeclarationDateLT *Date

+ DeclarationDateLTE *Date

+ DividendType *DividendType

+ ExDividendDateEQ *Date

+ ExDividendDateGT *Date

+ ExDividendDateGTE *Date

+ ExDividendDateLT *Date

+ ExDividendDateLTE *Date

+ Frequency *Frequency

+ Limit *int

+ Order *Order

+ PayDateEQ *Date

+ PayDateGT *Date

+ PayDateGTE *Date

+ PayDateLT *Date

+ PayDateLTE *Date

+ RecordDateEQ *Date

+ RecordDateGT *Date

+ RecordDateGTE *Date

+ RecordDateLT *Date

+ RecordDateLTE *Date

+ Sort *Sort

+ TickerEQ *string

+ TickerGT *string

+ TickerGTE *string

+ TickerLT *string

+ TickerLTE *string

+ func (p ListDividendsParams) WithCashAmount(c Comparator, q float64) *ListDividendsParams

+ func (p ListDividendsParams) WithDeclarationDate(c Comparator, q Date) *ListDividendsParams

+ func (p ListDividendsParams) WithDividendType(q DividendType) *ListDividendsParams

+ func (p ListDividendsParams) WithExDividendDate(c Comparator, q Date) *ListDividendsParams

+ func (p ListDividendsParams) WithFrequency(q Frequency) *ListDividendsParams

+ func (p ListDividendsParams) WithLimit(q int) *ListDividendsParams

+ func (p ListDividendsParams) WithOrder(q Order) *ListDividendsParams

+ func (p ListDividendsParams) WithSort(q Sort) *ListDividendsParams

+ func (p ListDividendsParams) WithTicker(c Comparator, q string) *ListDividendsParams

+ type ListDividendsResponse struct

+ Results []Dividend

+ type ListQuotesParams struct

+ Limit *int

+ Order *Order

+ Sort *Sort

+ Ticker string

+ TimestampEQ *Nanos

+ TimestampGT *Nanos

+ TimestampGTE *Nanos

+ TimestampLT *Nanos

+ TimestampLTE *Nanos

+ func (p ListQuotesParams) WithLimit(q int) *ListQuotesParams

+ func (p ListQuotesParams) WithOrder(q Order) *ListQuotesParams

+ func (p ListQuotesParams) WithSort(q Sort) *ListQuotesParams

+ func (p ListQuotesParams) WithTimestamp(c Comparator, q Nanos) *ListQuotesParams

+ type ListQuotesResponse struct

+ Results []Quote

+ type ListResponse interface

+ NextPageURL func() string

+ type ListSplitsParams struct

+ ExecutionDateEQ *Date

+ ExecutionDateGT *Date

+ ExecutionDateGTE *Date

+ ExecutionDateLT *Date

+ ExecutionDateLTE *Date

+ Limit *int

+ Order *Order

+ ReverseSplit *bool

+ Sort *Sort

+ TickerEQ *string

+ TickerGT *string

+ TickerGTE *string

+ TickerLT *string

+ TickerLTE *string

+ func (p ListSplitsParams) WithExecutionDate(c Comparator, q Date) *ListSplitsParams

+ func (p ListSplitsParams) WithLimit(q int) *ListSplitsParams

+ func (p ListSplitsParams) WithOrder(q Order) *ListSplitsParams

+ func (p ListSplitsParams) WithReverseSplit(q bool) *ListSplitsParams

+ func (p ListSplitsParams) WithSort(q Sort) *ListSplitsParams

+ func (p ListSplitsParams) WithTicker(c Comparator, q string) *ListSplitsParams

+ type ListSplitsResponse struct

+ Results []Split

+ type ListTickersParams struct

+ Active *bool

+ CIK *int

+ CUSIP *int

+ Date *Date

+ Exchange *int

+ Limit *int

+ Market *AssetClass

+ Order *Order

+ PageMarker *string

+ Search *string

+ Sort *Sort

+ TickerEQ *string

+ TickerGT *string

+ TickerGTE *string

+ TickerLT *string

+ TickerLTE *string

+ Type *string

+ func (p ListTickersParams) WithActive(q bool) *ListTickersParams

+ func (p ListTickersParams) WithCIK(q int) *ListTickersParams

+ func (p ListTickersParams) WithCUSIP(q int) *ListTickersParams

+ func (p ListTickersParams) WithDate(q Date) *ListTickersParams

+ func (p ListTickersParams) WithExchange(q int) *ListTickersParams

+ func (p ListTickersParams) WithLimit(q int) *ListTickersParams

+ func (p ListTickersParams) WithMarket(q AssetClass) *ListTickersParams

+ func (p ListTickersParams) WithOrder(q Order) *ListTickersParams

+ func (p ListTickersParams) WithPageMarker(q string) *ListTickersParams

+ func (p ListTickersParams) WithSearch(q string) *ListTickersParams

+ func (p ListTickersParams) WithSort(q Sort) *ListTickersParams

+ func (p ListTickersParams) WithTicker(c Comparator, q string) *ListTickersParams

+ func (p ListTickersParams) WithType(q string) *ListTickersParams

+ type ListTickersResponse struct

+ Results []Ticker

+ type ListTradesParams struct

+ Limit *int

+ Order *Order

+ Sort *Sort

+ Ticker string

+ TimestampEQ *Nanos

+ TimestampGT *Nanos

+ TimestampGTE *Nanos

+ TimestampLT *Nanos

+ TimestampLTE *Nanos

+ func (p ListTradesParams) WithLimit(q int) *ListTradesParams

+ func (p ListTradesParams) WithOrder(q Order) *ListTradesParams

+ func (p ListTradesParams) WithSort(q Sort) *ListTradesParams

+ func (p ListTradesParams) WithTimestamp(c Comparator, q Nanos) *ListTradesParams

+ type ListTradesResponse struct

+ Results []Trade

+ type MarketHoliday struct

+ Close *Time

+ Date *Date

+ Exchange string

+ Name string

+ Open *Time

+ Status string

+ type MarketLocale string

+ const Global

+ const US

+ type MarketType string

+ const Crypto

+ const Forex

+ const Stocks

+ type Millis time.Time

+ func (m *Millis) MarshalJSON() ([]byte, error)

+ func (m *Millis) UnmarshalJSON(data []byte) error

+ type MinuteSnapshot struct

+ AccumulatedVolume int

+ Close float64

+ High float64

+ Low float64

+ Open float64

+ Volume float64

+ VolumeWeightedAverage float64

+ type Nanos time.Time

+ func (n *Nanos) MarshalJSON() ([]byte, error)

+ func (n *Nanos) UnmarshalJSON(data []byte) error

+ type OptionContractSnapshot struct

+ BreakEvenPrice float64

+ Day DayOptionContractSnapshot

+ Details OptionDetails

+ Greeks Greeks

+ ImpliedVolatility float64

+ LastQuote LastQuoteOptionContractSnapshot

+ OpenInterest float64

+ UnderlyingAsset UnderlyingAsset

+ type OptionDetails struct

+ ContractType string

+ ExerciseStyle string

+ ExpirationDate *Date

+ SharesPerContract float64

+ StrikePrice float64

+ Ticker string

+ type Order string

+ const Asc

+ const Desc

+ type OrderBookQuote struct

+ ExchangeToShares map[string]float64

+ Price float64

+ type PaginationHooks struct

+ NextURL string

+ func (p PaginationHooks) NextPageURL() string

+ type Query func(string) (ListResponse, []interface{}, error)

+ type Quote struct

+ AskExchange int

+ AskPrice float64

+ AskSize float64

+ BidExchange int

+ BidPrice float64

+ BidSize float64

+ Conditions []int32

+ Indicators []int32

+ ParticipantTimestamp *Nanos

+ SequenceNumber *Nanos

+ SipTimestamp *Nanos

+ Tape int32

+ TrfTimestamp *Nanos

+ type RequestOption func(o *RequestOptions)

+ func APIKey(id string) RequestOption

+ func Header(key, value string) RequestOption

+ func QueryParam(key, value string) RequestOption

+ type RequestOptions struct

+ APIKey *string

+ Headers http.Header

+ QueryParams url.Values

+ type Resolution string

+ const Day

+ const Hour

+ const Minute

+ const Month

+ const Quarter

+ const Week

+ const Year

+ type SIP string

+ const CTA

+ const OPRA

+ const UTP

+ type SnapshotTickerFullBook struct

+ AskCount float64

+ Asks []OrderBookQuote

+ BidCount float64

+ Bids []OrderBookQuote

+ Spread float64

+ Ticker string

+ Updated *Nanos

+ type Sort string

+ const BaseCurrencyName

+ const BaseCurrencySymbol

+ const CIK

+ const CompositeFIGI

+ const CurrencyName

+ const CurrencySymbol

+ const DelistedUTC

+ const LastUpdatedUTC

+ const Locale

+ const Market

+ const Name

+ const PrimaryExchange

+ const ShareClassFIGI

+ const TickerSymbol

+ const Timestamp

+ const Type

+ type Split struct

+ ExecutionDate string

+ SplitFrom int64

+ SplitTo int64

+ Ticker string

+ type Ticker struct

+ Active bool

+ Address *CompanyAddress

+ BaseCurrencyName string

+ BaseCurrencySymbol string

+ Branding *Branding

+ CIK string

+ CUSIP string

+ CompositeFIGI string

+ CurrencyName string

+ CurrencySymbol string

+ DelistedUTC int64

+ Description string

+ HomepageURL string

+ LastUpdatedUTC time.Time

+ ListDate string

+ Locale string

+ Market string

+ MarketCap float64

+ Name string

+ PhoneNumber string

+ PrimaryExchange string

+ SICCode string

+ SICDescription string

+ ShareClassFIGI string

+ ShareClassSharesOutstanding int64

+ Ticker string

+ TickerRoot string

+ TickerSuffix string

+ TotalEmployees int32

+ Type string

+ WeightedSharesOutstanding int64

+ type TickerSnapshot struct

+ Day DaySnapshot

+ LastQuote LastQuoteSnapshot

+ LastTrade LastTradeSnapshot

+ Minute MinuteSnapshot

+ PrevDay DaySnapshot

+ Ticker string

+ TodaysChange float64

+ TodaysChangePerc float64

+ Updated *Nanos

+ type TickerType struct

+ AssetClass string

+ Code string

+ Description string

+ Locale string

+ type Time time.Time

+ func (t *Time) MarshalJSON() ([]byte, error)

+ func (t *Time) UnmarshalJSON(data []byte) error

+ type Trade struct

+ Conditions []int32

+ Correction int

+ Exchange int

+ ID string

+ ParticipantTimestamp *Nanos

+ Price float64

+ SequenceNumber int64

+ SipTimestamp *Nanos

+ Size float64

+ Tape int32

+ TrfID int

+ TrfTimestamp *Nanos

+ type UnderlyingAsset struct

+ ChangeToBreakEven float64

+ LastUpdated int64

+ Price float64

+ Ticker string

+ Timeframe string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL