Categorygithub.com/jonwho/go-iex/v4
modulepackage
4.2.0
Repository: https://github.com/jonwho/go-iex.git
Documentation: pkg.go.dev
Overview
Versions
6
Dependencies
11
Dependents
2
Files
3.1k SLOC

# README

go-iex

GoDoc releases Go Report Card gopherbadger-tag-do-not-edit

ATTRIBUTION

Data provided by IEX

DESCRIPTION

Client interface to IEX trading API.

ENV

TEST

export IEX_TEST_SECRET_TOKEN=Tsk_ahsvyao12u4u0ausvn1o3rhw988120yf_FAKE
export IEX_TEST_PUBLISHABLE_TOKEN=Tpk_la091720ihakbso128uihotbfao_FAKE

PRODUCTION

export IEX_SECRET_TOKEN=Tsk_ahsvyao12u4u0ausvn1o3rhw988120yf_REAL
export IEX_PUBLISHABLE_TOKEN=Tpk_la091720ihakbso128uihotbfao_REAL

DEV NOTES

  • Use this online json to struct converter to save time
  • Use make test to run test suite
  • Use make coverage to update README.md coverage badge (install coverage tool first go get github.com/jpoles1/gopherbadger)

USAGE

See examples/

SUPPORTED ENDPOINTS

Expand to see supported endpoints

Introduction

  • Batch Requests

Account

  • Metadata
  • Usage
  • Pay as you go
  • Message Budget
  • Signed Requests
  • Setting up signed token
  • Getting the secret for a signed token

API System Metadata

  • Status

Data APIS

  • Data Points
  • Data Tables
  • Time Series

Stock Prices

  • Book
  • Charts
  • Delayed Quote
  • Extended Hours Quote (included as part of Quote response)
  • Historical Prices
  • Intraday Prices
  • Largest Trades
  • Open / Close Price
  • OHLC
  • Previous Day Price
  • Price Only
  • Quote
  • Real-time Quote (included as part of Quote response)
  • Volume by Venue

Stock Profiles

  • Company
  • Insider Roster
  • Insider Summary
  • Insider Transactions
  • Logo
  • Peer Groups

Stock Fundamentals

  • Balance Sheet
  • Cash Flow
  • Dividends (Basic)
  • Earnings
  • Financials
  • Financials As Reported
  • Income Statement
  • SEC Filings
  • Splits (Basic)

Stock Research

  • Advanced Stats
  • Analyst Recommendations (see RecommendationTrends)
  • Estimates
  • Fund Ownership
  • Institutional Ownership
  • Key Stats
  • Price Target
  • Technical Indicators

Corporate Actions

  • Bonus Issue
  • Distribution
  • Dividends
  • Return of Capital
  • Rights Issue
  • Right to Purchase
  • Security Reclassification
  • Security Swap
  • Spinoff
  • Splits

Market Info

  • Collections
  • Earnings Today
  • IPO Calendar
  • List
  • Market Volume (U.S.)
  • Sector Performance
  • Upcoming Events

News

  • News
  • Streaming News
  • Historical News

Cryptocurrency

  • Cryptocurrency Book
  • Cryptocurrency Event
  • Cryptocurrency Price
  • Cryptocurrency Quote

Forex / Currencies

  • Real-time Streaming
  • Latest Currency Rates
  • Currency Conversion
  • Historical Daily

Options

  • End of Day Options

Social Sentiment

  • Social Sentiment

CEO Compensation

  • CEO Compensation

Treasures

  • Daily Treasury Rates

Commodities

  • Oil Prices
  • Natural Gas Price
  • Heating Oil Prices
  • Jet Fuel Prices
  • Diesel Prices
  • Diesel Price
  • Gas Prices
  • Propane Prices

Economic Data

  • CD Rates
  • Consumer Price Index
  • Credit Card Interest Rate
  • Federal Fund Rates
  • Real GDP
  • Institutional Money Funds
  • Initial Claims
  • Industrial Production Index
  • Mortgage Rates
  • Total Housing Starts
  • Total Payrolls
  • Total Vehicle Sales
  • Retail Money Funds
  • Unemployment Rate
  • US Recession Probabilities

