client

package module

Go to main page

Versions in this module

v1

v1.2.0

May 2, 2024

Changes in this version

+ type FundCandlesRequest struct

+ func FundCandles() *FundCandlesRequest

+ func (cr *FundCandlesRequest) Resolution(q string) *FundCandlesRequest

+ func (fcr *FundCandlesRequest) AdjustSplits(q bool) *FundCandlesRequest

+ func (fcr *FundCandlesRequest) Countback(q int) *FundCandlesRequest

+ func (fcr *FundCandlesRequest) Date(q interface{}) *FundCandlesRequest

+ func (fcr *FundCandlesRequest) From(q interface{}) *FundCandlesRequest

+ func (fcr *FundCandlesRequest) Get() ([]models.Candle, error)

+ func (fcr *FundCandlesRequest) Packed() (*models.FundCandlesResponse, error)

+ func (fcr *FundCandlesRequest) Raw() (*resty.Response, error)

+ func (fcr *FundCandlesRequest) Symbol(q string) *FundCandlesRequest

+ func (fcr *FundCandlesRequest) To(q interface{}) *FundCandlesRequest

type OptionChainRequest

+ func (ocr *OptionChainRequest) MaxAsk(maxAsk float64) *OptionChainRequest

+ func (ocr *OptionChainRequest) MaxBid(maxBid float64) *OptionChainRequest

+ func (ocr *OptionChainRequest) MinAsk(minAsk float64) *OptionChainRequest

+ func (ocr *OptionChainRequest) MinBid(minBid float64) *OptionChainRequest

v1.1.0

Feb 20, 2024

Changes in this version

+ type Environment string

+ const Development

+ const Production

+ const Test

+ type LogEntry struct

+ Delay int64

+ RateLimitConsumed int

+ RayID string

+ Request string

+ RequestHeaders http.Header

+ Response string

+ ResponseHeaders http.Header

+ Status int

+ Timestamp time.Time

+ func (l LogEntry) PrettyPrint()

+ func (l LogEntry) String() string

type MarketDataClient

+ func (c *MarketDataClient) Timeout(seconds int)

+ type MarketDataLogs struct

+ ClientErrorLogger *zap.Logger

+ Logs []LogEntry

+ MaxEntries int

+ MemoryLimit int64

+ ServerErrorLogger *zap.Logger

+ SuccessLogger *zap.Logger

+ func (l *MarketDataLogs) LatestString() string

+ func (l *MarketDataLogs) PrintLatest()

+ func (l *MarketDataLogs) String() string

+ type OptionStrikesRequest struct

+ func OptionStrikes() *OptionStrikesRequest

+ func (o *OptionStrikesRequest) Date(date interface{}) *OptionStrikesRequest

+ func (o *OptionStrikesRequest) Expiration(expiration string) *OptionStrikesRequest

+ func (o *OptionStrikesRequest) UnderlyingSymbol(underlyingSymbol string) *OptionStrikesRequest

+ func (osr *OptionStrikesRequest) Get() ([]models.OptionStrikes, error)

+ func (osr *OptionStrikesRequest) Packed() (*models.OptionStrikesResponse, error)

+ func (osr *OptionStrikesRequest) Raw() (*resty.Response, error)

v1.0.0

Feb 8, 2024

Changes in this version

+ type BulkStockCandlesRequest struct

+ func BulkStockCandles(client ...*MarketDataClient) *BulkStockCandlesRequest

+ func (bscr *BulkStockCandlesRequest) AdjustSplits(q bool) *BulkStockCandlesRequest

+ func (bscr *BulkStockCandlesRequest) Date(q interface{}) *BulkStockCandlesRequest

+ func (bscr *BulkStockCandlesRequest) Get(optionalClients ...*MarketDataClient) ([]models.Candle, error)

+ func (bscr *BulkStockCandlesRequest) Packed(optionalClients ...*MarketDataClient) (*models.BulkStockCandlesResponse, error)

+ func (bscr *BulkStockCandlesRequest) Snapshot(q bool) *BulkStockCandlesRequest

