IEX Cloud Legacy API Reference

IEX Cloud Legacy is a platform that makes financial data and services accessible to everyone.

The IEX Cloud Legacy API is based on REST, has resource-oriented URLs, returns JSON-encoded responses, and returns standard HTTP response codes.

• The base url for the API is: https://cloud.iexapis.com/
• We support JSONP for all endpoints.

API Versioning

IEX Cloud will release new versions of the API when we make backwards-incompatible changes. We plan to support up to three active versions and will give advanced notice before releasing a new version or retiring an old version.

Backwards compatible changes:

• Adding new response attributes
• Adding new endpoints
• Adding new methods to an existing endpoint
• Adding new query string parameters
• Adding new path parameters
• Adding new webhook events
• Adding new streaming endpoints
• Changing the order of existing response attributes

Current Version is v1

Naming Convention

stable can be used to access the latest stable API version. beta can be used to access the latest API version.

Endpoint Versioning

Endpoints may be in various states of alpha, beta, deprecated, etc. These indicate that an endpoint is either not yet subject to the requirements above (in the case of alpha, beta) or that it will be modified within the same API version (in the case of deprecated).

Deprecation

Both the IEX Cloud platform and the financial data ecosystem are constantly evolving, so it may become necessary to deprecate or disable some endpoints without versioning the entire API. Some situations which might require this action include changes to data contracts, critical useability issues, data universe expansion, etc. In these situations we will make every effort to provide alternative access to the underlying data or another provider’s data, and maintain the deprecated endpoints for a reasonable timeframe.

An endpoint will be removed ~6 Months from the time of deprecation with advance notice given via email and any alternative functionality available in both the API and official client libraries.

Attribution

Attribution is required for all users. It is as simple as putting “Data provided by IEX Cloud” somewhere on your site or app and linking that text to https://iexcloud.io. In case of limited screen space, or design constraints, the attribution link can be included in your terms of service.

<a href="https://iexcloud.io">Data provided by IEX Cloud</a>

When displaying a real-time price, you must display and link to IEX Cloud as the source near the price. The link is commonly placed below the price.

<a href="https://iexcloud.io">IEX Cloud</a>

Authentication

API Tokens

IEX Cloud authenticates your API requests using your account’s API tokens. To use any IEX Cloud API, you must pass an API token with each request. If you do not include your API token when making an API request, or use one that is incorrect or disabled, IEX Cloud returns an error.

IEX Cloud provides two types of API tokens: publishable and secret.

• Publishable API tokens are meant solely to identify your account with IEX Cloud, they aren’t secret. They can be published in places like your website JavaScript code, or in an iPhone or Android app.

• Secret API tokens should be kept confidential and only stored on your own servers. Your account’s secret API token can perform any API request to IEX Cloud.

Protecting Your API Tokens

• Keep your secret token safe. Your secret token can make any API call on behalf of your account, including changes that may impact billing such as enabling pay-as-you-go charges. Do not store your secret token in your version control system. Do not use your secret token outside your web server, such as a browser, mobile app, or distributed file.
• Monitor usage of your API for anomalies. If you observe unauthorized or abnormal usage, rotate your API token. IEX Cloud provides multiple options to address abnormal usage. ..* You may use the IEX Cloud console to rotate an API token. Rotating a token will disable access to IEX Cloud for the rotated token within 10 seconds. ..* You may use the IEX Cloud API or console to disable pay-as-you-go. This may prevent unexpected charges due to unauthorized or abnormal usage.
• Do not embed API keys directly in code. Instead of directly embedding API keys in your application’s code, put them in environment variables or in include files that are stored separately from the bulk of your code—outside the source repository of your application. Then, if you share your code, the API keys will not be included in the shared files.
• Do not store API tokens in inside your application’s source control. If you store API tokens in files, keep the files outside your application’s source control system. This is particularly important if you use a public source code management system such as GitHub.
• Limit access with restricted tokens. IEX Cloud console will allow you to specify the IP addresses or referrer URLs associated with each token, reducing the impact of a compromised API token.
• Use independent API tokens for different apps. This limits the scope of each token. If an API token is compromised, you can rotate the impacted token without impacting other API tokens.

Error Codes

IEX Cloud uses HTTP response codes to indicate the success or failure of an API request.

General HTML status codes

2xx Success.

4xx Errors based on information provided in the request

5xx Errors on IEX Cloud servers

IEX Cloud HTTP Status Codes

Security

We provide a valid, signed certificate for our API methods. Be sure your connection library supports HTTPS with the SNI extension.

Request Limits

IEX Cloud only applies request limits per IP address to ensure system stability. We limit requests to 100 per second per IP measured in milliseconds, so no more than 1 request per 10 milliseconds. We do allow bursts, but this should be sufficient for almost all use cases. Note that Sandbox Testing has a request limit of 10 requests per second measured in milliseconds.

SSE endpoints are limited to 50 symbols per connection. You can make multiple connections if you need to consume more than 50 symbols.

Credits and Pricing

Credit Basics

Every dataset has an associated cost in credits based on:

• How much data is there? A dataset like Fundamentals includes hundreds of fields, while a single US Treasury Yield record might only have one field.
• How frequently does the data update? Quote updates millions of times per day, while Unemployment Rate might only update weekly
• How much does it cost to acquire the data? Some datasets we collect on our own, other datasets we purchase from upstream vendors. Ingesting and normalizing data has infrastructural costs on top of the base dataset cost.
• How much does it cost to distribute the data? With billions of API calls and bursty workloads around market hours, our infrastructure needs to scale up and down to ensure constant uptime and consistent delivery.

We call this associated credit cost the dataset’s weight. When you access a dataset, the total weight charged for the access will generally be the weight multiplied by the number of records received (taking into account the other possible credits or debits below). If you don’t receive any records, you won’t be charged for accessing that dataset. Each endpoint has its own weight which you can find in the documentation below. If the sum of these charges exceeds your monthly credit allocation, you will need to upgrade or purchase additional packages to continue accessing data.

Credit allocations reset on the first of each month at 00:00:00 UTC. API calls will return iexcloud-credits-used in the header to indicate the total number of credits consumed for the call, as well as an iexcloud-premium-credits-used to indicate the total number of premium credits consumed for the call. You can also track this information in the console.

Other credits and debits

API Use

All API calls will have an additional 1 credit access charge. This allows us to keep data costs lower across a wide variety of datasets. The following endpoints are omitted:

• Account endpoints
• Status endpoints
• Rules endpoints
• Timeseries Metadata and Inventory endpoints
• Files inventory endpoints
• Data points inventory endpoints
• Calls that result in 4XX or 5XX error codes

SSE connections will have a 1 credit charge on initial connection, not per record. Batch calls will have an additional 1 credit charge for the entire batch, regardless of the number of symbols or channels contained in the batch.

Legacy Individual Plans and Business Plans

Included with Individual plans ($9 per month with an annual subscription, or $19 per month with a monthly subscription):

• Five million credits (or messages) per month.
• One API token.
• One user login.
• Additional features, such as free access to Cloud Cache.
• Both commercial and personal use.

Included with Business plans ($199 per month with an annual subscription, or $299 per month with a monthly subscription):

• 150 million credits (or messages) per month.
• Four API tokens.
• Four user logins.
• Full feature access – everything included with Individual plus more. More detail coming soon.
• Both commercial and personal use.

Both plans provide the following:

• Credits (previously called messages): Use credits to make more API calls and request more data from IEX Cloud.

• Tokens: Tokens connect your project or application to your account. You can track, control, and throttle data usage by token. Examples of when you’ll use multiple tokens include using IEX Cloud to support multiple applications, projects, teams, or user accounts. For instance, if you support three applications, you would likely use a different token for each app.

• User logins: Adding user logins to your plan adds room for more teammates to join your IEX Cloud account and use its data.

If you need to add more credits, API tokens, or user logins to your account, you can upgrade your plan or add packages.

Credits in Legacy Plans

Credits are the fundamental units used to access data and make API calls on IEX Cloud legacy plans. Each API endpoint has a certain “data weight,” or a given number of credits that are used every time you make an API call with that endpoint. 

For example, the Earnings endpoint has a data weight of 1,000 credits per symbol per period. This means you would use 1,000 credits to see a company’s earnings for one specific quarter. 

Credits make your legacy subscription with IEX Cloud flexible and adjustable to your use case. You may use a higher volume of lower-weighted endpoints, fewer higher-weighted endpoints, or a combination. Note that certain endpoints are only available with paid legacy plans on IEX Cloud. 

The IEX Cloud Console Credits → Credit Use tab automatically keeps track of how many credits you have used so far in the month. Note to the data weights for different endpoints on IEX Cloud. 

Why do different API endpoints use different numbers of credits?  

Data weights are determined by a number of factors, including agreements between IEX Cloud and our third-party data providers, the cost of sourcing the data further upstream, and other computational costs.  

Rather than requiring customers to pay for a preset selection of data in bulk, credits give you the flexibility to choose exactly the data you want to use with your subscription and how often you want to use it. IEX Cloud serves a diverse range of use cases and is designed to make data accessible for everyone.   

How many credits do I need, and which plan should I choose? 

Each IEX Cloud legacy plan provides a different monthly allocation of credits, tokens for connecting your applications to your account, and user logins. The different plans also come with a designated set of tools and available datasets, which you can see on our pricing page.

You can choose your plan based on your use case:

• The legacy Individual plan: This plan is ideal for personal use, projects, students, building basic applications, testing, freelancers, and light use.
• The legacy Business plan: This plan allows for more scale and flexibility for growing technology companies and larger enterprises. With more credits, tokens, and user logins, it’s built to help growing businesses scale, bring flexibility to how firms build and make it easier to integrate IEX Cloud into your team’s workflow.

In addition to choosing your base plan, you can also further customize it by adding packages. Packages add credits for more data usage, tokens for connecting more apps to your account, and user logins.

To help choose your plan and how many packages you need, it can be helpful to estimate how many credits you’ll need on a monthly basis. Once you know what data you would like to use on IEX Cloud, you can estimate your monthly credit usage by referencing those endpoints’ data weights in our documentation and multiplying that weighting by how frequently you will request this data.  

Our calculator here can help assist with a rough estimation. Alternatively, use the following formula as a guideline:  

Data Weight x Number of Symbols x Frequency = Credit Use for that API Endpoint

For example, let’s say you were looking to see the last three quarters’ earnings for a list of 5,000 companies. The Earnings endpoint uses 1,000 credits per symbol per period. 

Your credit usage for that endpoint would be: 

(1,000 credits) x (5,000 symbols) x (3 periods) x (1 call per symbol) = 15,000,000 credits 

Core credits vs. Pay-as-you-go Credits (For legacy Launch, Grow, and Scale plans only)

On our legacy plans, each IEX Cloud plan provides a different number of monthly core credits, as well as different pay-as-you-go credits.

Core credits represent the base number of credits included with your subscription each month. Core credits can be used towards any of the Core Data endpoints included with your plan. Your core credit usage is reset at the beginning of each calendar month.

Pay-as-you-go credits can be used in addition to your core credits as needed and are priced at a discounted rate. After you’ve used your core credits for a given month, you can use pay-as-you-go credits to continue accessing as much data as you need. With legacy Launch, Grow, and Scale plans, pay-as-you-go credits can also be used to access Premium Data — specialized datasets that can be added onto your subscription.

It’s recommended that you enable the automatic use of pay-as-you-go credits in the IEX Cloud Console. This setting helps prevent disruption in your service and allows IEX Cloud to default over to using pay-as-you-go credits after you have used all of your core credits for the month.

If you do not have the automatic use of pay-as-you-go credits enabled, IEX Cloud will pause access to data after you have used all of your core credits and will restore access at the beginning of the next month.

