Metadata-Version: 2.1
Name: vanguard-api
Version: 0.1.8
Summary: An unofficial API for Vanguard Invest
Home-page: https://github.com/MaxxRK/vanguard-api
Download-URL: https://github.com/MaxxRK/vanguard-api/archive/refs/tags/v0.1.8.tar.gz
Author: MaxxRK
Author-email: maxxrk@pm.me
License: MIT
Keywords: VANGUARD,API
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Internet :: WWW/HTTP :: Session
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: playwright
Requires-Dist: playwright-stealth

# vanguard-api
 A reverse-engineered python API to interact with the Vanguard Trading platform.

 This is not an official api! This api's functionality may change at any time.

 This api provides a means of buying and selling stocks through Vanguard. It uses playwright to scrape data and to interact with the website.

 ---

## Contribution
I am new to coding and new to open-source. I would love any help and suggestions!

## Setup
Install using pypi:
```
pip install vanguard-api
```
This package requires playwright. After installing vanguard-api, you will need to finish the install of playwright. You can do this in most cases by running the command:
```
playwright install
```
If you would like some more information on this, you can find it [here](https://playwright.dev/python/docs/intro).

## Quickstart
Checkout `test.py` for a quickstart example it will: 
- Login and print account info.
- Print out Holdings.
- Place a dry run market order for 'INTC' on the first account in the `account_numbers` list
- Print out the order confirmation


---

 ## Implemented Features
 - [x] Login
 - [x] Login with MFA
 - [x] Get Account Data
 - [x] Place Market Orders
 - [x] Get Currently Held Positions
 - [x] Get Quotes
 - [x] Place Limit Orders

## TO DO
 - [ ] Get Order Status
 - [ ] Cancel placed orders
 - [ ] Options
 - [ ] Give me some Ideas!

## If you would like to support me, you can do so here:
[![GitHub Sponsors](https://img.shields.io/github/sponsors/maxxrk?style=social)](https://github.com/sponsors/maxxrk) 