+ func (cr *BulkStockCandlesRequest) Resolution(q string) *BulkStockCandlesRequest

+ func (cr *BulkStockCandlesRequest) Symbols(q []string) *BulkStockCandlesRequest

+ func (request BulkStockCandlesRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type BulkStockQuotesRequest struct

+ func BulkStockQuotes(client ...*MarketDataClient) *BulkStockQuotesRequest

+ func (bs *BulkStockQuotesRequest) Get(optionalClients ...*MarketDataClient) ([]models.StockQuote, error)

+ func (bs *BulkStockQuotesRequest) Packed(optionalClients ...*MarketDataClient) (*models.StockQuotesResponse, error)

+ func (bs *BulkStockQuotesRequest) Snapshot(q bool) *BulkStockQuotesRequest

+ func (bs *BulkStockQuotesRequest) Symbols(q []string) *BulkStockQuotesRequest

+ func (request BulkStockQuotesRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type StockTickersRequestV2 struct

+ func (request StockTickersRequestV2) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ func (str *StockTickersRequestV2) DateKey(q string) *StockTickersRequestV2

+ func (str *StockTickersRequestV2) Get() ([]models.Ticker, error)

+ func (str *StockTickersRequestV2) Packed() (*models.TickersResponse, error)

v0

v0.1.0

Feb 6, 2024

Changes in this version

+ const Version

+ var ClientErrorLogger *zap.Logger

+ var Logs *HttpRequestLogs

+ var MaxLogEntries = 100000

+ var MemoryLimit int64 = 100 * 1048576

+ var ServerErrorLogger *zap.Logger

+ var SuccessLogger *zap.Logger

+ type HttpRequestLog struct

+ Delay int64

+ RateLimitConsumed int

+ RayID string

+ ReqHeaders http.Header

+ Request string

+ ResHeaders http.Header

+ Response string

+ Status int

+ Timestamp time.Time

+ func AddToLog(h *HttpRequestLogs, timestamp time.Time, rayID string, request string, ...) *HttpRequestLog

+ func NewHttpRequestLog(timestamp time.Time, rayID string, request string, rateLimitConsumed int, ...) HttpRequestLog

+ func (h HttpRequestLog) PrettyPrint()

+ func (h HttpRequestLog) String() string

+ func (h HttpRequestLog) WriteToLog(debug bool)

+ type HttpRequestLogs struct

+ Logs []HttpRequestLog

+ func GetLogs() *HttpRequestLogs

+ func (h *HttpRequestLogs) GetLastLogResponse() string

+ func (h *HttpRequestLogs) PrintLatest()

+ func (h *HttpRequestLogs) String() string

+ type IndexQuoteRequest struct

+ func IndexQuotes(client ...*MarketDataClient) *IndexQuoteRequest

+ func (iqr *IndexQuoteRequest) FiftyTwoWeek(q bool) *IndexQuoteRequest

+ func (iqr *IndexQuoteRequest) Get(optionalClients ...*MarketDataClient) ([]models.IndexQuote, error)

+ func (iqr *IndexQuoteRequest) Packed(optionalClients ...*MarketDataClient) (*models.IndexQuotesResponse, error)

+ func (iqr *IndexQuoteRequest) Symbol(q string) *IndexQuoteRequest

+ func (request IndexQuoteRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type IndicesCandlesRequest struct

+ func IndexCandles(client ...*MarketDataClient) *IndicesCandlesRequest

+ func (icr *IndicesCandlesRequest) Countback(q int) *IndicesCandlesRequest

+ func (icr *IndicesCandlesRequest) Date(q interface{}) *IndicesCandlesRequest

+ func (icr *IndicesCandlesRequest) From(q interface{}) *IndicesCandlesRequest

+ func (icr *IndicesCandlesRequest) Get(optionalClients ...*MarketDataClient) ([]models.IndexCandle, error)

+ func (icr *IndicesCandlesRequest) Packed(optionalClients ...*MarketDataClient) (*models.IndicesCandlesResponse, error)

+ func (icr *IndicesCandlesRequest) Resolution(q string) *IndicesCandlesRequest

+ func (icr *IndicesCandlesRequest) Symbol(q string) *IndicesCandlesRequest

+ func (icr *IndicesCandlesRequest) To(q interface{}) *IndicesCandlesRequest

+ func (request IndicesCandlesRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type MarketDataClient struct

+ Error error

+ RateLimitLimit int

+ RateLimitRemaining int

+ RateLimitReset time.Time

+ func GetClient(token ...string) (*MarketDataClient, error)

+ func NewClient() *MarketDataClient

+ func (c *MarketDataClient) Debug(enable bool) *MarketDataClient

+ func (c *MarketDataClient) Environment(env string) *MarketDataClient

+ func (c *MarketDataClient) GetFromRequest(br *baseRequest, result interface{}) (*resty.Response, error)

+ func (c *MarketDataClient) GetRawResponse(br *baseRequest) (*resty.Response, error)

+ func (c *MarketDataClient) RateLimitExceeded() bool

+ func (c *MarketDataClient) String() string

+ func (c *MarketDataClient) Token(bearerToken string) *MarketDataClient

+ type MarketDataPacked interface

+ IsValid func() bool

+ Unpack func() any

+ type MarketStatusRequest struct

+ func MarketStatus(clients ...*MarketDataClient) *MarketStatusRequest

+ func (msr *MarketStatusRequest) Countback(q int) *MarketStatusRequest

+ func (msr *MarketStatusRequest) Country(q string) *MarketStatusRequest

+ func (msr *MarketStatusRequest) Date(q interface{}) *MarketStatusRequest

+ func (msr *MarketStatusRequest) From(q interface{}) *MarketStatusRequest

+ func (msr *MarketStatusRequest) Get(optionalClients ...*MarketDataClient) ([]models.MarketStatusReport, error)

+ func (msr *MarketStatusRequest) Packed(optionalClients ...*MarketDataClient) (*models.MarketStatusResponse, error)

+ func (msr *MarketStatusRequest) To(q interface{}) *MarketStatusRequest

+ func (request MarketStatusRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type OptionChainRequest struct

+ func OptionChain(client ...*MarketDataClient) *OptionChainRequest

+ func (ocr *OptionChainRequest) DTE(dte int) *OptionChainRequest

+ func (ocr *OptionChainRequest) Date(q interface{}) *OptionChainRequest

+ func (ocr *OptionChainRequest) Delta(delta float64) *OptionChainRequest

+ func (ocr *OptionChainRequest) Expiration(q interface{}) *OptionChainRequest

+ func (ocr *OptionChainRequest) Get(optionalClients ...*MarketDataClient) ([]models.OptionQuote, error)

+ func (ocr *OptionChainRequest) MaxBidAskSpread(maxBidAskSpread float64) *OptionChainRequest

+ func (ocr *OptionChainRequest) MaxBidAskSpreadPct(maxBidAskSpreadPct float64) *OptionChainRequest

+ func (ocr *OptionChainRequest) MinOpenInterest(minOpenInterest int) *OptionChainRequest

+ func (ocr *OptionChainRequest) MinVolume(minVolume int) *OptionChainRequest

+ func (ocr *OptionChainRequest) Month(month int) *OptionChainRequest

+ func (ocr *OptionChainRequest) Monthly(monthly bool) *OptionChainRequest

+ func (ocr *OptionChainRequest) Nonstandard(nonstandard bool) *OptionChainRequest

+ func (ocr *OptionChainRequest) Packed(optionalClients ...*MarketDataClient) (*models.OptionQuotesResponse, error)

+ func (ocr *OptionChainRequest) Quarterly(quarterly bool) *OptionChainRequest

+ func (ocr *OptionChainRequest) Range(rangeParam string) *OptionChainRequest

+ func (ocr *OptionChainRequest) Side(side string) *OptionChainRequest

+ func (ocr *OptionChainRequest) Strike(strike float64) *OptionChainRequest

+ func (ocr *OptionChainRequest) StrikeLimit(strikeLimit int) *OptionChainRequest

+ func (ocr *OptionChainRequest) UnderlyingSymbol(q string) *OptionChainRequest

+ func (ocr *OptionChainRequest) Weekly(weekly bool) *OptionChainRequest

+ func (ocr *OptionChainRequest) Year(year int) *OptionChainRequest

+ func (request OptionChainRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type OptionLookupRequest struct

+ func OptionLookup(client ...*MarketDataClient) *OptionLookupRequest

+ func (o *OptionLookupRequest) Get(optionalClients ...*MarketDataClient) (string, error)

+ func (o *OptionLookupRequest) Packed(optionalClients ...*MarketDataClient) (*models.OptionLookupResponse, error)

+ func (o *OptionLookupRequest) UserInput(userInput string) *OptionLookupRequest

+ func (request OptionLookupRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type OptionQuoteRequest struct

+ func OptionQuote(client ...*MarketDataClient) *OptionQuoteRequest

+ func (oqr *OptionQuoteRequest) Date(q interface{}) *OptionQuoteRequest

+ func (oqr *OptionQuoteRequest) From(q interface{}) *OptionQuoteRequest

+ func (oqr *OptionQuoteRequest) Get(optionalClients ...*MarketDataClient) ([]models.OptionQuote, error)

+ func (oqr *OptionQuoteRequest) OptionSymbol(q string) *OptionQuoteRequest

+ func (oqr *OptionQuoteRequest) Packed(optionalClients ...*MarketDataClient) (*models.OptionQuotesResponse, error)

+ func (oqr *OptionQuoteRequest) To(q interface{}) *OptionQuoteRequest

+ func (request OptionQuoteRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type OptionsExpirationsRequest struct

+ func OptionsExpirations(client ...*MarketDataClient) *OptionsExpirationsRequest

+ func (o *OptionsExpirationsRequest) Get(optionalClients ...*MarketDataClient) ([]time.Time, error)

+ func (o *OptionsExpirationsRequest) Packed(optionalClients ...*MarketDataClient) (*models.OptionsExpirationsResponse, error)

+ func (o *OptionsExpirationsRequest) Strike(strike float64) *OptionsExpirationsRequest

+ func (o *OptionsExpirationsRequest) UnderlyingSymbol(symbol string) *OptionsExpirationsRequest

+ func (oer *OptionsExpirationsRequest) Date(q interface{}) *OptionsExpirationsRequest

+ func (request OptionsExpirationsRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type OptionsStrikesRequest struct

+ func OptionsStrikes(client ...*MarketDataClient) *OptionsStrikesRequest

+ func (o *OptionsStrikesRequest) Date(date string) *OptionsStrikesRequest

+ func (o *OptionsStrikesRequest) Expiration(expiration string) *OptionsStrikesRequest

+ func (o *OptionsStrikesRequest) UnderlyingSymbol(underlyingSymbol string) *OptionsStrikesRequest

+ func (osr *OptionsStrikesRequest) Get(optionalClients ...*MarketDataClient) ([]models.OptionsStrikes, error)

+ func (osr *OptionsStrikesRequest) Packed(optionalClients ...*MarketDataClient) (*models.OptionsStrikesResponse, error)

+ func (request OptionsStrikesRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ type StockCandlesRequest struct

+ func StockCandles(client ...*MarketDataClient) *StockCandlesRequest

+ func (cr *StockCandlesRequest) Resolution(q string) *StockCandlesRequest

+ func (cr *StockCandlesRequest) Symbol(q string) *StockCandlesRequest

+ func (request StockCandlesRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ func (scr *StockCandlesRequest) AdjustDividends(q bool) *StockCandlesRequest

+ func (scr *StockCandlesRequest) AdjustSplits(q bool) *StockCandlesRequest

+ func (scr *StockCandlesRequest) Countback(q int) *StockCandlesRequest

+ func (scr *StockCandlesRequest) Date(q interface{}) *StockCandlesRequest

+ func (scr *StockCandlesRequest) Exchange(q string) *StockCandlesRequest

+ func (scr *StockCandlesRequest) Extended(q bool) *StockCandlesRequest

+ func (scr *StockCandlesRequest) From(q interface{}) *StockCandlesRequest

+ func (scr *StockCandlesRequest) Get(optionalClients ...*MarketDataClient) ([]models.StockCandle, error)

+ func (scr *StockCandlesRequest) Packed(optionalClients ...*MarketDataClient) (*models.StockCandlesResponse, error)

+ func (scr *StockCandlesRequest) To(q interface{}) *StockCandlesRequest

+ type StockCandlesRequestV2 struct

+ func StockCandlesV2(client ...*MarketDataClient) *StockCandlesRequestV2

+ func (cr *StockCandlesRequestV2) DateKey(q string) *StockCandlesRequestV2

+ func (cr *StockCandlesRequestV2) Resolution(q string) *StockCandlesRequestV2

+ func (cr *StockCandlesRequestV2) Symbol(q string) *StockCandlesRequestV2

+ func (request StockCandlesRequestV2) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ func (scrV2 *StockCandlesRequestV2) Get(optionalClients ...*MarketDataClient) ([]models.StockCandle, error)

+ func (scrV2 *StockCandlesRequestV2) Packed(optionalClients ...*MarketDataClient) (*models.StockCandlesResponse, error)

+ type StockEarningsRequest struct

+ func StockEarnings(client ...*MarketDataClient) *StockEarningsRequest

+ func (request StockEarningsRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ func (ser *StockEarningsRequest) Countback(q int) *StockEarningsRequest

+ func (ser *StockEarningsRequest) Date(q interface{}) *StockEarningsRequest

+ func (ser *StockEarningsRequest) From(q interface{}) *StockEarningsRequest

+ func (ser *StockEarningsRequest) Get(optionalClients ...*MarketDataClient) ([]models.StockEarningsReport, error)

+ func (ser *StockEarningsRequest) Packed(optionalClients ...*MarketDataClient) (*models.StockEarningsResponse, error)

+ func (ser *StockEarningsRequest) Report(q string) *StockEarningsRequest

+ func (ser *StockEarningsRequest) Symbol(q string) *StockEarningsRequest

+ func (ser *StockEarningsRequest) To(q interface{}) *StockEarningsRequest

+ type StockNewsRequest struct

+ func StockNews(client ...*MarketDataClient) *StockNewsRequest

+ func (request StockNewsRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ func (snr *StockNewsRequest) Countback(q int) *StockNewsRequest

+ func (snr *StockNewsRequest) Date(q interface{}) *StockNewsRequest

+ func (snr *StockNewsRequest) From(q interface{}) *StockNewsRequest

+ func (snr *StockNewsRequest) Get(optionalClients ...*MarketDataClient) ([]models.StockNews, error)

+ func (snr *StockNewsRequest) Packed(optionalClients ...*MarketDataClient) (*models.StockNewsResponse, error)

+ func (snr *StockNewsRequest) Symbol(q string) *StockNewsRequest

+ func (snr *StockNewsRequest) To(q interface{}) *StockNewsRequest

+ type StockQuoteRequest struct

+ func StockQuote(client ...*MarketDataClient) *StockQuoteRequest

+ func (request StockQuoteRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ func (sqr *StockQuoteRequest) FiftyTwoWeek(q bool) *StockQuoteRequest

+ func (sqr *StockQuoteRequest) Get(optionalClients ...*MarketDataClient) ([]models.StockQuote, error)

+ func (sqr *StockQuoteRequest) Packed(optionalClients ...*MarketDataClient) (*models.StockQuotesResponse, error)

+ func (sqr *StockQuoteRequest) Symbol(q string) *StockQuoteRequest

+ type TickersRequest struct

+ func StockTickers(client ...*MarketDataClient) *TickersRequest

+ func (request TickersRequest) Raw(optionalClients ...*MarketDataClient) (*resty.Response, error)

+ func (tr *TickersRequest) DateKey(q string) *TickersRequest

+ func (tr *TickersRequest) Get() ([]models.Ticker, error)

+ func (tr *TickersRequest) Packed() (*models.TickersResponse, error)

v0.0.5

Feb 5, 2024

v0.0.4

Jan 9, 2024

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