Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 1.46 KB

README.md

File metadata and controls

37 lines (30 loc) · 1.46 KB
Raw

FMP SDK

The idea behind this project is to provide a 'one-stop-shop' to the API endpoints provided by Financial Model Prep website.

Note: fmpsdk should be synced with FMP's API changelog as of 20210220. Changes thereafter are not yet included.

How to Use

  1. Install the package: pip install fmpsdk
  2. Create a .env file and put your apikey in it. Inside .env: apikey='blah'
  3. Use fmpsdk.<some function>(apikey=apikey, <possibly more variables>) to query the API for that "some function".
  4. The return from that function call is almost always a List of Dictionaries. It is up to you to parse it.

Example code

Here is a "quick start" script example. A larger, more detailed example is in the file fmpsdk-example.py.

#!/usr/bin/env python3

import os
from dotenv import load_dotenv
import typing
import fmpsdk

# Actual API key is stored in a .env file.  Not good to store API key directly in script.
load_dotenv()
apikey = os.environ.get("apikey")

# Company Valuation Methods
symbol: str = "AAPL"
print(f"Company Profile: {fmpsdk.company_profile(apikey=apikey, symbol=symbol)}")

Attribution

Special thanks to the following people who have pitched in on this project! Open source works thanks to people who jump in and help! These are this project's stars. Thank you.