Reference Data

  • Search
  • Cryptocurrency Symbols
  • FX Symbols
  • IEX Symbols
  • International Symbols
  • International Exchanges
  • ISIN Mapping
  • Mutual Fund Symbols
  • Options Symbols
  • OTC Symbols
  • Sectors
  • Symbols
  • Tags
  • U.S. Exchanges
  • U.S. Holidays and Trading Dates

Investors Exchange Data

  • DEEP
  • DEEP Auction
  • DEEP Book
  • DEEP Operational Halt Status
  • DEEP Official Price
  • DEEP Security Event
  • DEEP Short Sale Price Test Status
  • DEEP System Event
  • DEEP Trades
  • DEEP Trade Break
  • DEEP Trading Status
  • Last
  • Listed Regulation SHO Threshold Securities List
  • Listed Short Interest List In Dev
  • Stats Historical Daily In Dev
  • Stats Historical Summary
  • Stats Intraday
  • Stats Recent
  • Stats Records
  • TOPS

# Packages

No description provided by the author
No description provided by the author

# Functions

DefaultBackoff defines the wait time as a exponential backoff.
DefaultRetryPolicy defines a retry on status codes 0, 429, and >= 500.
NewAccount return new Account.
NewAPISystemMetadata return new APISystemMetadata.
NewClient creates client interface to IEX Cloud APIs.
NewCommodities return new Commodities.
NewCryptocurrency returns new Cryptocurrency.
NewDataAPI return new DataAPI.
NewEconomicData return new EconomicData.
NewForex return new Forex.
NewInvestorsExchangeData return new InvestorsExchangeData.
NewReferenceData return new ReferenceData.
NewRequest constructor to build *Request.
NewRetry returns a struct that can retry a HTTP request defined by the RetryPolicy and Backoff.
NewSandboxClient creates sandbox client interface to IEX Cloud APIs.
NewStock return new Stock.
SetAccount set new Account.
SetAPISystemMetadata set new APISystemMetadata.
SetAPIURL assigns API URL.
SetBackoff sets the Backoff that defines how long to wait between HTTP request retries.
SetClientRetry enables HTTP request retries with default Retry or first Retry parameter given method ignores all other Retry in variadic param.
SetCommodities set new Commodities.
SetCryptocurrency set new Cryptocurrency.
SetDataAPI set new DataAPI.
SetEconomicData set new EconomicData.
SetForex set new Forex.
SetHTTPClient assigns HTTP client.
SetInvestorsExchangeData set new InvestorsExchangeData.
SetReferenceData set new ReferenceData.
SetRetry assigns the.
SetRetryAttempts sets the max number of retry attempts.
SetRetryPolicy sets the RetryPolicy that defines when to retry a HTTP request.
SetRetryWaitMinMax sets the min and max time.Duration that a retry request is bounded by.
SetStock set new Stock.
SetToken assigns secret token.
SetURL assigns URL base.
SetVersion set IEX version.

# Constants

