IEX Cloud API TypeScript Client

A typescript client for the IEX Cloud API.

Table of Contents

• Installation
• Usage
  • Get an API Token
  • Configure
• Implementation
• Contributing
• Copyright and License

Installation

Install package

yarn add iex-ts-client

Usage

Get an API Token

Create an account on IEX Cloud and get a publishable token from the IEX cloud console. You should use a sandbox token and endpoint for testing.

Configure

Put your API tokens to your environment file (.env) and specify version (default is v1) and IEX environment (cloud) if needed:

IEX_API_TOKEN=pk_XXXX
IEX_API_SECRET_TOKEN=sk_XXXX
IEX_API_SECRET_VERSION=beta
IEX_API_ENV=cloud

Call any methods:

import { metadata } from 'iex-ts-client';

metadata().then(result => console.log(result));

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
• [x] Data Points

Account

• [x] Message Budget
• [x] Metadata
• [x] Pay as you go
• [ ] Signed Requests
• [x] Usage

API System Metadata

• [x] Status

Stock Prices

• [x] Book
• [x] Delayed Quote
• [x] Historical Prices
• [x] Intraday Prices
• [x] Largest Trades
• [x] OHLC
• [x] Previous Day Price
• [x] Price Only
• [x] Quote
• [x] Volume by Venue

Stock Profiles

• [x] Company
• [x] Insider Roster
• [x] Insider Summary
• [x] Insider Transactions
• [x] Logo
• [x] Peer Groups

Stock Fundamentals

• [x] Balance Sheet
• [x] Cash Flow
• [x] Dividends (Basic)
• [x] Earnings
• [x] Financials
• [ ] Financials As Reported
• [x] Income Statement
• [x] Splits (Basic)

Stock Research

• [x] Advanced Stats
• [x] Analyst Recommendations
• [x] Estimates
• [x] Fund Ownership
• [x] Institutional Ownership
• [x] Key Stats
• [x] Price Target
• [ ] Technical Indicators

Corporate Actions

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

Market Info

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

News

• [x] 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

Documentation

See documentation here

Contributing

See CONTRIBUTING.

Copyright and License

MIT License Copyright (c) 2019 Alexander Kireev and Contributors.

Data provided for free by IEX Cloud, see terms.