README.md

go-iex

ATTRIBUTION

Data provided by IEX

DESCRIPTION

Client interface to IEX trading API.

ENV

TEST

• Grab your test/real tokens from https://iexcloud.io/console/
• Set ENV VAR

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