Best practices for credits

Make the most of your credits by checking out these IEX Cloud features: 

• Cloud Cache – automatically enabled with Individual and Business plans: More efficiently use your credits by storing and reusing the data that you’ve already requested from IEX Cloud. Let us handle the work for you with Cloud Cache. Cloud Cache is automatically included with Individual and Business plans. Learn more.
• Packages (for Individual and Business plans only): If you need more credits with your Individual and Business plans, you can simply add packages. Learn more about packages. Decide on an appropriate history and update interval. For example, if I want to access 5 years of financial statements, I do not need to purchase a plan that allows me to access 5 years of financial statements each month. I can simply purchase enough packages to backfill 5 years once, then reduce my packages to maintain ongoing updates. You can also leverage APIs like data points to check when data has been updated. 
• Pay-as-you-go credits (for legacy Launch, Grow, and Scale plans only): Enable pay-as-you-go credits in the IEX Cloud Console. This ensures that you can continue to access data without interruption if you use all the core credits allocated with your subscription for the month.  

Budgeting Credit Usage

Some legacy Launch, legacy Grow, and legacy Scale plans still support the pay-as-you-go credits billing method. That is you can pay as you go for either Premium Data usage or for overages if you use more credits in a given month than allocated with your plan.

Since pay-as-you-go credits are not prepaid (and you can consume as many as you want on top of your plan), many users prefer to set a limit inside of their IEX Cloud Console to prevent accidental runaway usage.

If you have pay-as-you-go, you can also set a “credit budget” for both core data usage and Premium Data usage. To set up, navigate to the Credit Use tab in the IEX Cloud Console and click at the top to either “Core Use” or “Premium Use.”

Under the month’s usage chart, you can set your budget.

Premium Data credit budgets

If you are on a legacy Launch, Grow, and Scale plan, a default budget of 100,000,000 credits was set when you enable access to your first dataset. When this limit is reached, access to Premium Data will be paused until the end of the month or until the limit is modified. You can change this limit at any time in the IEX Cloud Console.

Questions? Let us know at support@iexcloud.io

Legacy Packages

Packages make it easier to customize your IEX Cloud plan according to your use case so that your plan scales with you as you grow. You can add packages as you need them throughout your legacy plan term.

Add packages to your plan to receive more of the following:

• Credits (previously called messages) – Included in packages for both legacy Individual and legacy Business plans: Use credits to make more API calls and request more data from IEX Cloud.
• Tokens – Included in packages for Business plans: Tokens connect your project or application to your account. You can track, control, and throttle data usage by the token. Examples of when you’ll use multiple tokens include using IEX Cloud to support multiple applications, projects, teams, or user accounts. For instance, if you support three applications, you would likely use a different token for each app. Learn more about tokens.
• User logins – Included in packages for legaycy Business plans: The number of user logins on your plan refers to the number of seats you have for teammates to log into your IEX Cloud account. Adding user logins to your plan adds room for more people to join your IEX Cloud account and use its data.

You can both add and remove packages from your legacy plan as you need. Once you add a package, by default it will be added to your plan for each subsequent month. If you remove a package from your plan, it expires at the end of the current month. Packages can be removed or added month to month for both monthly and annual plans.

Packages cannot be added to free legacy Start plans or to legacy Launch, Grow, and Scale plans. To use packages, you must have the legacy Individual plan or legacy Business plan.

What is included with each package?

Packages are different depending on your paid plan, and can only be added to legacy Individual plans or legacy Business plans.

Legacy Individual plan ($10 per month per package - for both monthly and annual plans) – each package includes every package adds:

• 10 million credits to your account.

Legacy Business plan ($30 per month per package - for both monthly and annual plans) – every package adds:

• 30 million credits.
• One token.
• One user login – or additional login for a teammate on your IEX Cloud account.

How do I add more packages to my legacy plan, and when should I add them?

How many packages you need depends on how many credits, tokens, or seats for users you need. You can always add more packages to your plan as you go, or purchase multiple packages up front.

To add packages, go to Account → Manage Plan in the lower-left corner of the Console. You might add more packages if:

• You need additional credits. With the new pricing plans, we replaced pay-as-you-go overages with packages. If you approach your plan’s credit (or message) limits, you can either upgrade your plan or purchase additional packages. We will notify you via email when you reach your credit limits with instructions on how to add packages to your plan.
• You need more tokens added to your account. Depending on your use case, you may need additional tokens for your account. For instance, if you have multiple teams or applications, you will likely need multiple tokens for each of those teams or apps.
• You need to add more user logins to your account. Maybe you’re expanding your team, or a new team at your business wants to join your IEX Cloud account to start a new project.

To see your current credit and plan usage, log into the IEX Cloud Console and go to Credits → Credit Use.

Packages are only available with the legacy Individual and Business plans, and cannot be added to legacy Launch, Grow, or Scale plans. If you already have a paid Launch, Grow, or Scale plan.

How do overages work with the new plans?

IEX Cloud users on legacy Launch, Grow, or Scale plans will be familiar with the concept of pay-as-you-go messages (now pay-as-you-go credits). Instead of paying overages this way at the end of each month using pay-as-you-go credits, to use additional credits with these pricing plans, you’ll purchase packages.

We replaced overages with packages based on user feedback, with the goal of providing a simpler, more transparent way of scaling your plan with your usage.

If you reach your plan’s monthly credit limits, we will notify you via email with instructions on how to add packages to your plan. To prevent disruption, we suggest periodically checking your credit usage in the Console as well as purchasing packages in advance if you anticipate needing to use additional credits. When you reach your monthly credit limit, access to data will be temporarily paused until more credits are added to your plan or the next month begins.

How are packages billed?

For both monthly and annual plans, packages are billed immediately upon purchase for the current month. They are then billed on the 1st{sup}** of each subsequent month. For instance, let’s say you purchase a package with your annual Business plan on the 16th. You’ll pay $30 upon purchase, and then $30 on the 1st of each subsequent month. If you remove your package in the middle of a month, you’ll have it for the remainder of the month, after which it expires and you’ll no longer be charged for that package.

{sup}** IEX Cloud billing utilizes Universal Time Coordinated (UTC). Renewals will occur at 00:00 UTC (08:00 PM EST).

Legacy Premium Data

IEX Cloud paid legacy plans include a breadth of data through a single easy-to-use API - ranging from simple stock prices for everyday investing to Premium Data for more specialized use. 

This guide provides more detail on how Premium Data differs from Core Data and how to get started. 

Core Data vs. Premium Data

Core Data is the data included with IEX Cloud subscriptions. This includes any endpoints listed outside of the Premium Data section, such as stock data, FX data, macroeconomic data, and more. The credits allocated with the IEX Cloud subscription can be used towards Core Data only. 

Premium Data is specialized data made available through the IEX Cloud API, sourced from various Data Partners directly. Premium Data consumption is on a pay-as-you-go basis using Premium Data credits, with different credit weights for each specific dataset. Premium Data is only included in paid IEX Cloud legacy subscriptions.  

Premium Data is available to customers with a paid legacy plan on IEX Cloud. 

How do I start using Premium Data?

Follow the steps below to access Premium Data:

1. Add Premium Data credits to your account on the add-ons page. Premium Data usage is purchased with prepaid Premium Data credits.

2. Request access to data on the Premium Data page of the IEX Cloud Console. For many datasets, you’ll be granted access right away. However, a couple requires partner approval and it could be a few business days before your access is activated. You can request access here.

   Once the Data Partner that provides that dataset confirms your request, it will be marked as “Enabled.“  

3. Start accessing data! Your account will then be able to successfully make API requests to the dataset’s endpoints. You can start and stop using Premium Data at any time.  

Be sure to check Premium Dataset endpoints’ data weights before use. The endpoints for Premium Data and their weighting are documented. 

Please note that each Data Partner has its own unique protocol for processing data access requests. You may be asked to complete a couple of extra steps or experience wait times when confirming access for different datasets.  

Pricing for Premium Data on IEX Cloud

Premium Data is available as an addition to the Core Data already accessible through the IEX Cloud paid legacy subscriptions and uses Premium Data credits. For legacy Launch, Grow, and Scale plan users, it also uses pay-as-you-go credits. Credits included with the IEX Cloud subscriptions are used for Core Data and cannot be used towards Premium Data. 

Premium Data makes it easy to access a wider range of financial data and alternative data all in one place. Premium Data may be priced higher than other endpoints used as a part of the IEX Cloud Core Data offering, as it provides curated, specialized data sourced directly from other data creators.   

How much data usage do I get with each dollar of Premium Data credits?

When you purchase Premium Data credits, you’ll notice that you purchase in dollar amounts. Our Premium Data endpoints, on the other hand, are priced in credits. For instance – you might purchase $50 worth of Premium Data credits, with the plan of using a Premium Data endpoint with a data weight of 100,000 credits per API call.

For our Business and Individual legacy plans, you purchase credits for Premium Data use at $1 per 1 million credits. For instance, $20 would provide 20,000,000 credits.

For our legacy plans, the dollar-to-credit conversion depends on your plan. Premium Data is charged at the cost of your pay-as-you-go credit rate:

• Launch: $1 per 1 million credits
• Grow: $1 per 2 million credits
• Scale: $1 per 3 million credits

What is the monthly credit budget on Premium Data use? (Legacy Launch, Grow, and Scale plans only)

Credit budgets are the same as message budgets.

With legacy Launch, Grow, and Scale plans that use pay-as-you-go credits, IEX Cloud allows you to set customizable limits for the number of credits used on Premium Data per month. Credit budgets can be used to help maintain a cap on your credits consumption for the month or prevent accidental runaway use of Premium Data. 

A default budget of 100,000,000 credits is set when you enable access to your first dataset. When this limit is reached, access to Premium Data will be paused until the end of the month or until the limit is modified. You can change this limit at any time in the IEX Cloud Console. 

Other Premium Data FAQs  

What Premium Data is currently available?

You can see a full list of available Premium Data in the IEX Cloud Console under the Premium Data tab.

If there is certain data you would like to access that is not currently offered, please reach out to support@iexcloud.io with your request. Your feedback is essential to our future product roadmap.  

Can I test Premium Data with IEX Cloud’s sandbox (deprecated)?

  You can test Premium Data using IEX Cloud’s sandbox (deprecated), regardless of whether you have enabled access to that dataset. IEX Cloud’s sandbox provides scrambled test data and does not charge for any credits.

Prepaying for Premium Data with Premium Data Credits

Premium Data credits are a payment method on IEX Cloud where you purchase Premium Data usage upfront in bulk. You can choose how much you purchase in advance based on your anticipated usage of Premium Data, and add more Premium Data credits as you go.

For Individual and Business legacy plans, Premium Data credits are the only payment method for Premium Data.

For other legacy plans, you also have the option of using our legacy pay-as-you-go credits to purchase Premium Data. The legacy Launch, Grow, and Scale plans will allow you to use a certain number of pay-as-you-go credits every month for purchasing Premium Data. For usage beyond that amount, you will need to use prepaid Premium Data credits as your payment method.

How do I purchase Premium Data credits?

To view the Premium Data credits option, you must be logged in as an account admin. Navigate to the Add Ons tab of the IEX Cloud Console. You can select how much credit you would like to purchase, with a $20 minimum. There is no limit on how many Premium Data credit packages that can be purchased at a time. After you complete your purchase, Premium Data credits will be valid for one year.

Note that Premium Data credits are available for use after purchase beginning the first day of the upcoming month. For instance, if you purchased $200 worth of Premium Data credits on April 15th, 2020, this credit would be applied to your account and available starting May 1st, 2020 – the first day of the upcoming month – and would be available for use until May 1st, 2021.

Premium Data credits are available with IEX Cloud paid legacy plans only.

