Skip to main content

A Python wrapper to bring together various financial APIs.

Project description

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 four main sections of FinMesh are (1) the IEX REST API, (2) data from the US treasury, data from the US Federal Reserve Economic Data, and (4) data from the SECs EDGAR system.

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

The following dependencies are used in FinMesh:

  • OS
  • CSV
  • JSON
  • Requests
  • xmltodict
  • xml.etree.ElementTree
  • webbrowser
  • shutil
  • BeautifulSoup4

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.

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.

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

FinMesh-2.0a2.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

FinMesh-2.0a2-py3-none-any.whl (44.8 kB view details)

Uploaded Python 3

File details

Details for the file FinMesh-2.0a2.tar.gz.

File metadata

  • Download URL: FinMesh-2.0a2.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for FinMesh-2.0a2.tar.gz
Algorithm Hash digest
SHA256 091ecaaf0f1e4dc915d44c1d8e1f035630a82133bdf987272308fdb93c8bfae4
MD5 3e169a536799c51d0a12279923fe3a8d
BLAKE2b-256 1942d92b4b3c0214571ef0a7df3f489590fb84b499b3f109557dad935c90ee71

See more details on using hashes here.

File details

Details for the file FinMesh-2.0a2-py3-none-any.whl.

File metadata

  • Download URL: FinMesh-2.0a2-py3-none-any.whl
  • Upload date:
  • Size: 44.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for FinMesh-2.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 edfeb863fb6167dbc11e90ea30973b5714dc5aaf1c59c552492e1e66198414e7
MD5 4500f668e806fabd6b5327be59bd6508
BLAKE2b-256 ad8dda3bb4d43b74751345fd11ace952ac9a6d53e858a21b4de6ec4b493f65ee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page