npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

iex-cloud

v2.2.0

Published

IEX Cloud API TypeScript Client

Downloads

231

Readme

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

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

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