How much data usage do I get with each dollar of Premium Data credits?

When you purchase Premium Data credits, you’ll notice that you purchase in dollar amounts. Our Premium Data endpoints, on the other hand, are priced in credits. For instance – you might purchase $50 worth of Premium Data credits, with the plan of using a Premium Data endpoint with a data weight of 100,000 credits per API call.

For our Business and Individual legacy plans, you purchase credits for Premium Data use at $1 per 1 million credits. For instance, $20 would provide 20,000,000 credits.

For our legacy plans, the dollar-to-credit conversion depends on your plan. Premium Data is charged at the cost of your pay-as-you-go credit rate:

• Launch: $1 per 1 million credits
• Grow: $1 per 2 million credits
• Scale: $1 per 3 million credits

When can I apply my Premium Data credits?

Premium Data credits can be applied towards Premium Data only, and cannot be used towards your Core Data subscription or add-ons, except from widgets (deprecated). Premium Data credits can be used for up to 12 months from the time of purchase.

For instance, if you purchase Premium Data credits on March 1st, 2020, they will expire after March 1st, 2021. Note that unused credits cannot be returned as a refund.

Where can I see how much credit I have remaining?

After you purchase Premium Data credits in the Add Ons tab, you can track how much credit you have remaining in the Premium Data usage dashboard.

Premium Data credits vs. pay-as-you-go credits (For legacy Launch, Grow, and Scale plans only)

For our legacy Launch, Grow, and Scale plans, there are two methods for purchasing Premium Data: Premium Data credits and pay-as-you-go credits.

Premium Data credits can be used towards Premium Data only – credits can be purchased in advance in bulk, rather than paying for Premium Data as you use it. You can choose how much you would like to purchase upfront based on your expected usage of Premium Data. After purchasing Premium Data credits, that balance will be applied to your Premium Data usage for the next 12 months.

You can also pay for Premium Data as you need it using pay-as-you-go credits. Pay-as-you-go credit usage is billed at the end of each month. For each subscription tier, there is a limit for how many pay-as-you-go credits you can use in a month. Consuming credits beyond this monthly limit will require that you purchase prepaid premium data credits. Learn more about pay-as-you-go credits here.

When do I need to use Premium Data credits? (For legacy Launch, Grow, and Scale plans only)

Depending on your plan and the amount of Premium Data usage, Premium Data credits may be the required payment method. For each subscription tier, there is a monthly limit on how many pay-as-you-go credits you can use for Premium Data. To continue using Premium Data after that limit, you will need to purchase Premium Data credits. Those pay-as-you-go limits are outlined below:

• Launch: 50 million pay-as-you-go credits per month (equivalent to $50 at $1/1 million credits)
• Grow: 100 million pay-as-you-go credits per month (equivalent to $50 at $½ million credits)
• Scale: 3 billion pay-as-you-go credits per month (equivalent to $1,000 at $1/3 million credits)

If you have not reached any of the limits above, and you use all your Premium Data credits, pay-as-you-go credits will automatically be used for additional Premium Data usage. If you want to prevent IEX Cloud from automatically using pay-as-you-go credits, you can enable a monthly credit budget. You can also purchase additional Premium Data Credits at any time.

Caching Data in Legacy Plans

Setting up your own caching

Legacy Individual and legacy Business plan users, as well as legacy Launch, Grow, and Scale subscribers are permitted to cache data on their own servers and can then display data from the cache to their users for commercial use.

Please note that you cannot provide IEX Cloud data via your own API to users or provide a mechanism for mass downloads, including a CSV download. Read more about acceptable usage of the platform in our Terms of Service.

Using Cloud Cache

Cloud Cache is IEX Cloud’s fully managed data storage infrastructure. It saves you credits by automatically storing the data that you’ve already queried from IEX Cloud. When you request that data again, you’ll only use one credit rather than the full data weight, so that you don’t pay for the same data twice.

Note that any data stored by Cloud Cache is "reset” at the start of each calendar month. This is so we can keep our data storage as high-performant as possible.

Cloud Cache is automatically enabled for all legacy Individual plan and legacy Business plan users – no setup or additional costs required.

See also Cloud Cache.

One Additional Credit Used Per API Call

Starting July 15, 2021, each API call uses one additional credit on top of the endpoint’s data weight.

For instance, if the data weight for an endpoint is 100 credits per request, each API call would use a total of 101 credits. Or if you’re using free real-time stock prices from IEX, you would use a total of one credit per API call.

If you’re streaming data, you would use one additional credit per connection.

This applies to all production API calls (API calls not made in our Sandbox environment).

Why is one extra credit used per API call?

This one-credit covers our operational costs for delivering data and enables us to keep the costs lower across dozens of endpoints. This also allows us to continue investing in scalable infrastructure.

For most users, this adds minimal cost – a few cents to a few dollars per month in usage. For instance, if you make one million API calls per month, this update would add roughly $1 per month in credit usage.

What about sandbox API calls?

Sandbox API calls are free and unlimited and do not use any of your monthly credit allocations.

Sandbox API calls can also be used to help show how many credits would be used if that same API call were performed in the production. You’ll see this one credit reflected in “sandbox data weight” that’s returned in the API request’s response header to help you accurately estimate how many credits you would use.

Does this apply to Premium Data, Rules Engine, and other add-ons?

Every production API call across the platform will use one additional credit. This includes:

• Core Data and Reference Data.
• Premium Data. (The additional credit used will be a core credit, rather than a Premium Data credit.)
• Add-ons such as Rules Engines, the Excel plug-in, and Stock Price Widgets.
• API calls that use Cloud Cache. (link)

This does NOT include:

• Every SSE streaming or Firehose update. Streaming will use one additional credit per connection made – not per update.
• Sandbox API calls (deprecated).

How does this work with Cloud Cache?

Cloud Cache keeps track of the API calls you’ve already made, so if you make the same request twice, you only pay a data weight of one credit rather than the full data weight.

This one credit is added on top of the one-credit data weight provided by Cloud Cache. So if Cloud Cache returned data to you for one credit, you would use two credits total.

Legacy Plan Cost for Stock Price Data

The Quote and Intraday Prices endpoints are available with free legacy plans, although specific fields – such as 15-minute delayed data – require a paid legacy plan. Without a paid legacy plan, those fields return null. For both legacy free and legacy paid users, the use of these endpoints requires credits (previously called messages).

Furthermore, 15-minute delayed price data for Nasdaq-listed securities also requires UTP authorization.

The Quote endpoint uses one credit per update per symbol. Similarly, the Intraday Prices endpoint uses one credit per update per symbol per interval – for instance, you might request minute-by-minute data for 30 minutes in one API call, which would use 30 credits.

The Intraday Prices endpoint only charges you a maximum of 50 credits per update per symbol if you are querying for multiple-minute time intervals. For instance, if you request 90 minutes of data, while this would be 60 intervals, you are charged only 50 credits.

Note that data provided by the Investors Exchange via the IEX Cloud API, including the real-time IEX prices, is free for use. You can access this using our TOPS endpoint (coming soon). You can also apply the chartIEXOnly parameter to the Intraday Prices endpoint to access IEX-only minute-by-minute data from the current trading day free of charge.

Legacy Plan Credits and SSE Streaming

We use a special “reserve system” for streaming endpoints due to high data rates. This is similar to how a credit card puts a hold on an account and later reconciles the amount.

When you connect to an SSE endpoint, we validate your API token and then attempt to reserve an amount of credits (previously known as messages) from your account. If you have enough credits in your quota, or if you’re on a legacy Launch, Grow, or Scale plan and you have pay-as-you-go credits enabled, we allow data to start streaming.

We keep track of the number of credits streamed to your account during the reserve interval.

Once the reserve interval expires, we reconcile usage. This means we compare the number of credits sent to the number of credits we reserved. For example, if you used 1,200 credits, you used 200 more than we reserved; so we use 200 additional credits from your account. If we only used 100 credits, we return the 900 unused credits back to your account.

After reconciling the credits, we attempt another reserve.

The reserve and reconcile process is seamless and does not impact your data stream. If we attempt to reserve credits and your account does not have enough quota and pay-as-you-go is disabled, then we disconnect the SSE streaming service. You can avoid service disruptions by ensuring you have enough packages purchased in advance, or for legacy plans, by enabling pay-as-you-go credits in the Console.

When you disconnect from an endpoint, we reconcile your credit usage immediately.

Firehose

Legacy Business and Legacy Scale plan users can firehose-stream all symbols (except symbols from DEEP endpoints) by leaving off the symbols parameter.

Prorated Credits

While IEX Cloud monthly subscriptions renew at the start of every calendar month, you can sign up for a paid plan or upgrade at any time. When you upgrade or sign up for a monthly paid plan in the middle of a calendar month, the total cost of your first invoice is prorated.

Correspondingly, for the rest of your first calendar month, your plan will also include a prorated number of credits based on when you signed up in the month.

“prorated_messages” on the Credit Use Page

In the IEX Cloud Console, navigate to Credits → Credit Use. Beneath Credit Use by Endpoint, notice the label prorated_messages. prorated_messages shows you the difference between your regular credit allocation and your prorated credit allocation.

For example, if you sign up on September 15, you will only be invoiced for about half of the standard subscription amount and receive half the number of credits allocated for that subscription plan on a monthly basis. Normal billing and credit allocations will resume at the start of the following month.

Note that annual plans are not prorated. The annual term begins on the day you sign up and ends a full year later. For instance, if you signed up on January 15, 2022, your plan will renew on January 15, 2023.

Cloud Cache

If you have a legacy Individual plan or legacy Business plan, and you query the same API for data which has not changed, your cost is reduced to 1 credit per record thanks to Cloud Cache. This complimentary feature keeps track of every API call you make and helps you avoid paying for the same data twice. If you query the same API for data which has not changed, your cost will be reduced to 1 credit per record thanks to Cloud Cache.

As an example, lets say I access Cash Flow data for AAPL. It is the first time I have accessed it this month, and I only access the most recent record, so I am charged 1,000 credits. If I access this same API again this month, and it has not changed, I will only be charged 1 credit as the access has been cached. With Cloud Cache, you only pay for the new data you receive.

If you make the same API call more than once within the same calendar month, and the data hasn’t changed, it’s served to you with a data weight of only one credit – regardless of what the full data weight is. (Note that Cloud Cache cannot be used with files.) When you signed up for an Individual or a Business plan, Cloud Cache was automatically enabled for no additional charge. That means you can use our API without worrying about whether the data has changed or not, so you can code faster and spend less time focused on complicated data infrastructure.

Cloud Cache is cleared at the start of each calendar month. That means if you re-pull the same data point across different calendar months, that data will be re-pulled from our API as normal using the full data weights.

How it Works

Full credit amount is charged only when data is not available in Cloud Cache or the data has changed, and so is fetched from the Cloud API. Each request that is available in Cloud Cache applies a credit weight of 1 for each unit, as opposed to an endpoint’s per unit weighting, as shown in the endpoint’s API reference page.

Batch queries count as 1 cache slot per symbol + type combination.

Cloud Cache Examples

Caching Estimate Data for AAPL

Initial Call:

Estimate is requested: https://cloud.iexapis.com/v1/stock/aapl/estimate?token={YOUR_TOKEN} - 10,000 credits are used - 1 cache slot is used to store the data

Future Call (in the same calendar month):

• Estimate is requested
• Data is found in Cloud Cache
• 1 credit is used

Batch Call

Initial Batch Call:

Batch Request for AAPL and BAC last quarterly earnings and financials: https://cloud.iexapis.com/v1/stock/market/batch?symbols=AAPL,BAC&types=financials,earnings&token={YOUR_TOKEN}

• 12,000 credits are used
• 4 cache slots are used to store the data

