FinMesh 1.2

A Python wrapper to bring together various financial APIs.

FinMesh

---

FinMesh is a python-based package that brings together financial data from various sources in one place for ease of use and distribution. The three main sections of FinMesh are (1) the IEX REST API, (2) data from the US treasury, and (3) the data from the US Federal Reserve Economic Data.

Purpose

---

The purpose of this package and its sub-packages was originally to practice interacting with API data. With third-party API packages there is always the risk of outages or bugs. In building the original IEX wrapper we sought to build something easy to understand and use, that can be updated quickly and accurately.

With the addition of the US Federal data the opportunity arose to create a package that could deliver all sorts of economic and security data from one place. In doing so we hope to create a low-barrier way for beginners to play with large and very useful data sets.

In the future, this package will be updated with new financial and economic APIs. If you know of a low or no cost API that could be incorporated please raise it as an issue and we will work to have it done ASAP.

Installation

---

FinMesh is available publicly from [PYPI][https://pypi.org/project/FinMesh/] and can be installed and updated through a command line pip. Because the package is still growing and changing be sure to update often or check the PYPI page for possible updates.

The following dependencies are used in FinMesh:

• OS
• CSV
• JSON
• Requests
• xmltodict

Some APIs require authentication through the use of tokens. These tokens should be set up as environment variables in the bash profile. A great article on how to do this on Mac is available here:

My Mac OSX Bash Profile

Click HERE for your free IEX token. This token must be stored as IEX_TOKEN in your environment variables.

Click HERE for your free FRED token. This token must be stored as FRED_TOKEN in your environment variables.

IEX Sandbox Mode

---

Further, if you wish to make use of IEX's sandbox mode, you will need to create a couple more environment variables. You will first need to save your test token as IEX_SANDBOX_TOKEN and create a boolean variable called SANDBOX and set it to True. A built in parser will determine which token to use and make the adjustments for you.

Compatibility with IEX cloud

---

The name of the function shall be the name of the endpoint. The function shall accept all variables for a given endpoint using the same variable names per the documentation. Differences between IEX cloud documentation and this API should be considered errors. Please raise an issue if you notice discrepancies.

Specific documentation for every IEX function is not available but a list [HERE][https://michaelphartmann.github.io/function_list.html] can show you what options there are and the IEX docs will give you a full run down of the parameters. In general, to set a parameter you can set the parameter name equal to the desired output.

Contact

---

If you would like to reach out, feel free to connect with me one of three ways:

1. On GitHub

2. On LinkedIn

3. Via Email

If there are issues, be it major or semantic, please open an issue on GitHub.