ahtik / iexcloud

Go library for accessing the IEX Cloud API

iexcloud

Go library for accessing the IEX Cloud API.

Overview

iexcloud provides a Go interface to the IEX Cloud API. To access the IEX Cloud API an account and token are required. The goal is for iexcloud to be compatible with the v1 version of the IEX Cloud API. There were some changes from the beta version to v1 of the API, so things may still be a in flux for this library.

Installation

$ go get github.com/goinvest/iexcloud/v2

Examples

Examples are available at https://github.com/goinvest/iexcloud-examples/.

Implementation Status

Below is a list of the APIs that have and have not been implemented. If you want a particular API to be developed next, please open an issue.

Introduction

• Batch Requests

Guides

• Time Series
• Calendar
• Data Points
• Files

Rules Engine

• Rules Schema
• Lookup Values
• Creating a Rule
• Pause and Unpause
• Edit an Existing Rule
• Delete a Rule
• Get Rule Info
• List All Rules
• Getting Logged Outputs

Account

• Message Budget
• Metadata
• Pay as you go
• Signed Requests
• Usage

API System Metadata

• Status

Stock Prices

• Book
• Charts — Use historical and intraday price endpoints.
• Delayed Quote
• Extended Hours Quote — Use Quote.
• Historical Prices
• Intraday Prices
• Largest Trades
• Open / Close Price - Use OHLC.
• OHLC
• Previous Day Price
• Price Only
• Quote
• Real-time Quote — Use Quote.
• 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 — Use the Financials As Reported endpoint for raw SEC filings data.
• Splits (Basic)

Stock Research

• Advanced Stats
• Analyst Recommendations
• 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 Events
• 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

Treasuries

• Daily Treasury Rates

Commodities

• Oil Prices
• Natural Gas Price
• Heating Oil Prices
• Jet Fuel 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 Rates
• 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 Days

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
• Stats Historical Daily
• Stats Historical Summary
• Stats Intraday
• Stats Recent
• Stats Records
• TOPS

Wall Street Horizon

• Analyst Days
• Board of Directors Meeting
• Business Updates
• Buybacks
• Capital Markets Day
• Company Travel
• Filing Due Dates
• Fiscal Quarter End
• Forum
• General Conference
• FDA Advisory Committee Meetings
• Holidays
• Index Changes
• IPOs
• Legal Actions
• Mergers & Acquisitions
• Product Events
• Research and Development Days
• Same Store Sales
• Secondary Offerings
• Seminars
• Shareholder Meetings
• Summit Meetings
• Trade Shows
• Witching Hours
• Workshops

Fraud Factors

• Similarity Index
• Non-Timely Filings

ExtractAlpha

Precision Alpha

• Precision Alpha Price Dynamics

BRAIN Company

Kavout

• K Score for US Equities

Audit Analytics

• Audit Analytics Director and Officer Changes
• Audit Analytics Accounting Quality and Risk Matrix

ValuEngine

• ValuEngine Stock Research Report

Need to Reclassify/Remove

• Relevant Stocks

Contributing

Contributions are welcome! To contribute please:

1. Fork the repository
2. Create a feature branch
3. Code
4. Submit a pull request

Testing

Prior to submitting a pull request, please run:

$ make check

To update and view the test coverage report:

$ make cover

License

iexcloud is released under the MIT license. Please see the LICENSE file for more information.