Future Batch Call (in the same calendar month):

Last quarterly earnings and financials are requested for AAPL, BAC, and FB: https://cloud.iexapis.com/v1/stock/market/batch?symbols=AAPL,BAC,FB&types=financials,earnings&token={YOUR_TOKEN}

• Data is found in Cloud Cache for AAPL, and BAC. Most recent quarterly earnings and financial for FB pulled from Cloud API.
• 2 credits are used for data fetched from Cache.
• 6,000 credits are used for FB data pulled from API.
• 2 more cache slots are used to store FB earnings and financials

How much data can you store?

Whether you make 100 API requests or 100,000, we’ll keep track of the requests you’ve already made. There’s no limit. However, Cloud Cache resets at the start of each calendar month. This means that if you make an API call in June that you had already made in May, even if the data has changed, you will use the full credit amount in June.

If you want to go beyond this to save data for a longer period, you can also always build your own caching system.

Support

Please consult the following links for information and support.

• Documentation
• Support Page
• Status Page
• Blog

Have a question or want to report a problem regarding the IEX Cloud API?

Please email us with the below information:

• Email account associated with your IEX Account
• Date/time of the issue
• What you did
• What you expected to happen
• What actually happened
• Additional relevant information

Disclaimers

• Required: If you display any delayed price data, you must display “15 minute delayed price” as a disclaimer.
• Required: If you display latestVolume you must display “Consolidated Volume in Real-time” as a disclaimer.
• Required: If you use cash flow, income statement, balance sheet, financials, or fundamentals endpoints, use must display “Data provided by New Constructs, LLC © All rights reserved.”
• Some data provided by EDI
• Some real-time and delayed market data provided by Exegy
• Note on pricing data: All CTA and UTP pricing data is delayed at least 15 minutes.

Guides

REST How-To

Making your first REST API call is easy and can be done from your browser.

You will need:

• Your publishable token which is found in the Console.
• The URL for the type of data you would like to request.

REST calls are made up of:

• Base url. Example: https://cloud.iexapis.com
• Version. Example: beta
• Token. All REST requests require a valid token and can be added to a url like ?token=YOUR_TOKEN_HERE

Free IEX Price for Apple

https://cloud.iexapis.com/stable/tops?token=YOUR_TOKEN_HERE&symbols=aapl

Stock Quote for Apple

https://cloud.iexapis.com/stable/stock/aapl/quote?token=YOUR_TOKEN_HERE

Curl Quote for Apple From the Command Line

curl -k 'https://cloud.iexapis.com/stable/stock/aapl/quote?token=YOUR_TOKEN_HERE'

Excel How-To

IEX Cloud Legacy supports Excel and Google Sheets data import methods.

Excel

Excel provides the Webservice function to import data into a cell. We support this functions in the /stock/{symbol}/quote and /stock/{symbol}/stats endpoints, and in the Balance Sheet, Cash Flow, Dividends, Financials, and Income core dataset endpoints:

Example: Pull latest price for Apple

=WEBSERVICE("https://cloud.iexapis.com/v1/stock/aapl/quote/latestPrice?token=YOUR_TOKEN_HERE")

IEX Cloud Legacy provides an example Excel file that can be used to see how the web service function works.

Download it here - the Excel webservice function only works on Excel for Windows.

Please note, the highlighted column for latestUpdate is a formula that converts the Unix timestamp into an Excel date/time. To get this to work you must enter your token in column B1. And make sure to refresh your workbook (CTRL + ALT + F9).

Google Sheets

Google Sheets provides IMPORT functions to populate cells with data.

Example: Pull latest price for Apple

=IMPORTDATA("https://cloud.iexapis.com/v1/stock/aapl/quote/latestPrice?token=YOUR_TOKEN_HERE")

Example: Next earnings report date for Apple

=IMPORTDATA("https://cloud.iexapis.com/v1/stock/aapl/estimates/1/reportDate?token=YOUR_TOKEN_HERE")

CSV Files

You can also return most endpoints in CSV format by using the query parameter format=csv.

https://cloud.iexapis.com/v1/stock/aapl/quote?token=YOUR_TOKEN_HERE&format=csv

Developer Tools and Open Source

Client Libraries

IEX Cloud has a growing set of official and unofficial client libraries, open source apps, and integrations. More information is available on our Developer Community Page.

Official Libraries

Our official libraries are actively maintained by both IEX Cloud and the open source community. If you’re interested in a language not covered here, reach via our community page and/or vote on the corresponding tickets on our unofficial roadmap.

Name	Language	GitHub	Install
pyEX	Python
iexjs	JavaScript

Testing Sandbox ^Deprecated

IEX Cloud Legacy provides all accounts a free, unlimited use sandbox for testing. Every account will be assigned two test tokens available via the Console. All sandbox endpoints function the same as production, so you will only need to change the base url and token.

We’ve also updated the Usage Report to allow you to view the number of test credits the same way as production credit usage.

How to Use

• The base url is https://sandbox.iexapis.com
• You can also test SSE with https://sandbox-sse.iexapis.com
• Your test token is available on the console by click the “View Test Data” toggle in the nav.
• All tier features are enforced at this time, but you are not limited by the number of calls you can make. You are not charged for test usage.

Test tokens look like Tpk_ and Tsk_

To make a call for test data, use the same url, but pass your test token.

API Usage

Common functionality across all APIs.

Query Parameters

• Parameter values must be comma-delimited when requesting multiple.
  • (e.g., symbols=SNAP,fb is correct.)
• Case does not matter when passing values to a parameter unless specified in the docs.
  • (e.g., Both symbols=fb and symbols=FB work.)
• Make sure to URL-encode values.
  • (e.g., symbols=AIG+ encoded is symbols=AIG%2b.)

Data Formats

Some endpoints support a format parameter to return data in a format other than the default JSON.

Supported formats

Filter Results

Some endpoints support a filter parameter to return a subset of data. Pass a comma-delimited list of response attributes to filter. Response attributes are case-sensitive and are listed in each endpoint reference document’s Response Attributes section.

Example: filter=symbol,volume,lastSalePrice returns only these three specified attributes.

Result Schema

In many cases, you may want to know the type of returned data. For example, you want to build a SQL table from endpoint results and you want to know/verify column types.

Some endpoints support a schema parameter to return just the types of the result set. Simply pass in the schema=true query parameter and the endpoint returns an array of column names and data types from a resulting data record.

Time Series

Time Series Endpoint

Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.

To use this endpoint, you’ll first make a free call to get an inventory of available time series data.

HTTP REQUEST

# List all available time series data
GET /time-series

RESPONSE

{
  "id": "REPORTED_FINANCIALS",
  "description": "Reported financials",
  "key": "a valid symbol",
  "subkey": "10-K,10-Q",  
  "schema": {
    "type": "object",
    "properties": {
      "formFiscalYear": {
        "type": "number"
      },
      "formFiscalQuarter": {
        "type": "number"
      },
      "version": {
        "type": "string"
      },
      "periodStart": {
        "type": "string"
      },
      "periodEnd": {
        "type": "string"
      },
      "dateFiled": {
        "type": "string"
      },
      "reportLink": {
        "type": "string"
      },
      "adsh": {
        "type": "string"
      },
      "stat": {
        "type": "object"
      }
    }
  },
  "weight": 5000,
  "created": "2019-06-04 21:32:20",
  "lastUpdated": "2019-06-04 21:32:20"
}

A full inventory of time series data is returned by calling /time-series without a data id. The data structure returned is an array of available data sets that includes the data set id, a description of the data set, the data weight, a data schema, date created, and last updated date. The schema defines the minimum data properties for the data set, but note that additional properties can be returned. This is possible when data varies between keys of a given data set.

Each inventory entry may include a key and subkey which describes what can be used for the key or subkey parameter.

Once you find the data set you want, use the id to query the time series data.

HTTP REQUEST

# Get time series data
GET /time-series/{id}/{key?}/{subkey?}

Time series data is queried by a required data set id. For example, “REPORTED_FINANCIALS”. Some time series data sets are broken down further by a data set key. This may commonly be a symbol. For example, REPORTED_FINANCIALS accepts a symbol such as AAPL as a key. Data sets can be even further broken down by sub key. For example, REPORTED_FINANCIALS data set with the key AAPL can have a sub key of 10-Q or 10-K.

Keys and sub keys will be defined in the data set inventory.

Data Weighting (applicable only to legacy price plans)

The time series inventory call is Free
Time series data weight is specified in the inventory call and applied per array item (row) returned.

Data Timing

Varies

Data Schedule

Varies

Data Source(s)

Varies

Notes

Access to each data point will be based on the source Stocks endpoint

Available Methods

GET /time-series
GET /time-series/{id}/{key?}/{subkey}

Examples

• /time-series/REPORTED_FINANCIALS/AAPL
• /time-series/REPORTED_FINANCIALS/AAPL/10-K
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?range=1y
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?range=next-week&calendar=true
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?last=2
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?first=3
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2018-01-01&to=2019-06-01
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2016-01-01&limit=10
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?on=2016-01-01
• /time-series/REPORTED_FINANCIALS/AAPL/10-Q?from=2010-01-01&interval=2&format=csv
• /time-series/FUNDAMENTALS/AAPL?limit=1&subattribute=fiscalQuarter|3,fiscalYear|2020

Path Parameters

Query Parameters

Supported Ranges

Response Attributes

Time series call returns an array of objects. The data returned varies by dataset ID, but each will contain common attributes.

Time series inventory call returns:

Time Series Metadata ^BETA

Time-Series presents us a with a powerful query interface on top of our data, while the inventory calls allow us to know the shape of the data contained therein. But sometimes we want to answer questions like “What are all the possible values of key for the time series id FUNDAMENTALS?” or “What time series ids contain data on AAPL?”

For these, we have time series metadata.

HTTP REQUEST

GET /metadata/time-series/{id}/{key?}/{subkey?}

RESPONSE

// metadata/time-series
[
  {
    "id":"ADVANCED_BONUS",
    "value":"ADVANCED_BONUS",
    "numberOfRecords":5149
  },
  {
    "id":"ADVANCED_DISTRIBUTION",
    "value":"ADVANCED_DISTRIBUTION",
    "numberOfRecords":1093
  },
  // ...
]

