python-invest 0.2.1a0

Package to financial data extraction with Python.

Python Invest

Financial data extraction with Python.

The Python Invest package is based on an unofficial data extraction API from the website Investing.com. It's a package inspired by the amazing Investpy library.

:warning: This package consumes an unofficial open API and will validate the user's email before providing the data. After that, the user can consume all available services.

Python Invest its a Open Source package and Free to use, respecting the MIT License.

:book: Documentation

The oficial Documentation.

:material-list-status: Requirements

:white_check_mark: Python >= 3.10

:hammer_and_wrench: Installation

• pip

$ pip install python-invest

• poetry

poetry add python-invest

---

:chart_with_upwards_trend: Usage Examples

Getting historical BTC data:

from python_invest import Invest

inv = Invest('[e-mail]')

data = inv.crypto.get_historical_data(
        symbol='BTC',
        from_date='2023-01-01',
        to_date='2023-02-01'
    )

The API can send a verification link to your email, it's a security measure you won't be charged for anything. If this happens, you will receive an error similar to this:

Traceback (most recent call last):
 File "...", line 5, in <module>
    data = inv.crypto.get_historical_data(symbol='BTC', from_date='2023-01-01', to_date='2023-02-01')
    ...
PermissionError: The Scrapper API sent to your email address the verification link. Please verify your email before run the code again.

If you get this error: Just open your email box and click on the verification link.

The email would be a equal this:

After that, you can run the code:

data = inv.crypto.get_historical_data(
        symbol='BTC',
        from_date='2023-01-01',
        to_date='2023-02-01'
    )

print(data)

      Price      Open      High       Low     Vol Change        Date
0  16,674.3  16,618.4  16,766.9  16,551.0  136027   0.34  01/02/2023
1  16,618.4  16,537.5  16,621.9  16,499.7  107837   0.49  01/01/2023

The default output is the Pandas DataFrame.

:keyboard: CLI

pinv --help

---

Example:

pinv crypto historical BTC --date-in '2023-01-01' --date-out '2023-04-01' --time-frame 'Monthly'

                            TABLE OF HISTORICAL DATA
┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┓
┃ Price    ┃ Open     ┃ High     ┃ Low      ┃ Vol     ┃ Change ┃ Date       ┃
┡━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━┩
│ 23,130.5 │ 23,124.7 │ 25,236.8 │ 21,418.7 │ 9094707 │ 0.02   │ 02/01/2023 │
│ 23,125.1 │ 16,537.5 │ 23,952.9 │ 16,499.7 │ 8976036 │ 39.83  │ 01/01/2023 │
└──────────┴──────────┴──────────┴──────────┴─────────┴────────┴────────────┘

:computer: Social Medias

• Instagram
• Linkedin

:technologist: Author

@clcostaf