ABS Vector Absolute Value.
ACOS Vector Arccosine.
AD Accumulation/Distribution Line.
ADD Vector Addition.
ADOSC Accumulation/Distribution Oscillator.
ADX Average Directional Movement Index.
ADXR Average Directional Movement Rating.
AO Awesome Oscillator.
APO Absolute Price Oscillator.
AROON Aroon.
AROONOSC Aroon Oscillator.
ASIN Vector Arcsine.
ATAN Vector Arctangent.
ATR Average True Range.
AVGPRICE Average Price.
BBANDS Bollinger Bands.
BOP Balance of Power.
CCI Commodity Channel Index.
CEIL Vector Ceiling.
ChartRangeFiveYear chart range.
ChartRangeMax chart range.
ChartRangeOneDay chart range.
ChartRangeOneMonth chart range.
ChartRangeOneYear chart range.
ChartRangeSixMonth chart range.
ChartRangeThreeMonth chart range.
ChartRangeTwoYear chart range.
ChartRangeYearToDate chart range.
CMO Change Momentum Oscillator.
CollectionList for lists.
CollectionSector for sectors.
CollectionTag for tags.
COS Vector Cosine.
COSH Vector Hyperbolic Cosine.
CROSSANY Crossany.
CROSSOVER Crossover.
CVI Chaikins Volatility.
DECAY Linear Decay.
DefaultBaseURL default base URL.
DefaultVersion default IEX API version.
DEMA Double Exponential Moving Average.
DI Directional Indicator.
DIV Vector Division.
DividendRangeFiveYear dividend range.
DividendRangeNext dividend range.
DividendRangeOneMonth dividend range.
DividendRangeOneYear dividend range.
DividendRangeSixMonth dividend range.
DividendRangeThreeMonth dividend range.
DividendRangeTwoYear dividend range.
DividendRangeYearToDate dividend range.
DM Directional Movement.
DPO Detrended Price Oscillator.
DX Directional Movement Index.
EDECAY Exponential Decay.
EMA Exponential Moving Average.
EMV Ease of Movement.
EXP Vector Exponential.
FISHER Fisher Transform.
FLOOR Vector Floor.
FOSC Forecast Oscillator.
HMA Hull Moving Average.
KAMA Kaufman Adaptive Moving Average.
KVO Klinger Volume Oscillator.
LAG Lag.
LINREG Linear Regression.
LINREGINTERCEPT Linear Regression Intercept.
LINREGSLOPE Linear Regression Slope.
LN Vector Natural Log.
LOG10 Vector Base-10 Log.
MACD Moving Average Convergence/Divergence.
MARKETFI Market Facilitation Index.
MASS Mass Index.
MAX Maximum In Period.
MD Mean Deviation Over Period.
MEDPRICE Median Price.
MFI Money Flow Index.
MIN Minimum In Period.
MOM Momentum.
MSW Mesa Sine Wave.
MUL Vector Multiplication.
NATR Normalized Average True Range.
NVI Negative Volume Index.
OBV On Balance Volume.
PeriodAnnual annual period.
PeriodQuarter quarter period.
PPO Percentage Price Oscillator.
PSAR Parabolic SAR.
PVI Positive Volume Index.
QSTICK Qstick.
ROC Rate of Change.
ROCR Rate of Change Ratio.
ROUND Vector Round.
RSI Relative Strength Index.
SandboxBaseURL use this as URL base if you do not want your account message limits affected on IEX cloud.
SIN Vector Sine.
SINH Vector Hyperbolic Sine.
SMA Simple Moving Average.
SplitRangeFiveYear split range.
SplitRangeNext split range.
SplitRangeOneMonth split range.
SplitRangeOneYear split range.
SplitRangeSixMonth split range.
SplitRangeThreeMonth split range.
SplitRangeTwoYear split range.
SplitRangeYearToDate split range.
SQRT Vector Square Root.
STDDEV Standard Deviation Over Period.
STOCH Stochastic Oscillator.
STOCHRSI Stochastic RSI.
SUB Vector Subtraction.
SUM Sum Over Period.
TAN Vector Tangent.
TANH Vector Hyperbolic Tangent.
TechnicalIndicatorRangeFiveYear chart range.
TechnicalIndicatorRangeMax chart range.
TechnicalIndicatorRangeOneDay chart range.
TechnicalIndicatorRangeOneMonth chart range.
TechnicalIndicatorRangeOneYear chart range.
TechnicalIndicatorRangeSixMonth chart range.
TechnicalIndicatorRangeThreeMonth chart range.
TechnicalIndicatorRangeTwoYear chart range.
TechnicalIndicatorRangeYearToDate chart range.
TEMA Triple Exponential Moving Average.
TODEG Vector Degree Conversion.
TORAD Vector Radian Conversion.
TR True Range.
TRIMA Triangular Moving Average.
TRIX Trix.
TRUNC Vector Truncate.
TSF Time Series Forecast.
TYPPRICE Typical Price.
ULTOSC Ultimate Oscillator.
VAR Variance Over Period.
VHF Vertical Horizontal Filter.
VIDYA Variable Index Dynamic Average.
VOLATILITY Annualized Historical Volatility.
VOSC Volume Oscillator.
VWMA Volume Weighted Moving Average.
WAD Williams Accumulation/Distribution.
WCPRICE Weight Close Price.
WILDERS Wilders Smoothing.
WILLR Williams %R.
WMA Weighted Moving Average.
ZLEMA Zero-Lag Exponential Moving Average.

