Nearly Perfected Mystique

    iex-cloud-ee
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.1 • Public • Published

    IEX Cloud API TypeScript Client

    NPM version License Badge Build Status Gtihub Actions coverage status Codacy Badge Maintenance Status

    A typescript client for the IEX Cloud API.

    Table of Contents

    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_SECRET_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
    • [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

    • [x] Collections
    • [x] Earnings Today
    • [x] IPO Calendar
    • [x] List
    • [x] Market Volume (U.S.)
    • [x] Sector Performance
    • [x] 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

    • [x] End of Day Options

    Social Sentiment

    • [ ] Social Sentiment

    CEO Compensation

    • [x] CEO Compensation

    Treasuries

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

    • [x] Search
    • [x] Cryptocurrency Symbols
    • [x] FX Symbols
    • [x] IEX Symbols
    • [x] International Symbols
    • [x] International Exchanges
    • [x] ISIN Mapping
    • [x] Mutual Fund Symbols
    • [x] Options Symbols
    • [x] OTC Symbols
    • [x] Sectors
    • [x] Symbols
    • [x] Tags
    • [x] U.S. Exchanges
    • [x] 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.

    Install

    npm i iex-cloud-ee

    DownloadsWeekly Downloads

    2

    Version

    2.2.1

    License

    MIT

    Unpacked Size

    9.96 MB

    Total Files

    487

    Last publish

    Collaborators

    • eenewbsauce