// metadata/time-series/FUNDAMENTALS
[
  {
    "key":"A",
    "value":"A",
    "numberOfRecords":127
  },
  {
    "key":"AA",
    "value":"AA",
    "numberOfRecords":41
  },
  {
    "key":"AAIC",
    "value":"AAIC",
    "numberOfRecords":108
  },
  // ...

// metadata/time-series/*/AAPL
[
  {
    "id":"ADVANCED_BONUS",
    "value":"ADVANCED_BONUS",
    "numberOfRecords": 3
  },
  {
    "id":"ADVANCED_DIVIDENDS",
    "value":"ADVANCED_DIVIDENDS",
    "numberOfRecords":36
  },
  {
    "id":"ADVANCED_SPLITS",
    "value":"ADVANCED_SPLITS",
    "numberOfRecords": 1
  },
  // ...
]

Data Weighting (applicable only to legacy price plans)

The time series metadata call is Free.

Data Timing

Varies

Data Schedule

Varies

Data Source(s)

Varies

Available Methods

GET /metadata/time-series/{id}/{key?}/{subkey}

Examples

• /metadata/time-series/REPORTED_FINANCIALS
• /metadata/time-series/*/AAPL

Path Parameters

Calendar

Using the time series calendar parameter, you can use short-hand codes to pull future event data such as tomorrow, next-week, this-month, next-month, and more.

Subset of time series parameters used for calendar

Supported calendar ranges

Points and Files

Data Points let you access individual data values, while Files lets you conveniently access pregenerated files.

Data Points

Data points are available per symbol and return individual plain text values. Retrieving individual data points is useful for Excel and Google Sheet users, and applications where a single, lightweight value is needed. Some endpoints provide update times; this allows you to call an endpoint only once it has new data.

To use this endpoint, first make a free call to list all available data points for your desired symbol, which can be a security or data category.

HTTP REQUEST

# List available data keys
GET /data-points/{symbol}

RESPONSE

[
    {
        "key": "BETA",
        "weight": 1,
        "description": "",
        "lastUpdated": "2022-07-29T09:46:08+00:00"
    },
    {
        "key": "ACCOUNTSPAYABLE",
        "weight": 3000,
        "description": "Balance Sheet: accountsPayable",
        "lastUpdated": "2022-05-09T12:47:55+00:00"
    },
    {
        "key": "CAPITALSURPLUS",
        "weight": 3000,
        "description": "Balance Sheet: capitalSurplus",
        "lastUpdated": "2022-05-09T12:47:55+00:00"
    }
]

Once you find the data point you want, use the key to fetch the individual data point value.

HTTP REQUEST

# Get a data point
GET /data-points/{symbol}/{key}

Data Weighting (applicable only to legacy price plans)

List available data keys Free
Get a data point: The weight specified in the data list.

Data Timing

Varies

Data Schedule

Varies

Data Source(s)

Varies

Notes

Access to each data point is based on the source Stocks endpoint.

Available Methods

• GET /data-points/{symbol}
• GET /data-points/{symbol}/{key}

Examples

• /data-points/aapl/ACCOUNTSPAYABLE

Response Attributes

Data point calls return a single plain text value.

Available data keys calls return:

Files

The Files API allows users to download bulk data files, PDFs, etc.

Lookup Available Files

HTTP REQUEST

# List all available file types
GET /files

RESPONSE

[
  {
    "id": "VALUENGINE_REPORT",
    "metadata": {
      "weight": "PREMIUM_VALUENGINE_REPORT",
      "bySymbol": true,
      "byDate": true,
      "numberOfDownloads": 3,
      "source": "ValueEngine",
      "contentType": "text/pdf",
      "extension": "pdf",
      "tags": [ ],
      "categories": [ ]
    },
    "lastUpdated": "2020-03-20T15:15:03+00:00"
  },

]

Lookup Available Symbols and/or Dates for File Types

For files that have bySymbol = true or byDate = true, this call will show what symbols and dates are available.

HTTP REQUEST

# List all available file types
GET /files/info/:id

RESPONSE

{
  "symbols": [],
  "dates": []
}

Download a file

This call returns an HTTP redirect to a one time secure URL. The URL expires after 1 minute.

HTTP REQUEST

# List all available file types
GET /files/download/:id?symbol={symbol}&date={date}

HTTP Redirect response

If the file schema specifies bySymbol = true, then pass a {symbol} query parameter.
If the file schema specifies byDate = true, then pass a {date} query parameter the format "YYYYMMDD".

Batch Requests

HTTP REQUEST

GET /stock/{symbol}/batch

RESPONSE

// .../symbol
{
  "quote": {...},
  "news": [...],
  "chart": [...]
}

// .../market
{
  "AAPL" : {
    "quote": {...},
    "news": [...],
    "chart": [...]
  },
  "FB" : {
    "quote": {...},
    "news": [...],
    "chart": [...]
  },
  // { ... }
}

Data Weighting (applicable only to legacy price plans)

Based on each type of call

Examples

• /stock/aapl/batch?types=quote,news,chart&range=1m&last=10
• /stock/market/batch?symbols=aapl,fb,tsla&types=quote,news,chart&range=1m&last=5

Path Parameters

Query Parameters

Response Attributes

Responses vary based on types requested. Refer to each endpoint for details.

Streaming Data

SSE Streaming

NOTE: Only included with paid subscription plans

We support Server-sent Events (SSE Streaming) for streaming data as an alternative to WebSockets. You will need to decide whether SSE streaming is more efficient for your workflow than REST calls. In many cases streaming is more efficient since you will only receive the latest available data. If you need to control how often you receive updates, then you may use REST to set a timed interval.

Snapshots

When you connect to an SSE endpoint, you should receive a snapshot of the latest message, then updates as they are available. You can disable this feature by passing a url parameter of nosnapshot=true.

You can also specify a starting point for a snapshot by passing a url parameter of snapshotAsOf=EPOCH_TIMESTAMP where the value is in milliseconds since Epoch.

Curl Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUS\?symbols\=spy\&token\=YOUR_TOKEN

Curl Firehose Example

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUS\?token\=YOUR_TOKEN

Curl Example (Not authorized by UTP)

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUSNoUTP\?symbols\=spy\&token\=YOUR_TOKEN

Curl Firehose Example (Not authorized by UTP)

curl --header 'Accept: text/event-stream' https://cloud-sse.iexapis.com/stable/stocksUSNoUTP\?token\=YOUR_TOKEN

How Credits Are Counted

We use a reserve system for streaming endpoints due to high data rates. This is similar to how a credit card puts a hold on an account and reconciles the amount at a later time.

When you connect to an SSE endpoint, we will validate your API token, then attempt to reserve an amount of credits from your account. For example, 1000 credits.

If you have enough credits in your quota (if you have pay-as-you-go enabled on our legacy plans), we will allow data to start streaming.

We keep track of the number of messages streamed to your account during our reserve interval.

Once our reserve interval expires, we will reconcile usage. This means we will compare how many credits worth of messages were sent versus the number of credits we reserved. For example, if we delivered 1200 credits worth of messages, you would have used 200 more than we reserved, so we will apply 200 additional credits to your account. If we only delivered 100 credits worth of messages, we would add the 900 unused credits back to your account.

After we reconcile the credits, we will attempt another reserve.

The reserve and reconcile process is seamless and does not impact your data stream. If we attempt to reserve credits and your account does not have enough quota (and pay-as-you-go disabled on legacy accounts), then we will disconnect your connection. You can avoid service disruptions by ensuring you have sufficient credits, either by purchasing additional packages or, on legacy plans, by enabling pay-as-you-go.

When you disconnect from an endpoint, we will reconcile your credit usage immediately.

Firehose

Scale and Business plan users can firehose stream all symbols (excluding DEEP endpoints) by leaving off the symbols parameter.

Interval Streaming

Some SSE endpoints are offered on set intervals such as 1 second, 5 seconds, or 1 minute. This means we will send out messages no more than the interval subscribed to. This helps make message delivery more predictable.

Supported Endpoints

# Stock Quotes
# Firehose can be about 100 million credits worth of messages per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes No UTP
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUSNoUTP?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes OTC
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksOTC?token=YOUR_TOKEN&symbols=otcm'

# Stock Quotes every 1 second
# Can be up to 54,000 credits worth of messages per symbol per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS1Second?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 1 second no UTP
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUSNoUTP1Second?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 1 second OTC
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksOTC1Second?token=YOUR_TOKEN&symbols=otcm'

# Stock Quotes every 5 seconds
# Can be up to 10,800 credits worth of messages per symbol per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS5Second?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 5 seconds no UTP
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUSNoUTP5Second?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 5 seconds OTC
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksOTC5Second?token=YOUR_TOKEN&symbols=otcm'

# Stock Quotes every 1 minute
# Can be up to 900 credits worth of messages per symbol per day
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUS1Minute?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 1 minute no UTP
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksUSNoUTP1Minute?token=YOUR_TOKEN&symbols=spy'

# Stock Quotes every 1 minute OTC
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/stocksOTC1Minute?token=YOUR_TOKEN&symbols=otcm'

# Social Sentiment
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/sentiment?token=YOUR_TOKEN&symbols=spy'

# Forex / Currencies
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/forex?token=YOUR_TOKEN&symbols=USDCAD'

# News
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/news-stream?token=YOUR_TOKEN&symbols=spy'

# IEX TOPS
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/tops?token=YOUR_TOKEN&symbols=spy'

# IEX TOPS 1 second
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/tops1second?token=YOUR_TOKEN&symbols=spy'

# IEX LAST
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/last?token=YOUR_TOKEN&symbols=spy,aapl,tsla'

# IEX LAST 1 second
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/last1second?token=YOUR_TOKEN&symbols=spy,aapl,tsla'

# IEX DEEP
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=deep'

# IEX DEEP by channel
curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=auction'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=book'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=op-halt-status'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=official-price'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=security-event'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=trades'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=trade-breaks'

curl --header 'Accept: text/event-stream' 'https://cloud-sse.iexapis.com/stable/deep?token=YOUR_TOKEN&symbols=spy&channels=trading-status'

Node.js SSE client example

'use strict';
const request = require('request');
var stream;
var partialMessage;

function connect() {
  stream = request({
    url: 'https://cloud-sse.iexapis.com/stable/stocksUSNoUTP?token=YOUR_TOKEN&symbols=spy,ibm,msft',
    headers: {
      'Content-Type': 'text/event-stream'
    }
  })
}
connect();

stream.on('socket', () => {
  console.log("Connected");
});

stream.on('end', () => {
  console.log("Reconnecting");
  connect();
});

stream.on('complete', () => {
  console.log("Reconnecting");
  connect();
});

stream.on('error', (err) => {
  console.log("Error", err);
  connect();
});

stream.on('data', (response) => {
  var chunk = response.toString();
  var cleanedChunk = chunk.replace(/data: /g, '');

  if (partialMessage) {
    cleanedChunk = partialMessage + cleanedChunk;
    partialMessage = "";
  }

  var chunkArray = cleanedChunk.split('\r\n\r\n');

  chunkArray.forEach(function (message) {
    if (message) {
      try {  
        var quote = JSON.parse(message)[0];
        console.log(quote);
      } catch (error) {
        partialMessage = message;
      }
    }
  });
});

function wait () {
  setTimeout(wait, 1000);
};

wait();

Rules Engine

Account

Credit Budget

Used to set an upper limit, “credit budget”, on pay as you go credits where you want to make sure not to go above a certain amount. Set the total credits you wish to consume for the month, and once that limit is reached, all API calls will stop until the limit is removed or increased.

HTTP REQUEST

POST /account/creditbudget

Data Weighting

Free

Notes

Requires SK token to access

Available Methods

POST /account/creditbudget

Query Parameters

Token Credit Limit

Set monthly credit limits for your publishable API tokens.

HTTP REQUEST

POST /account/tokenlimit

Data Weighting

Free

Notes

Requires SK token to access

Available Methods

POST /account/tokenlimit

Query Parameters

Metadata

Used to retrieve account details such as current tier, payment status, credit quota usage, etc.

HTTP REQUEST

GET /account/metadata

RESPONSE

{
  "payAsYouGoEnabled": true,
  "effectiveDate": 1547590582000,
  "endDateEffective": 1547830921000,
  "subscriptionTermType": "monthly",
  "tierName": "launch",
  "messageLimit": 1000000000, // Legacy field
  "creditLimit": 1000000000,
  "messagesUsed": 215141655, // Legacy field
  "creditsUsed": 215141655,
  "circuitBreaker": 3000000000
}

Data Weighting

Free

Data Timing

Free plans End of day
Paid plans Real-time

Notes

Requires SK token to access

Available Methods

GET /account/metadata

Pay As You Go

Used to toggle Pay-as-you-go on your account.

HTTP REQUEST

POST /account/payasyougo

Data Weighting

Free

Notes

Requires SK token to access

Available Methods

POST /account/payasyougo

Query Parameters

Signed Requests

Making your first Signed REST API requires a little more effort. This approach has been heavily based on Amazon’s V4 signing approach. The basic idea is to take your secret key, and use that to generate a cryptographic fingerprint of all aspects of your request, so they can be verified by the server, so the interception of the data over the network does not compromise your account. However, you must take care that your secret key for your publishable key is not compromised!

You will need:

• Your publishable token which is found in the console
• Your secret key for your publishable token, can be found below using the GET /account/signed API call
• The URL for the type of data you would like to request

Signed REST calls are made up of:

• Base url. Example: https://cloud.iexapis.com
• Version. Example: beta
• Token. All REST requests require a valid token and can be added to a url like ?token=YOUR_TOKEN_HERE
• The authorization header
• The x-iex-date header

Setting Up Signed Token

Signs a token, so it will require signed headers when a request is made using this token.

HTTP REQUEST

POST content-type:application/json { "token" : "SK_TOKEN", "tokenToSign" : "PK/SK_TOKEN_TO_BE_SIGNED", ("unsign" : true) } /account/signed

RESPONSE

{
  "secret" : "e2700e6b-3be0-4f31-a408-61365caa263a",
  "signedToken" : "pk_6b95e1fac3114f0392a5becd4d8f08e1"
}

Data Weighting

Free

Notes

• Requires SK token to access
• Only available to Grow, Scale, and Business plans

Examples

See below

Response Attributes

Getting the Secret for a Signed Token

Returns the secret for a token, thus making it “signed”.

HTTP REQUEST

GET /account/signed?token=SK_TOKEN&signedToken=TOKEN

RESPONSE

{
  "secret" : "e2700e6b-3be0-4f31-a408-61365caa263a",
}

Data Weighting

Free

Notes

• Requires SK token to access
• Only available to Grow, Scale, and Business plans

Examples

See below

Response Attributes

Examples on How to Make a Signed Request:

NODE.JS EXAMPLE

#!/usr/bin/env node

/*
Copyright 2019-2020 iexcloud. or its affiliates. All Rights Reserved.

This file is licensed under the Apache License, Version 2.0 (the "License").
You may not use this file except in compliance with the License. A copy of the
License is located at

https://www.apache.org/licenses/LICENSE-2.0

This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
OF ANY KIND, either express or implied. See the License for the specific
language governing permissions and limitations under the License.
*/

const moment = require('moment');
const crypto = require('crypto');
const https  = require('https');

const method = 'GET'
const host = 'cloud.iexapis.com'

const access_key = process.env.IEX_PUBLIC_KEY // public key
const secret_key = process.env.IEX_SECRET_KEY // secret key for public key

const canonical_querystring = 'token=' + access_key ;
const canonical_uri = '/v1/stock/aapl/company'

var ts = moment.utc();
const iexdate = ts.format("YYYYMMDDTHHmmss") + 'Z';
const datestamp = ts.format("YYYYMMDD");

function sign(secret, data) {
    return crypto.createHmac('sha256', secret).update(data, "utf8").digest('hex');
};

function getSignatureKey(key, datestamp) {
    const signedDate = sign(key, datestamp);
    return sign(signedDate, 'iex_request');
}

if ( ! access_key || ! secret_key ) {
    console.warn('No access key is available.')
    process.exit(1);
}

const canonical_headers = 'host:' + host + '\n' + 'x-iex-date:' + iexdate + '\n';
const signed_headers = 'host;x-iex-date'
const payload = '';
const payload_hash = crypto.createHash('sha256').update(payload).digest('hex');
const canonical_request = method + '\n' + canonical_uri + '\n' + canonical_querystring + '\n' + canonical_headers + '\n' + signed_headers + '\n' + payload_hash;
const algorithm = 'IEX-HMAC-SHA256';
const credential_scope = datestamp + '/' + 'iex_request';
const string_to_sign = algorithm + '\n' +  iexdate + '\n' +  credential_scope + '\n' + crypto.createHash('sha256').update(canonical_request, "utf8").digest('hex');
const signing_key = getSignatureKey(secret_key, datestamp)
const signature = crypto.createHmac('sha256', signing_key).update(string_to_sign, "utf8").digest('hex');
const authorization_header = algorithm + ' ' + 'Credential=' + access_key + '/' + credential_scope + ', ' +  'SignedHeaders=' + signed_headers + ', ' + 'Signature=' + signature
const headers = {'x-iex-date':iexdate, 'Authorization':authorization_header}

const options = {
    host: host,
    port: 443,
    path: canonical_uri + "?" + canonical_querystring,
    method: 'GET',
    headers: headers
};

const req = https.request(options, function(res) {
    res.setEncoding('utf8');
    res.on('data', function(chunk) {
        var parsed = JSON.parse(chunk);
        console.log(parsed);
    });
});
req.end();

PYTHON EXAMPLE

#!/usr/bin/env python

# Copyright 2019-2020 iexcloud. or its affiliates. All Rights Reserved.
#
# This file is licensed under the Apache License, Version 2.0 (the "License").
# You may not use this file except in compliance with the License. A copy of the
# License is located at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
# OF ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.

import sys, os, base64, datetime, hashlib, hmac
import requests # pip install requests

# ************* REQUEST VALUES *************
method = 'GET'
host = 'cloud.iexapis.com'

access_key = os.environ.get('IEX_PUBLIC_KEY')
secret_key = os.environ.get('IEX_SECRET_KEY')

canonical_querystring = 'token=' + access_key
canonical_uri = '/v1/stock/aapl/company'
endpoint = "https://" + host + canonical_uri

def sign(key, msg):
    return hmac.new(key, msg.encode('utf-8'), hashlib.sha256).hexdigest()

def getSignatureKey(key, dateStamp):
    kDate = sign(key, dateStamp)
    return sign(kDate, 'iex_request')

if access_key is None or secret_key is None:
    print('No access key is available.')
    sys.exit()

t = datetime.datetime.utcnow()
iexdate = t.strftime('%Y%m%dT%H%M%SZ')
datestamp = t.strftime('%Y%m%d') # Date w/o time, used in credential scope
canonical_headers = 'host:' + host + '\n' + 'x-iex-date:' + iexdate + '\n'
signed_headers = 'host;x-iex-date'
payload_hash = hashlib.sha256(('').encode('utf-8')).hexdigest()
canonical_request = method + '\n' + canonical_uri + '\n' + canonical_querystring + '\n' + canonical_headers + '\n' + signed_headers + '\n' + payload_hash
algorithm = 'IEX-HMAC-SHA256'
credential_scope = datestamp + '/' + 'iex_request'
string_to_sign = algorithm + '\n' +  iexdate + '\n' +  credential_scope + '\n' +  hashlib.sha256(canonical_request.encode('utf-8')).hexdigest()
signing_key = getSignatureKey(secret_key, datestamp)
signature = hmac.new(signing_key, (string_to_sign).encode('utf-8'), hashlib.sha256).hexdigest()
authorization_header = algorithm + ' ' + 'Credential=' + access_key + '/' + credential_scope + ', ' +  'SignedHeaders=' + signed_headers + ', ' + 'Signature=' + signature

headers = {'x-iex-date':iexdate, 'Authorization':authorization_header}

# ************* SEND THE REQUEST *************
request_url = endpoint + '?' + canonical_querystring

print('\nBEGIN REQUEST++++++++++++++++++++++++++++++++++++')
print('Request URL = ' + request_url)
r = requests.get(request_url, headers=headers)

print('\nRESPONSE++++++++++++++++++++++++++++++++++++')
print('Response code: %d\n' % r.status_code)
print(r.text)

Usage

Used to retrieve current month usage for your account.

HTTP REQUEST

GET /account/usage/{type}

RESPONSE

{
  "monthlyUsage": 215200,
  "monthlyPayAsYouGo": 0,
  "dailyUsage": {
    "20190120": 115200, 
    "20190121": 100000
  },
  "tokenUsage": {
    "pk_123": 215200
  },
  "keyUsage": {
    "IEX_STATS": 0, 
    "EARNINGS": 115200, 
    "STOCK_QUOTES": 100000
  }
}

Data Weighting

Free

Data Timing

Real-time

Notes

• Requires SK token to access
• Billing resets on the first of every month at 00:00:00 UTC

Available Methods

GET /account/usage/{type}

Path Parameters

API System Metadata

Status

Used to retrieve current system status.

HTTP REQUEST

GET /status

RESPONSE

{
  "status": "up",
  "version": "1.32",
  "time": 1607979129127,
  "currentMonthAPICalls": 14225180421
}

Data Weighting (applicable only to legacy price plans)

Free

Data Timing

Real-time

Available Methods

GET /status

Notes

No token required

Changelog

The following is a list of running updates to the IEX API.

V1

2023-02-10

The Apperate UI and Rules Engine API have been updated for the following capabilities:

• Ability to write rules on private (My Workspace) data
• A rule is no longer limited to just one symbol

When using the Rules Engine API to edit a rule or create new rule, please note the following parameter changes:

• ruleset has been removed and is replaced by index.
• index has been added. It is an array that accomodates multiple data points Core Data or private (My Workspace) datasets–rules are no longer limited to Core Data and 1 symbol.
• conditions references index values and not just field conditions.

2023-01-25

• Remove the cryptocurrency endpoints, including the cryptocurrency SSE streaming endpoint.

2023-01-13

• Deprecate the cryptocurrency endpoints, including the cryptocurrency SSE streaming endpoint.

2022-10-03

• Deprecate the Premium Legacy endpoints, including these:

  • Audit Analytics
  • Audit Analytics Accounting Quality and Risk Matrix
  • Audit Analytics Director and Officer Changes
  • Fraud Factors
  • Non-Timely Filings
  • Kavout
  • K Score For China A-Shares
  • K Score For US Equities
  • Precision Alpha
  • Precision Alpha Price Dynamics
  • Refinitiv - Earnings
  • Refinitiv - Estimates
  • Refinitiv - Price Target
  • Analyst Recommendations
  • Refinitiv - Refinitiv

2021-08-26

• Fraud Factors Similarity Index endpoint and data was disabled/removed.

2021-08-16

• Fraud Factors Non-timely filings credit cost increased from 1 to 1,000 (premium endpoint)

2021-07-25

• Simplify naming convention for Dividends, Splits, and Stats. Each has 2 endpoints, a “Basic” version (or Key Stats for Stats) and a normal version, with the normal version including more information.

2021-07-15

• Updated prices for several endpoints and added 1 credit cost per API call.

2021-07-13

• Add Fundamental Valuations
• EOD Futures and EOD Options V2 reduced weight to 10 per record

2021-06-07

• Added new time series metadata endpoints
• Updated new Options and Futures refdata endpoints
• Deprecated relevant endpoint, use peers instead
• Updated IPO endpoint for new data provider, see IPO Calendar V2
• Added documentation for schema query parameter

2021-06-01

• Added new Options refdata and historical data endpoints
• Added new Futures refdata and historical data endpoints
• Deprecated old options endpoints

2021-05-12

• Premium Data: Added additional data to Estimates
• Added quarter/half/year options to range parameter for various time series endpoints.

2021-05-05

• Core Data: Add Futures Symbols
• Update: Upcoming events now supports querying for an exact date, to facilitate building better calendars and limiting overall credit cost

2021-04-05

• Added additional US treasuries
• Update: US treasury rate reduced from 1,000 per record to 100
• Update: Economic data rate reduced from 1,000 per record to 100
• Update: Mortgate data rate reduced from 1,000 per record to 100

2021-03-05

• Core Data: Added RIC Mapping

2021-02-11

• Core Data: Added pre and post market lists for UTP approved users.
• Core Data: Added two query parameters to Technical Indicators. indicatorOnly and lastIndicator

2021-01-27

• Premium Data: Added New Constructs research reports

2021-01-25

• Core Data: nextEarningsDate has been added back to Basic Stats and Stats

2020-08-10

• Premium Data: Stocktwits data readded as premium data.

2020-06-22

• Update: Giant Machines stock price widget weight reduced to 5

2020-06-01

• Removed: Intraday social sentiment from StockTwits is no longer available. Historical data is still available before June 1.

2020-04-07

• Premium Data: Added Kavout K-Score for China A-Shares

2020-03-20

• Premium Data: Added ValuEngine Stock Research Reports

2020-03-18

• Core Data: Added highTime, highSource, lowTime, lowSource, iexOpen, iexOpenTime, iexClose, iexCloseTime attributes to Stock Quote

2020-03-17

• Premium Data: Added BRAIN language metrics data

2020-03-16

• Premium Data: Added Audit Analytics data

2020-03-13

• Premium Data: Added Kavout data

2020-03-12

• Premium Data: Added Giant Machines stock price widget

2020-03-04

• Rules Engine: Beta API endpoints and documentation

2020-03-03

• Console: Added the ability to enable/disable premium data access per API token

2020-02-28

• Core Data: Added figi and cik to ref data
• Core Data: Added fiscalDate and currency to Balance Sheet
• Core Data: Added fiscalDate and currency to Cash Flow
• Core Data: Added fiscalDate and currency to Financials
• Core Data: Added fiscalDate and currency to Income Statement
• Core Data: Added currency to Price Targets

2020-02-27

• Premium Data: Added Brain Company 21 day ranking

2020-02-07

• Premium Data: Added Brain Company to premium data

2020-02-03

• Core Data: Added odd lot trades to Stock Quote

2020-01-17

• Premium Data: Added Precision Alpha to premium data

2019-12-09

• Rules Engine: Max number of rules per account changed from 10 to 500. Creating a rule remains free during the beta.

2019-12-05

• Premium Data: Added ExtractAlpha to premium data

2019-11-26

• Core Data: Added putCallRatio to the Stats endpoint

2019-11-25

• Core Data: Added Bonus Issue corporate actions endpoint
• Core Data: Added Distribution corporate actions endpoint
• Core Data: Added Return of Capital corporate actions endpoint
• Core Data: Added Rights Issue corporate actions endpoint
• Core Data: Added Right to Purchase corporate actions endpoint
• Core Data: Added Security Reclassification corporate actions endpoint
• Core Data: Added Security Swap corporate actions endpoint
• Core Data: Added Spinoff corporate actions endpoint
• Core Data: Added Splits corporate actions endpoint
  
  
• Core Data: Added historical time series data to the Daily Treasury Rates endpoint
• Core Data: Added historical time series data to the Oil Prices endpoint
• Core Data: Added historical time series data to the Natural Gas Prices endpoint
• Core Data: Added historical time series data to the Jet Fuel Prices endpoint
• Core Data: Added historical time series data to the Diesel Price endpoint
• Core Data: Added historical time series data to the Propane Prices endpoint
• Core Data: Added historical time series data to the Gas Prices endpoint
  
  
• Core Data: Added historical time series data to the Unemployment endpoint
• Core Data: Added historical time series data to the Total Housing Starts endpoint
• Core Data: Added historical time series data to the Mortgage Rates endpoint
• Core Data: Added historical time series data to the Real GDP endpoint

2019-11-20

• Rules Engine beta now available to paid plans. Collecting early user feedback.

2019-11-15

• Added subattribute and dateField parameters to Time Series
• Added 1 second, 5 second, and 1 minute conflation rates for forex real time streaming

2019-11-14

• Added retail money funds endpoint
• Added institutional money funds endpoint
• Added initial claims endpoint

2019-11-12

• Added Dividends endpoint. This greatly expands available dividends data and extends history to 12+ years.

2019-11-08

• Added historical news endpoint
• Added Fraud Factors to Premium Data.
• Fraud Factors Similarity Index endpoint
• Fraud Factors Non-Timely Filings endpoint

2019-11-07

• Added annual earnings and estimates where previously only quarterly was available.

2019-11-01

• Added calendar and range functionality to the time series endpoint. Now you can use short hand to query backwards or forward in time.

2019-10-29

• Introduced Premium Data on IEX Cloud
• Added Wall Street Horizon to Premium Data

2019-10-23

• Expanded dividends by 39k symbols and over 500k records

2019-10-14

• Added historical commodities endpoints

2019-10-11

• Core Data: Added Real-time forex streaming endpoint
• Core Data: Added Currency conversion endpoint
• Core Data: Added Latest fx rate endpoint
• Core Data: Added Historical daily currency rates endpoint
• Core Data: Added total vehicle sales economic data
• Core Data: Added US Recession Probabilities economic data
• Core Data: Added total housing starts economic data

2019-10-10

• Core Data: Technical Indicators endpoints

2019-10-01

• Core Data: Cryptocurrency Quote endpoint and SSE streaming for 500+ coins
• Core Data: Cryptocurrency Events SSE streaming
• Core Data: Cryptocurrency Book endpoint
• Core Data: Cryptocurrency Price endpoint

2019-09-20

• includeToday parameter added to historical prices endpoint
• sort parameter added to historical prices and intraday prices endpoints
• chartIEXWhenNull parameter added to intraday prices and endpoints

2019-09-09

• Added address information to company endpoint

2019-08-15

• Added 1mm and 5dm historical price ranges

2019-08-10

• Added lastTradeTime to Stock Quote
• Added volume to Stock Quote
• Added previousVolume to Stock Quote

2019-07-31

• Docs updated to reflect Nasdaq UTP 15 minute delayed price restrictions

2019-07-18

• Launched Cloud Cache, a fully managed data cache to help efficiently consume messages on IEX Cloud without your own data infrastructure.

2019-07-15

• Changes to 15 minute delayed (intraday) data for Nasdaq listed stocks for Start tier.

2019-07-01

• Added Search endpoint. Search across all symbols. Great for building autocomplete search box.

2019-06-14

• Added Time Series endpoint
• Added 10 years of as reported financials in Time Series

2019-06-03

• Added Tel Aviv Stock Exchange (TAE) EOD prices
• Added Korea Stock Exchange (KRX) EOD prices

2019-05-28

• Added message circuit breaker to Account endpoints to set a cutoff for pay as you go messages. Console will be updated soon with a UI to update message circuit breaker.
• Added ISIN endpoint to convert ISIN to IEX Cloud symbols.
• Added latest-financial-quarterly-report-date to Data Points.
• Added latest-financial-annual-report-date to Data Points.

2019-05-16

• Added Bombay Stock Exchange (BSE Ltd.) EOD prices

2019-05-15

• Updated company descriptions

2019-05-10

• Added symbol search to Console. This feature will expand over time, but initially searches only US stocks.

2019-04-30

• Added Options symbols ref data
• Added new market wide, macro data to Data Points. https://cloud.iexapis.com/stable/data-points/market
• Added 30 year treasury rate /stable/data-points/market/DGS30
• Added 20 year treasury rate /stable/data-points/market/DGS20
• Added 10 year treasury rate /stable/data-points/market/DGS10
• Added 5 year treasury rate /stable/data-points/market/DGS5
• Added 2 year treasury rate /stable/data-points/market/DGS2
• Added 1 year treasury rate /stable/data-points/market/DGS1
• Added 6 month treasury rate /stable/data-points/market/DGS6MO
• Added 3 month treasury rate /stable/data-points/market/DGS3MO
• Added 1 month treasury rate /stable/data-points/market/DGS1MO
• Added mortgage rate 15 year fixed /stable/data-points/market/MORTGAGE15US
• Added mortgage rate 30 year fixed /stable/data-points/market/MORTGAGE30US
• Added mortgage rate 5/1 year adjustable /stable/data-points/market/MORTGAGE5US
• Added federal funds rate /stable/data-points/market/FEDFUNDS
• Added non-farm payrolls /stable/data-points/market/PAYEMS
• Added consumer price index /stable/data-points/market/CPIAUCSL
• Added industrial production index /stable/data-points/market/INDPRO
• Added real gross domestic product /stable/data-points/market/A191RL1Q225SBEA
• Added commercial paper outstanding /stable/data-points/market/COMPOUT
• Added unemployment rate /stable/data-points/market/UNRATE
• Added CD rate non-jumbo /stable/data-points/market/MMNRNJ
• Added CD rate jumbo /stable/data-points/market/MMNRJD
• Added credit card interest rate /stable/data-points/market/TERMCBCCALLNS

2019-04-26

• Added EOD options data
• Added 15 minute delayed OTC data (Only available to Scale users with permission from OTC Markets)

2019-04-18

• Version 1 is available and new version types are available.

Beta

2019-04-15

• Added Data Points endpoint
• Added beta to Basic Stats endpoint

2019-04-10

• Added XETRA EOD prices
• Expanded historical dividend data for ETFs and mutual funds

2019-04-09

• Added Stats endpoint
• Added iexcloud-messages-used header to API responses

2019-03-22

• Added EOD prices for London Stock Exchange
• Added EOD prices for Euronext Brussels
• Added EOD prices for Euronext Paris
• Added EOD prices for Euronext Lisbon
• Added EOD prices for Euronext Dublin
• Added EOD prices for Euronext Amsterdam

2019-03-21

• Added historical sentiment data by minute back to May 2017

2019-03-20

• Added enhanced token security using signed requests

2019-03-18

• Added upcoming events endpoint

2019-03-14

• Added streaming news with SSE

2019-03-13

• Added new Grow tier
• Added historical sentiment data back to May 2017

2019-03-12

• Added international ref data

2019-03-08

• Added social sentiment streaming with SSE
• Added exDividendDate to Basic Stats
• Added listLimit query parameter to list to specify number of items to return

2019-03-07

• Added mutual fund symbols ref data
• Added otc symbols ref data
• Added region and currency to symbols ref data
• Added support for Mexico Exchanges historical prices
• Fixed earnings report date for some after market close symbols that returned the next day

2019-03-06

• Added currency exchange rates
• Added FX Symbols

2019-02-28

• Added Institutional Ownership
• Added Mutual Fund Ownership
• Added Analyst Recommendation Trends
• Added Insider Transactions
• Added Insider Roster
• Added Insider Summary
• Added ability to fetch historical data for a single date. Historical prices with range date can use query parameter chartByDay to return a single day close information.

2019-02-27

• Added international equities. Now supporting EOD Canadian prices.
• Lowered weight of /stock/OHLC endpoint from 2 to 1, and max weight of 500.
• Added peRatio to /stock/quote endpoint

2019-02-26

• Added CEO compensation data ceo-compensation
• Teams You can now invite team members to your account.

2019-02-21

• Introduced a dedicated domain for the sandbox environment.
• /status endpoint updated with version number to track when changes are made.
• Updated /stock/batch endpoint to return data for any valid symbol rather than error out the whole call for one bad symbol.

2019-02-20

• Lowered /stock/stats weight from 20 to 5
• Added peRatio nextDividendDate nextEarningsDate ttmEPS ttmDividendRate dividendYield to the /stock/stats endpoint

2019-02-19

• Added employees to the /stock/company endpoint
• Basic CIDR supported added to publishable token domain constraints in the console
• Fixed /stock/book endpoint

2019-02-14

• Introduced test tokens and sandbox for testing

2019-02-12

• Added StockTwits sentiment data

2019-02-07

• Added mutual fund EOD prices
• Added OTC EOD prices

2019-02-01

• Added /stocksUS to SSE

Core Data

Stocks / Equities

Balance Sheet

Pulls balance sheet data. Available quarterly or annually with the default being the last available quarter. This data is currently only available for U.S. symbols.

HTTP REQUEST

GET /stock/{symbol}/balance-sheet

RESPONSE

{
  "symbol": "AAPL",
  "balancesheet": [
    {
      "reportDate": "2020-10-17",
      "filingType": "10-K",
      "fiscalDate": "2020-09-13",
      "fiscalQuarter": 4,
      "fiscalYear": 2010,
      "currency": "USD",
      "currentCash": 25913000000,
      "shortTermInvestments": null,
      "receivables": 23186000000,
      "inventory": 3956000000,
      "otherCurrentAssets": 12087000000,
      "currentAssets": 131339000000,
      "longTermInvestments": 170799000000,
      "propertyPlantEquipment": 41304000000,
      "goodwill": null,
      "intangibleAssets": null,
      "otherAssets": 22283000000,
      "totalAssets": 365725000000,
      "accountsPayable": 55888000000,
      "currentLongTermDebt": null,
      "otherCurrentLiabilities": null,
      "totalCurrentLiabilities": 116866000000,
      "longTermDebt": 93735000000,
      "otherLiabilities": null,
      "minorityInterest": 0,
      "totalLiabilities": 258578000000,
      "commonStock": 40201000000,
      "retainedEarnings": 70400000000,
      "treasuryStock": null,
      "capitalSurplus": null,
      "shareholderEquity": 107147000000,
      "netTangibleAssets": 107147000000,
      "id": "BALANCE_SHEET",
      "key": "AAPL",
      "subkey": "quarterly",
      "date": 1635273127391,
      "updated": 1635273127391
    },
    // { ... }
  ]
}

Data Weighting (applicable only to legacy price plans)

.003 credit per symbol per period

Data Timing

End of day

Data Schedule

Updates at 8am, 9am UTC daily

Data Source(s)

Copyright: Data provided by New Constructs, LLC © All rights reserved.

Notes

• Only included with paid subscription plans.
• Financial information is limited for some financial firms.

Examples

• /stock/aapl/balance-sheet
• /stock/aapl/balance-sheet?period=annual

Query Parameters

Response Attributes

This endpoint inherits common keys from Time Series.

Bonus Issue

Corporate action bonus issue. A stock dividend, allotted by the company to reward the shareholders, and issued out of the reserves of the company.

HTTP REQUEST

GET /time-series/advanced_bonus/{symbol?}/{refid?}

RESPONSE

[
  {
    "symbol": "BVHMF",
    "exDate": "2020-01-03",
    "recordDate": "2020-01-02",
    "paymentDate": "2020-01-03",
    "fromFactor": 1,
    "toFactor": 0.03819,
    "ratio": 26.184865147944485,
    "description": "Ordinary Shares",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "resultSecurityType": "Equity Shares",
    "notes": "(As on 10/09/2019) CAB<BR><BR>SITUATION:      BONUS ISSUE <BR>",
    "figi": "BBG000FZ8989",
    "lastUpdated": "2019-11-08",
    "currency": "",
    "countryCode": "US",
    "parValue": 0.5,
    "parValueCurrency": "GBP",
    "lapsedPremium": 0,
    "refid": "5951486",
    "created": "2019-09-11",
    "id": "ADVANCED_BONUS",
    "key": "BVHMF",
    "subkey": "5951486",
    "date": 1578009600000,
    "updated": 1574690010000
  },
  // { ... }
]

Data Weighting (applicable only to legacy price plans)

.075 credit per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_bonus/{symbol?}/{refid?}

Examples

• /time-series/advanced_bonus?range=last-week
• /time-series/advanced_bonus?range=next-month&calendar=true
• /time-series/advanced_bonus/AAPL?last=4

Path Parameters

Query Parameters

This endpoint uses all standard time-series query parameters.

Response Attributes

This endpoint inherits common response attributes from time-series.

Book

HTTP REQUEST

GET /stock/{symbol}/book

RESPONSE

{
  "quote": {...},
  "bids": [...],
  "asks": [...],
  "trades": [...],
  "systemEvent": {...},
}

Data Weighting (applicable only to legacy price plans)

.000001 credit per quote returned

Data Timing

Real-time + 15min delayed

Data Schedule

Real-time during Investors Exchange market hours

Data Source(s)

Investors Exchange IEX Cloud Consolidated Tape

Available Methods

GET /stock/{symbol}/book

Examples

• /stock/aapl/book

Response Attributes

Response includes data from deep and quote. Refer to each endpoint for details.

Cash Flow

Pulls cash flow data. Available quarterly or annually, with the default being the last available quarter. This data is currently only available for U.S. symbols.

HTTP REQUEST

GET /stock/{symbol}/cash-flow

RESPONSE

{
  "symbol": "AAPL",
  "cashflow": [
    {
      "capitalExpenditures": -3742080084,
      "cashChange": null,
      "cashFlow": 38385893986,
      "cashFlowFinancing": -28735881222,
      "changesInInventories": null,
      "changesInReceivables": null,
      "currency": "USD",
      "depreciation": 31163596487,
      "dividendsPaid": null,
      "exchangeRateEffect": null,
      "filingType": "10-K",
      "fiscalDate": "2020-10-23",
      "fiscalQuarter": 4,
      "fiscalYear": 2020,
      "investingActivityOther": null,
      "investments": null,
      "netBorrowings": null,
      "netIncome": 13197898763,
      "otherFinancingCashFlows": null,
      "reportDate": "2020-10-27",
      "symbol": "AAPL",
      "totalInvestingCashFlows": -3480671359,
      "id": "CASH_FLOW",
      "key": "AAPL",
      "subkey": "quarterly",
      "date": 1612403165595,
      "updated": 1612403165595
    }
  ]
}

Data Weighting (applicable only to legacy price plans)

.001 credit per symbol per period

Data Timing

End of day

Data Schedule

Updates at 8am, 9am UTC daily

Data Source(s)

Copyright: Data provided by New Constructs, LLC © All rights reserved.

Notes

• Only included with paid subscription plans.
• Financial information is limited for some financial firms.

Examples

• /stock/aapl/cash-flow
• /stock/aapl/cash-flow?period=annual

Query Parameters

Response Attributes

This endpoint inherits common response attributes from time-series.

CEO Compensation

This endpoint provides CEO compensation for a company by symbol.

HTTP REQUEST

GET /stock/{symbol}/ceo-compensation

RESPONSE

// Daily
{
  "symbol": "AVGO",
  "name": "Hock E. Tan",
  "companyName": "Broadcom Inc.",
  "location": "Singapore, Asia",
  "salary": 1100000,
  "bonus": 0,
  "stockAwards": 98322843,
  "optionAwards": 0,
  "nonEquityIncentives": 3712500,
  "pensionAndDeferred": 0,
  "otherComp": 75820,
  "total": 103211163,
  "year": "2017"
}

Data Weighting (applicable only to legacy price plans)

.00002 credit per symbol

Data Timing

End of day

Data Schedule

1am daily

Data Source(s)

IEX Cloud

Notes

Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/ceo-compensation

Examples

• /stock/aapl/ceo-compensation

Path Parameters

Response Attributes

Charts

Price charts can be built using the historical or intraday price endpoints

Collections

Returns an array of quote objects for a given collection type. Currently supported collection types are sector, tag, and list

HTTP REQUEST

GET /stock/market/collection/{collectionType}

RESPONSE

[
    quote,
    ...
]

Data Weighting (applicable only to legacy price plans)

Weight of /stock/quote per quote returned

Examples

• /stock/market/collection/sector?collectionName=Technology
• /stock/market/collection/tag?collectionName=Airlines
• /stock/market/collection/list?collectionName=mostactive

Query Parameters

Response Attributes

Company

HTTP REQUEST

GET /stock/{symbol}/company

RESPONSE

{
  "symbol": "AAPL",
  "companyName": "Apple Inc.",
  "exchange": "NASDAQ",
  "industry": "Telecommunications Equipment",
  "website": "http://www.apple.com",
  "description": "Apple, Inc. engages in the design, manufacture, and marketing of mobile communication, media devices, personal computers, and portable digital music players. It operates through the following geographical segments: Americas, Europe, Greater China, Japan, and Rest of Asia Pacific. The Americas segment includes North and South America. The Europe segment consists of European countries, as well as India, the Middle East, and Africa. The Greater China segment comprises of China, Hong Kong, and Taiwan. The Rest of Asia Pacific segment includes Australia and Asian countries. The company was founded by Steven Paul Jobs, Ronald Gerald Wayne, and Stephen G. Wozniak on April 1, 1976 and is headquartered in Cupertino, CA.",
  "CEO": "Timothy Donald Cook",
  "securityName": "Apple Inc.",
  "issueType": "cs",
  "sector": "Electronic Technology",
  "primarySicCode": 3663,
  "employees": 132000,
  "tags": [
    "Electronic Technology",
    "Telecommunications Equipment"
  ],
  "address": "One Apple Park Way",
  "address2": null,
  "state": "CA",
  "city": "Cupertino",
  "zip": "95014-2083",
  "country": "US",
  "phone": "1.408.974.3123"
}

Data Weighting (applicable only to legacy price plans)

.00001 credit per symbol

Data Timing

End of Day

Data Schedule

Updates at 4am and 5am UTC every day

Data Source(s)

IEX Cloud

Examples

• /stock/aapl/company

Response Attributes

Delayed Quote

This returns the 15 minute delayed market quote.

HTTP REQUEST

GET /stock/{symbol}/delayed-quote

RESPONSE

{
  "symbol": "AAPL",
  "delayedPrice": 143.08,
  "delayedSize": 200,
  "delayedPriceTime": 1498762739791,
  "high": 143.90,
  "low": 142.26,
  "totalVolume": 33547893,
  "processedTime": 1498763640156
}

Data Weighting (applicable only to legacy price plans)

.000001 credit per symbol per quote

Data Timing

15min delayed

Data Schedule

4:30am - 8pm ET M-F when market is open

Data Source(s)

IEX Cloud

Notes

• Only included with paid subscription plans

Available Methods

GET /stock/{symbol}/delayed-quote

Examples

• /stock/msft/delayed-quote

Query Parameters

Response Attributes

Distribution

Corporate action bonus issue. A stock dividend, allotted by the company to reward the shareholders, and issued out of the reserves of the company. Includes international symbols. History available since 2007.

HTTP REQUEST

GET /time-series/advanced_distribution/{symbol?}/{refid?}

RESPONSE

[
  {
    "symbol": "KERRF",
    "exDate": "2019-11-26",
    "recordDate": "2019-11-19",
    "paymentDate": "2019-11-29",
    "withdrawalFromDate": null,
    "withdrawalToDate": null,
    "electionDate": null,
    "fromFactor": 3.451963,
    "toFactor": 1,
    "ratio": 3.451963,
    "minPrice": 0,
    "maxPrice": 0,
    "description": "Ordinary Shares",
    "flag": "Stock",
    "securityType": "Equity Shares",
    "hasWithdrawalRights": 1,
    "notes": "(As on 09/10/2019) CAB<BR>SITUATION:      CAPITAL REDUCTION AND DEMERGER <BR>",
    "figi": "BBG00N70C5N1",
    "lastUpdated": "2019-11-21",
    "countryCode": "US",
    "parValue": 0.0001,
    "parValueCurrency": "GBP",
    "refid": "6008685",
    "created": "2019-10-09",
    "id": "ADVANCED_DISTRIBUTION",
    "key": "KERRF",
    "subkey": "6008685",
    "date": 1574726400000,
    "updated": 1574691580000
  }
]

Data Weighting (applicable only to legacy price plans)

.075 credit per item returned

Data Timing

End of day

Data Schedule

Updated at 5am, 10am, 8pm UTC daily

Data Source(s)

IEX Cloud

Notes

Only available to paid plans.

Available Methods

GET /time-series/advanced_distribution/{symbol?}/{refid?}

Examples

• /time-series/advanced_distribution?range=last-week
• /time-series/advanced_distribution?range=next-month&calendar=true
• /time-series/advanced_distribution/AAPL?last=4

Path Parameters

Query Parameters

This endpoint uses all standard time-series query parameters.

Response Attributes

This endpoint inherits common response attributes from time-series.