Versions in this module Expand all Collapse all v0 v0.10.0 May 15, 2022 Changes in this version + 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 + IconURL string + LogoURL string + type CompanyAddress struct + Address1 string + Address2 string + City 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 Financial map[string]struct + 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 GetOptionContractDetailsParams struct + AsOf *Date + OptionTicker string + func (p GetOptionContractDetailsParams) WithAsOf(q Date) *GetOptionContractDetailsParams + type GetOptionContractDetailsResponse struct + Results OptionContract + 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 GetRealTimeCurrencyConversionParams struct + From string + To string + type GetRealTimeCurrencyConversionResponse struct + Converted float64 + From string + InitialAmount float64 + LastQuote ForexQuote + To 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 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 ListOptionContractsParams struct + AsOf *Date + ContractType *string + ExpirationDateEQ *Date + ExpirationDateGT *Date + ExpirationDateGTE *Date + ExpirationDateLT *Date + ExpirationDateLTE *Date + Expired *bool + StrikePriceEQ *float64 + StrikePriceGT *float64 + StrikePriceGTE *float64 + StrikePriceLT *float64 + StrikePriceLTE *float64 + TickerEQ *string + TickerGT *string + TickerGTE *string + TickerLT *string + TickerLTE *string + func (p ListOptionContractsParams) WithAsOf(q Date) *ListOptionContractsParams + func (p ListOptionContractsParams) WithContractType(q string) *ListOptionContractsParams + func (p ListOptionContractsParams) WithExpirationDate(c Comparator, q Date) *ListOptionContractsParams + func (p ListOptionContractsParams) WithExpired(q bool) *ListOptionContractsParams + func (p ListOptionContractsParams) WithStrikePrice(c Comparator, q float64) *ListOptionContractsParams + func (p ListOptionContractsParams) WithUnderlyingTicker(c Comparator, q string) *ListOptionContractsParams + type ListOptionContractsResponse struct + Results []OptionContract + 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 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 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 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 ListTickersParams struct + Active *bool + CIK *int + CUSIP *int + Date *Date + Exchange *int + Limit *int + Market *AssetClass + Order *Order + 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) 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 NameComparator string + const Full + const Search + type Nanos time.Time + func (n *Nanos) MarshalJSON() ([]byte, error) + func (n *Nanos) UnmarshalJSON(data []byte) error + type OptionContract struct + AdditionalUnderlyings []OptionContractAdditionalUnderlying + CFI string + ContractType string + ExerciseStyle string + ExpirationDate Date + PrimaryExchange string + SharesPerContract int + StrikePrice float64 + Ticker string + UnderLyingTicker string + type OptionContractAdditionalUnderlying struct + Amount float64 + Type string + Underlying string + 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) NextPage() string + type Publisher struct + FaviconURL string + HomepageURL string + LogoURL string + Name string + 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 PublishedUTC + const ShareClassFIGI + const TickerSymbol + const Timestamp + const Type + type Split struct + ExecutionDate string + SplitFrom int64 + SplitTo int64 + Ticker string + 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 Ticker struct + Active bool + Address CompanyAddress + Branding Branding + CIK string + CompositeFIGI string + CurrencyName string + DelistedUTC Time + Description string + HomepageURL string + LastUpdatedUTC Time + ListDate Date + 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 TickerNews struct + AMPURL string + ArticleURL string + Author string + Description string + ID string + ImageURL string + Keywords []string + PublishedUTC Time + Publisher Publisher + Tickers []string + Title string + 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 Timeframe string + const TFAnnual + const TFQuarterly + 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
Go to main page