| Name | finflux JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | A Python wrapper for fetching financial data |
| upload_time | 2025-07-23 14:31:19 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
finance
api
funds
stocks
forex
crypto
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--README.md files serve as the main landing page on this directory's github repository. It is the first thing that a viewer sees when he or she enters the github repo.
-->
# FinFlux API
`finflux` offers financial and market data # FinFlux API
`finflux` offers financial and market data retrieval through multiple publicly available free REST JSON API endpoints found online in one aggregate Python library.
`finflux` utilizes both first-party and third-party APIs connected to the sources listed below.
- Yahoo Finance
- Twelve Data
- Alpha Vantage
- Securities and Exchange Commission (SEC)
- Organization for Economic Co-operation and Development (OECD)
- Board of Governors of the Federal Reserve System
- U.S. Department of the Treasury
- Bureau of Economic Analysis (BEA)
- Bureau of Labor Statistics (BLS)
- U.S. Census Bureau
- National Association of REALTORS® (NAR)
- Freddie Mac
## Installation and Setup
First, install `finflux` from PyPi using `pip` and import the library using `import`
```bash
pip install finflux
```
```python
import finflux as fin
```
Before accessing data retrieval functions, you must set your API keys and email address to use certain functions within the library that require an identifier. If no API key or email address is found when needed, a `MissingConfigObject` error will be raised.
Currently, functions utilizing Twelve Data, Alpha Vantage, SEC, FRED, BEA, and BLS APIs all require identifiers in the form of API keys (with the exception of the SEC, requiring an email address instead). Use the links below to retrieve API keys for each source.
- [Twelve Data](https://twelvedata.com/pricing)
- [Alpha Vantage](https://www.alphavantage.co/support/#api-key)
- [Federal Reserve Economic Data](https://fred.stlouisfed.org/docs/api/api_key.html)
- [Bureau of Economic Analysis](https://apps.bea.gov/api/signup/)
- [Bureau of Labor Statistics](https://data.bls.gov/registrationEngine/)
After gaining access to all API keys pertaining to data of your choice, input the identifier strings through the `set_config` function.
```
fin.set_config(
td = 'your_twelve_data_api_key',
email = 'example@example.com',
av = 'your_alpha_vantage_api_key',
fred = 'your_FRED_api_key',
bea = 'your_BEA_api_key',
bls = 'your_BLS_api_key'
)
```
## Library Components (Classes and Methods)
- `finflux.equity('EQUITY_TICKER')`
- `timeseries()`, `realtime()`, `statement()`, `quote()`, `info()`, `news()`, `filings()`, `eps()`, `analyst_estimates()`, `dividend()`, `split()`, `stats()`, `top()`
- `finflux.bond()`
- `nonUS_10Y_sovereign()`, `US_treasury()`, `US_curve()`, `US_eod()`, `US_quote()`, `US_HQM_corporate()`
- `finflux.US_indic()`:
- `gdp()`, `price_index()`, `pce()`, `unemployment()`, `labor()`, `sentiment()`, `fed_rate()`, `housing()`
For a more detailed overview of each method, each class also has its own `help()` method, outlining each function's description, parameters, and API source.
```python
finflux.bond().help()
```
EXAMPLE #1: Retrieving table formatted annual income statement data in EUR in millions excluding units past the decimals for Apple Inc. (AAPL).
```python
finflux.equity('AAPL').statement(display='table', statement='income', currency='EUR', unit='million', decimal=False, interval='annual')
```
Raw data
{
"_id": null,
"home_page": null,
"name": "finflux",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "finance, api, funds, stocks, forex, crypto",
"author": null,
"author_email": "Ingyu Bahng <ibahng21@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/69/d6/134687c077f0b58163fd3549103b2749b22e629bc1a153e7b679ab6ae817/finflux-0.2.0.tar.gz",
"platform": null,
"description": "<!--README.md files serve as the main landing page on this directory's github repository. It is the first thing that a viewer sees when he or she enters the github repo.\n\n-->\n# FinFlux API\n\n`finflux` offers financial and market data # FinFlux API\n\n`finflux` offers financial and market data retrieval through multiple publicly available free REST JSON API endpoints found online in one aggregate Python library.\n\n\n`finflux` utilizes both first-party and third-party APIs connected to the sources listed below.\n- Yahoo Finance\n- Twelve Data\n- Alpha Vantage\n- Securities and Exchange Commission (SEC)\n- Organization for Economic Co-operation and Development (OECD)\n- Board of Governors of the Federal Reserve System\n- U.S. Department of the Treasury\n- Bureau of Economic Analysis (BEA)\n- Bureau of Labor Statistics (BLS)\n- U.S. Census Bureau\n- National Association of REALTORS\u00ae (NAR)\n- Freddie Mac\n\n## Installation and Setup\n\nFirst, install `finflux` from PyPi using `pip` and import the library using `import`\n\n```bash\npip install finflux\n```\n\n```python\nimport finflux as fin\n```\n\nBefore accessing data retrieval functions, you must set your API keys and email address to use certain functions within the library that require an identifier. If no API key or email address is found when needed, a `MissingConfigObject` error will be raised.\n\nCurrently, functions utilizing Twelve Data, Alpha Vantage, SEC, FRED, BEA, and BLS APIs all require identifiers in the form of API keys (with the exception of the SEC, requiring an email address instead). Use the links below to retrieve API keys for each source.\n- [Twelve Data](https://twelvedata.com/pricing)\n- [Alpha Vantage](https://www.alphavantage.co/support/#api-key)\n- [Federal Reserve Economic Data](https://fred.stlouisfed.org/docs/api/api_key.html)\n- [Bureau of Economic Analysis](https://apps.bea.gov/api/signup/)\n- [Bureau of Labor Statistics](https://data.bls.gov/registrationEngine/)\n\nAfter gaining access to all API keys pertaining to data of your choice, input the identifier strings through the `set_config` function.\n\n```\nfin.set_config(\n td = 'your_twelve_data_api_key',\n email = 'example@example.com',\n av = 'your_alpha_vantage_api_key',\n fred = 'your_FRED_api_key',\n bea = 'your_BEA_api_key',\n bls = 'your_BLS_api_key'\n)\n```\n\n## Library Components (Classes and Methods)\n\n- `finflux.equity('EQUITY_TICKER')`\n - `timeseries()`, `realtime()`, `statement()`, `quote()`, `info()`, `news()`, `filings()`, `eps()`, `analyst_estimates()`, `dividend()`, `split()`, `stats()`, `top()`\n- `finflux.bond()`\n - `nonUS_10Y_sovereign()`, `US_treasury()`, `US_curve()`, `US_eod()`, `US_quote()`, `US_HQM_corporate()`\n- `finflux.US_indic()`: \n - `gdp()`, `price_index()`, `pce()`, `unemployment()`, `labor()`, `sentiment()`, `fed_rate()`, `housing()`\n\nFor a more detailed overview of each method, each class also has its own `help()` method, outlining each function's description, parameters, and API source.\n\n```python\nfinflux.bond().help()\n```\n\nEXAMPLE #1: Retrieving table formatted annual income statement data in EUR in millions excluding units past the decimals for Apple Inc. (AAPL).\n\n```python\nfinflux.equity('AAPL').statement(display='table', statement='income', currency='EUR', unit='million', decimal=False, interval='annual')\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python wrapper for fetching financial data",
"version": "0.2.0",
"project_urls": {
"Repository": "https://github.com/ibahng/finflux/tree/main"
},
"split_keywords": [
"finance",
" api",
" funds",
" stocks",
" forex",
" crypto"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "bf3ad5a35c85d3cd818ac95d8a57ac8cca3e7dce562db313c8e3ae5a080003ae",
"md5": "fe0f5713ac9399d58c11966efb77741a",
"sha256": "8c16c78bfdd79648bd7d1437994f9594e6faa348abc59d3919bff401f22d408e"
},
"downloads": -1,
"filename": "finflux-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe0f5713ac9399d58c11966efb77741a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 26218,
"upload_time": "2025-07-23T14:31:18",
"upload_time_iso_8601": "2025-07-23T14:31:18.486923Z",
"url": "https://files.pythonhosted.org/packages/bf/3a/d5a35c85d3cd818ac95d8a57ac8cca3e7dce562db313c8e3ae5a080003ae/finflux-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "69d6134687c077f0b58163fd3549103b2749b22e629bc1a153e7b679ab6ae817",
"md5": "e94f1cc50daffadcab4cd7dcd88cfc3b",
"sha256": "9a22d29fdd646d677336c1d65181ede72913cf003fa2f65431d767468d2ad378"
},
"downloads": -1,
"filename": "finflux-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "e94f1cc50daffadcab4cd7dcd88cfc3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 26058,
"upload_time": "2025-07-23T14:31:19",
"upload_time_iso_8601": "2025-07-23T14:31:19.850509Z",
"url": "https://files.pythonhosted.org/packages/69/d6/134687c077f0b58163fd3549103b2749b22e629bc1a153e7b679ab6ae817/finflux-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-23 14:31:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ibahng",
"github_project": "finflux",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "finflux"
}
