Python wrapper for Feather's API
Project description
Calculations
Several endpoints, including ratios and multiples, include values derived from figures reported in the financial statements. To calculate these values, we use the following formulas.
EBIT = EBITDA = EBIT + Depreciation and Amortization
Getting Started
To use the API, you'll need an API key. You can get one by emailing founders@try-feather.com
If you're using the Python client, you can set your API key as an environment variable FEATHER_API_KEY
, or pass in the api key as a parameter to the client, as follows:
from featherapi import DataClient
API_KEY = 'xxyourfeatherapikeyherexx'
client = DataClient(api_key=API_KEY)
If calling the HTTP endpoints yourself, you need to include your api key as an x-api-key
header. See the HTTP API documentation for more details.
Financials
To get all available facts for an equity:
client.get_equity_facts('AAPL')
Additionally, equity facts can be fetched by range for available reporting periods:
# get the available reporting periods for AAPL
available = client.get_available('AAPL')
# get the latest 5 years of facts
end = available[-1]
start = available[-5]
results = client.get_equity_facts('AAPL', start=start, end=end)
TO get the institutional ownership for an equity:
holders = client.get_institutional_holders('AAPL')
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
Built Distribution
Hashes for feather_api-1.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9b53530040761ad7a77f8a22e4fa7f6c34cb502a63b8f4b2cf557dd8a15a8b8 |
|
MD5 | c4caf353fe13812b16be16598c4e0ef4 |
|
BLAKE2b-256 | ab27df893492d23e5e19496079ff295e5326f4e9c7f3d60fee98f318bbd0a6ae |