# Structs

Account struct to interface with /account endpoints.
AdvancedStat struct.
APISystemMetadata struct to interface with / endpoints.
BalanceSheet struct.
BalanceSheetParams query parameters.
Batch struct.
Book struct.
CashFlow struct.
CashFlowQueryParams optional query parameters.
Chart struct.
ChartQueryParams optional query parameters.
Client API struct to IEX.
CollectionQueryParams required/optional query parameters.
Commodities struct to interface with /data-points endpoints.
Company struct.
CryptoBook struct.
Cryptocurrency struct to interface with / endpoints.
CryptoPrice struct.
CryptoQuote struct.
CurrencyConversionParams required/optional query parameters.
DataAPI struct to interface with DataAPI endpoints.
DataPoint struct.
DEEP struct.
DEEPParams required/optional query parameters.
DelayedQuote struct.
Earning DTO for APIs reporting earnings.
Earnings struct.
EarningsQueryParams required/optional query parameters.
EarningsToday struct.
EarningsTodayDTO struct.
EconomicData struct to interface with /data-points endpoints.
Estimates struct.
ExchangeRates struct.
Financials struct.
FinancialsQueryParams required/optional query params.
Forex struct to interface with Forex / Currencies endpoints.
FXSymbols struct.
HistoricalDailyParams required/optional query parameters.
IncomeStatement struct.
IncomeStatementQueryParams required/optional query parameters.
IntradayPricesQueryParams required/optional query parameters.
InvestorsExchangeData struct to interface with InvestorsExchangeData endpoints.
IPOCalendar struct.
KeyStat struct.
LastParams required/optional query parameters.
LatestCurrencyRatesParams required/optional query parameters.
ListQueryParams required/optional query parameters.
Logo struct.
Metadata struct.
OHLC struct.
Option struct.
OptionsSymbols struct.
PreviousDayPrice struct.
PriceTarget struct.
Quote struct.
QuoteQueryParams required/optional query parameters.
ReferenceData struct to interface with /ref-data endpoints.
Request wraps a *http.Request.
Retry implements Retryer.
Status struct.
Stock struct to interface with /stock endpoints.
SystemEvent struct.
TechnicalIndicator struct.
TechnicalIndicatorParams struct.
TOPSParams required/optional query parameters.
UpcomingEarningsQueryParams required/optional query parameters.
UpcomingEvents struct.
UpcomingEventsQueryParams required/optional query parameters.
Usage struct.

# Interfaces

Backoffer is the interface to define a wait time in Backoff method.
Retryer is the interface that defines methods to retry a HTTP request.
RetryPolicyer interface defines methods for when to retry.

# Type aliases

Asks struct.
Backoff defines the wait time between retry requests.
Bids struct.
ChartRange for Chart API.
ClientOption is a func that operates on *Client.
Collection struct.
CollectionType for Collection API.
CurrencyConversion struct.
DividendRange for Dividend API.
Dividends struct {.
FundOwnership struct.
HistoricalDaily struct.
IEXOption is a func that operates on *iex.
IEXSymbols struct.
IndicatorName for TechnicalIndicator API.
InsiderRoster struct.
InsiderSummary struct.
InsiderTransactions struct.
InstitutionalOwnership struct.
InternationalExchanges struct.
InternationalSymbols struct.
IntradayPrices struct.
LargestTrades struct.
Last struct.
LatestCurrencyRates struct.
MarketVolume struct.
MutualFundSymbols struct.
News struct.
OTCSymbols struct.
PeriodQueryParameter accepted values for query parameter `period`.
RecommendationTrends struct.
RetryOption is a func that operations on *Retry.
RetryPolicy is a func type that defines when to retry a http request.
SectorPerformance struct.
Sectors struct.
SplitRange for Split API.
Splits struct.
Symbols struct.
Tags struct.
TechnicalIndicatorRange for TechnicalIndicator API.
TOPS struct.
Trades struct.
UpcomingEarnings struct.
USExchanges struct.
USHolidaysAndTradingDates struct.
VolumeByVenue struct.