| Name | fmpsdk JSON |
| Version |
20240330.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-03-30 08:14:35 |
| maintainer | None |
| docs_url | None |
| author | Dax Mickelson |
| requires_python | <4.0,>=3.11 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FMP SDK
The idea behind this project is to provide a 'one-stop-shop' to the API endpoints provided by
[Financial Model Prep](http://financialmodelingprep.com) 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`
1. Create a .env file and put your apikey in it. Inside .env: `apikey='blah'`
1. Use `fmpsdk.<some function>(apikey=apikey, <possibly more variables>)` to query the API for that "some function".
1. 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`.
```python
#!/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.
- [Ken Caruso](https://github.com/ipl31)
- [iforgotmypass](https://github.com/iforgotmypass)
- [Ivelin Ivanov](https://github.com/ivelin)
Raw data
{
"_id": null,
"home_page": null,
"name": "fmpsdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Dax Mickelson",
"author_email": "github@daxm.net",
"download_url": "https://files.pythonhosted.org/packages/3b/c1/be5e99d960d1d6c46cd30b1e937e9c1dd91ebb1f8b7c5f986543919a6f99/fmpsdk-20240330.0.tar.gz",
"platform": null,
"description": "# FMP SDK\nThe idea behind this project is to provide a 'one-stop-shop' to the API endpoints provided by \n[Financial Model Prep](http://financialmodelingprep.com) website.\n\n**Note: fmpsdk should be synced with FMP's API changelog as of 20210220. Changes thereafter are not yet included.**\n\n## How to Use\n1. Install the package: `pip install fmpsdk`\n1. Create a .env file and put your apikey in it. Inside .env: `apikey='blah'`\n1. Use `fmpsdk.<some function>(apikey=apikey, <possibly more variables>)` to query the API for that \"some function\".\n1. The return from that function call is almost always a List of Dictionaries. It is up to you to parse it.\n\n## Example code\nHere is a \"quick start\" script example. A larger, more detailed example is in the file `fmpsdk-example.py`.\n```python\n#!/usr/bin/env python3\n\nimport os\nfrom dotenv import load_dotenv\nimport typing\nimport fmpsdk\n\n# Actual API key is stored in a .env file. Not good to store API key directly in script.\nload_dotenv()\napikey = os.environ.get(\"apikey\")\n\n# Company Valuation Methods\nsymbol: str = \"AAPL\"\nprint(f\"Company Profile: {fmpsdk.company_profile(apikey=apikey, symbol=symbol)}\")\n```\n\n## Attribution\nSpecial thanks to the following people who have pitched in on this project! Open source works thanks to people who \njump in and help! These are this project's stars. Thank you.\n - [Ken Caruso](https://github.com/ipl31)\n - [iforgotmypass](https://github.com/iforgotmypass)\n - [Ivelin Ivanov](https://github.com/ivelin)\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "20240330.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2b8960b0aefb6db146896142307e274efd8168e4ad70bb0e9ebc8fb0f3d0bdf",
"md5": "7a2892fba0e5c8b7a9e68eb4ef496ecf",
"sha256": "3dfb4f8b6281164cc4d34ffb602ec03e59cd7d53e400f63a8595ab8e50838346"
},
"downloads": -1,
"filename": "fmpsdk-20240330.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a2892fba0e5c8b7a9e68eb4ef496ecf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 23736,
"upload_time": "2024-03-30T08:14:34",
"upload_time_iso_8601": "2024-03-30T08:14:34.116908Z",
"url": "https://files.pythonhosted.org/packages/f2/b8/960b0aefb6db146896142307e274efd8168e4ad70bb0e9ebc8fb0f3d0bdf/fmpsdk-20240330.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3bc1be5e99d960d1d6c46cd30b1e937e9c1dd91ebb1f8b7c5f986543919a6f99",
"md5": "b9e65e2a510cc83f1e62b1d3b21c6327",
"sha256": "29e98ea06cfc66c6f44f128744196d5580c15b469fd5fbc28df03b44c435fe8a"
},
"downloads": -1,
"filename": "fmpsdk-20240330.0.tar.gz",
"has_sig": false,
"md5_digest": "b9e65e2a510cc83f1e62b1d3b21c6327",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 16243,
"upload_time": "2024-03-30T08:14:35",
"upload_time_iso_8601": "2024-03-30T08:14:35.504242Z",
"url": "https://files.pythonhosted.org/packages/3b/c1/be5e99d960d1d6c46cd30b1e937e9c1dd91ebb1f8b7c5f986543919a6f99/fmpsdk-20240330.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-30 08:14:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fmpsdk"
}
