Intrinio's stock API was designed by financial professionals for developers, a rare situation in the world of FinTech. This makes the API easy to integrate and scale for a developer while the data structures are intuitive for financial analysts.
Even with this solid foundation, getting started with the API can be challenging - developers need to understand how to work with a RESTful API AND understand financial data. This article explains a few of the resources Intrinio has made available to help you get started. It contains 4 major sections:
- A summary of the tools you'll need to get started using the API
- An explanation of how to make your first API call
- A list of sample API calls to show you what is possible
- A list of SDKs that include sample code in many languages
Tools you'll need
- The API Documentation- Everything the API does is documented here
- The API Explorer- This tool will build your API calls for you
- The Data Tag Directory- This feature looks up the data types Intrinio provides
- Paging Tutorial - This article explains how to page through data via API
- Screener Tutorial- You can screen stocks via API, this article says how
- CSV Documentation - The API typically outputs JSON, but you can output CSV as well
- The Help Page- You can chat support and see a list of helpful links here
Making Your First API Call
Start by looking at the API documentation. There you will see that the API uses Basic Authentication administered over HTTPS. You can see what this means, and build your first API call, by pasting the following text into your browser:
https://api.intrinio.com/data_point?ticker=AAPL&item=close_price&api_key=[your key here]
Make sure to insert your API key to the syntax/URL like the example above.
Your access key is located in your account page under tab ACCESS KEYS.
All you need to do is copy and paste the above syntax to your browser and you have authenticated over HTTPS. When you do, you will see the result of your API call- the current close price for Apple's stock. Later, your application will do this part with code instead of copy and paste.
Notice that the API call is broken into several parts.
The base URL- https://www.api.intrinio.com/
A data type- data_point?
A ticker- ticker=AAPL&
And an item - item=close_price
By varying the data type, the ticker, and the item, you can use the API to call many different pieces of data from Intrinio's database for thousands of securities in numerous formats.
The API explorer is a great tool that will help you build API calls.
Once you have made a few sample API calls and taken a look at the tools Intrinio offers, you might also want to check out this article that explains paging with the Intrinio API. When you start making API calls for more data, you'll have to "page" through the results.
Sample Stock API calls
While sample stock API calls are included in the API documentation, it can be useful to see a few together to get an idea of the breadth of data types available through Intrinio. Once you learn the format of a few data types, its easy to change the building blocks of the API call to get a different piece of data, especially if you use the API explorer.
Often times you will notice that there are limits to the amount of data available in a single call. This limit is 100 items per page in general, but adding a pager, page_number=2 in this case, allows you to pull multiple pages. Here is the paging documentation.
This grabs AAPL's income statement from Q2, 2015:
That shows all companies with a new filing date on or after 2017-03-06, which is useful for determining which fundamentals need to be updated.
This call uses data_point, a data type that returns the most current piece of data. In this case, I have simply changed out "close_price" in the first API call in this post for "pricetoearnings" so that instead of the current stock price for Apple, I will see the current price to earnings ratio.
This call returns the current federal funds interest rate from the federal reserve. Your API calls are not limited to just stocks- Intrinio covers 200,000 economic data series as well. This article explains how to pull economic data.
This stock api call uses the historical data format to pull Apple's price to earnings ratio over the course of 2014. Historical data allows you to pull data as a time series or to pull data from a specific point in time.
Here, we combine the previous two calls to return economic data as a time series. In this case, its the VIX volatility index.
This call will return the entire price history of Apple if you use a pager. You can use this data type to specify a specific date range or pull it all in at once, with a default page size of 100 rows. See our Page Size Limits documentation for more info.
This call pulls in the median annual price to earnings ratio for the Oil and Gas industry for every year going back to 2007. Learning how to use SIC codes to pull data on sectors and industries is a lucrative method for obtaining benchmarking data.
Here we move into the realm of dimensional calling, which is a single API call that returns multiple data points for a security, up to 100, or multiple securities for a datapoint, up to 100. This call will pull in all of the latest news for both Microsoft and Apple.
In this call, instead of multiple items for a single stock we get a single item for multiple stocks. In this case, the real time stock price for Apple and Microsoft.
This dimensional call uses the data_point endpoint to pull in 3 metrics for AAPL. Dimensional calls do not work with historical data, however they can save you time with data_point and news.
That will limit your news to the most recent 5 articles.
This is a handy call that returns the first 100 companies that Intrinio covers, including the ticker symbols you can parse out to use in other API calls. Since the number of items that can be returned in a single call is limited to 100, and Intrinio covers way more than 100 tickers, you will need to change the "1" to "2" to get the second 100. This requires a loop to get the entire list.
This call extends the previous call to get the basic company information for Apple.
This article explains how to use the stock screener api, including sample calls for multiple screening parameters. The call below will return companies with a price to earnings ratio greater than 15.
This call will return your current number of API calls if you add your own API password at the end. Most Intrinio plans put a daily limit on the number of API calls you can make, this documentation shows how to track your usage.
That will pull securities that had their 10Q or 10K updated on a specific date.
Or the adjusted date for an entire exchange.
Or companies with a filing date on a specific date.
Sample Code and SDKs in Numerous Languages
Once you have mastered the syntax for Intrinio stock API calls, you will want to use your coding language of choice to automatically input your API username and password and parse the data for use in your application.
Intrinio officially supports many REST API SDKs in it's API v2. If you're interested, click here to know more.