Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nelsondane/fennel-invest-api
Unofficial reverse-engineered Fennel.com Invest app API written in Python Requests
https://github.com/nelsondane/fennel-invest-api
graphql-api investing-api reverse-engineering stocks-api
Last synced: 2 days ago
JSON representation
Unofficial reverse-engineered Fennel.com Invest app API written in Python Requests
- Host: GitHub
- URL: https://github.com/nelsondane/fennel-invest-api
- Owner: NelsonDane
- License: mit
- Created: 2024-04-04T15:46:47.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T18:00:39.000Z (4 months ago)
- Last Synced: 2024-10-11T13:03:29.959Z (4 months ago)
- Topics: graphql-api, investing-api, reverse-engineering, stocks-api
- Language: Python
- Homepage:
- Size: 80.1 KB
- Stars: 12
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unofficial Fennel Invest API
This is an unofficial API for Fennel.com. It is a simple Python wrapper around the Fennel.com GraphQL API. It is not affiliated with Fennel.com in any way.
Fennel does everything via GraphQL, so yes, this is very slow.
This is still a work in progress, so it will have bugs and missing features. Please feel free to contribute!
## Important!
Do not use any version of this library before 1.0.9. Earlier versions had a bug with placing certain orders that when executed excessively could lead to your account being locked. This has been fixed in 1.0.9. See [this issue](https://github.com/NelsonDane/fennel-invest-api/issues/14)
## Installation
```bash
pip install 'fennel-invest-api>=1.1.0'
```
## Usage: Logging In
```python
from fennel_invest_api import Fennel
fennel = Fennel()
fennel.login(
email="[email protected]",
wait_for_code=True # When logging in for the first time, you need to wait for email 2FA
)
```
If you'd like to handle the 2FA yourself programmatically instead of waiting for `input()`, you can call it with `wait_for_code=False`, catch the 2FA exception, then call it again with the 2FA code:
```python
fennel.login(
email="[email protected]",
wait_for_code=False
code="123456" # Should be six-digit integer from email
)
```
## Usage: Get Stock Holdings
```python
account_ids = fennel.get_account_ids()
for account_id in account_ids:
print(account_id)
positions = fennel.get_stock_holdings(account_id)
for position in positions:
print(position)
```
## Usage: Get Portfolio
```python
# For all account IDs
portfolio = fennel.get_account_ids()
for account_id in account_ids:
print(account_id)
portfolio = fennel.get_portfolio_summary(account_id)
print(portfolio)
# For a single account ID
portfolio = fennel.get_portfolio_summary(account_id)
print(portfolio)
```
## Usage: Placing Orders
```python
order = fennel.place_order(
account_id=account_id,
ticker="AAPL",
quantity=1,
side="buy", # Must be "buy" or "sell"
price="market" # Only market orders are supported for now
dry_run=False # If True, will not actually place the order
)
print(order)
```
## Contributing
Found or fixed a bug? Have a feature request? Feel free to open an issue or pull request!
Enjoying the project? Feel free to Sponsor me on GitHub or Ko-fi!
[](https://github.com/sponsors/NelsonDane)
[](https://ko-fi.com/X8X6LFCI0)
## DISCLAIMER
DISCLAIMER: I am not a financial advisor and not affiliated with Fennel.com. Use this tool at your own risk. I am not responsible for any losses or damages you may incur by using this project. This tool is provided as-is with no warranty.