zishe/iex-cloud

IEX Cloud API TypeScript Client

IEX Cloud API TypeScript Client

A typescript client for the IEX Cloud API.

Table of Contents

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

Installation

Install package

yarn add iex-cloud

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 (default) or sandbox if needed:

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

Call any methods:

import { metadata } from 'iex-cloud';

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
• Data Points

Account

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

API System Metadata

• Status

Stock Prices

• Book
• Delayed Quote
• Historical Prices
• Intraday Prices
• Largest Trades
• OHLC
• Previous Day Price
• Price Only
• 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
• 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

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.

iex-cloud's Issues

add endpoint: Market Info - List

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

https://iexcloud.io/docs/api/#list

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

Refactor to functions

Wrong type for isEnabled in TradeSymbol interface

• I'm submitting a ...
  [x] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  The type of isEnabled in TradeSymbol should be boolean instead of string as per the official doc.
  File: https://github.com/zishe/iex-cloud/blob/develop/src/endpoints/reference-data/Symbols.ts

Official doc: https://iexcloud.io/docs/api/#symbols

  {
    "symbol": "A",
    "name": "Agilent Technologies Inc.",
    "date": "2019-03-07",
    "type": "cs",
    "iexId": "IEX_46574843354B2D52",
    "region": "US",
    "currency": "USD",
    "isEnabled": true,
    "figi": "BBG000C2V3D6",
    "cik": "1090872",
  },

Change node-fetch to isomorphic fetch

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

New Release featuring latest code from develop branch

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  I was hoping you could create a new release on NPM for the latest features in the develop branch. Specifically the end of day options feature.

Injecting tokens to the client instead of env variables

• I'm submitting a ...
  [ ] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ x] question about how to use this project

• Summary

I cannot use env variables in my project due to my hosting provider. How do I inject my API keys to the client?

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

Add enpoint: Market Info: Market Volume (U.S.)

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

https://iexcloud.io/docs/api/#market-volume-u-s

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

Add enpoint: Daily Treasury Rates

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

https://iexcloud.io/docs/api/#daily-treasury-rates

Support for a specific iexcloud.io API

• I'm submitting a ...
  [ ] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ x] question about how to use this project

• Summary

Hello. Do you support this API offered by iexcloud?

https://cloud.iexapis.com/v1/stock/market/batch?symbols=vdigx&types=quote&token=TOKEN

and, if so, can you please provide an example of which interface to use?

Behind my question is the need to get time-series closing price data for mutual funds (e.g., VDIGX) rather than individual stocks.

Thank you!

Add stream endpoints

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

add IPO Calendar endpoint

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

https://iexcloud.io/docs/api/#ipo-calendar

• Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. StackOverflow, personal fork, etc.)

+1 Technical Indicators

• I'm submitting a ...
  [ ] bug report
  [x] feature request
  [ ] question about the decisions made in the repository
  [x] question about how to use this project

• Summary
  I am requesting the Technical Indicators endpoint to be next on your list.

Also, I have a question about the message cost of the Technical Indicators endpoint: The docs tell me that a request for a single indicator costs 50 per indicator value + weight of chart data returned. If I want to get 4 indicators (let's assume for 1 day and 1 symbol), do I have to pay for the charts data 4 times? Or can I get multiple indicators in a single call? I see no examples indicating that is possible, hence my question. If that is possible, can you please provide an example of retrieving multiple indicators that each require parameters, for symbol AAPL for range 5 days?

Added tests

Batch API

• I'm submitting a ...
  [ ] bug report
  [ x ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary
  Any plans for batch requests?

ApiRequest sets API environment to API token

• I'm submitting a ...
  [x ] bug report
  [ ] feature request
  [ ] question about the decisions made in the repository
  [ ] question about how to use this project

• Summary

• module>core>ApiRequest.js

• const apiEnv = process.env.IEX_API_ENV || iexConfig.apiToken || 'cloud';