# 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!
## Disclaimer
I am not a financial advisor and not affiliated with Vanguard in any way. 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.
## 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:
[](https://github.com/sponsors/maxxrk)
Raw data
{
"_id": null,
"home_page": "https://github.com/MaxxRK/vanguard-api",
"name": "vanguard-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "VANGUARD, API",
"author": "MaxxRK",
"author_email": "maxxrk@pm.me",
"download_url": "https://files.pythonhosted.org/packages/57/b5/4643d88b33754e1e31ad89e68c2f7cb2ca5b59ce97891544343c861c4b48/vanguard_api-0.2.6.tar.gz",
"platform": null,
"description": "# vanguard-api\n A reverse-engineered python API to interact with the Vanguard Trading platform.\n\n This is not an official api! This api's functionality may change at any time.\n\n This api provides a means of buying and selling stocks through Vanguard. It uses playwright to scrape data and to interact with the website.\n\n ---\n\n## Contribution\nI am new to coding and new to open-source. I would love any help and suggestions!\n\n## Disclaimer\nI am not a financial advisor and not affiliated with Vanguard in any way. 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.\n\n## Setup\nInstall using pypi:\n```\npip install vanguard-api\n```\nThis 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:\n```\nplaywright install\n```\nIf you would like some more information on this, you can find it [here](https://playwright.dev/python/docs/intro).\n\n## Quickstart\nCheckout `test.py` for a quickstart example it will: \n- Login and print account info.\n- Print out Holdings.\n- Place a dry run market order for 'INTC' on the first account in the `account_numbers` list\n- Print out the order confirmation\n\n\n---\n\n ## Implemented Features\n - [x] Login\n - [x] Login with MFA\n - [x] Get Account Data\n - [x] Place Market Orders\n - [x] Get Currently Held Positions\n - [x] Get Quotes\n - [x] Place Limit Orders\n\n## TO DO\n - [ ] Get Order Status\n - [ ] Cancel placed orders\n - [ ] Options\n - [ ] Give me some Ideas!\n\n## If you would like to support me, you can do so here:\n[](https://github.com/sponsors/maxxrk) \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An unofficial API for Vanguard Invest",
"version": "0.2.6",
"project_urls": {
"Download": "https://github.com/MaxxRK/vanguard-api/archive/refs/tags/v0.2.6.tar.gz",
"Homepage": "https://github.com/MaxxRK/vanguard-api"
},
"split_keywords": [
"vanguard",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b84048d913b2c5a57b15daa712c9daf51b045d6627875740d40c08e55e9ee43b",
"md5": "b3a7e091c4078f4f985a4f75d72e04e6",
"sha256": "990c3be852885eabc33a966a62727e5448c50481e009dc7458531fc109a5b09c"
},
"downloads": -1,
"filename": "vanguard_api-0.2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3a7e091c4078f4f985a4f75d72e04e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12130,
"upload_time": "2024-09-23T21:08:59",
"upload_time_iso_8601": "2024-09-23T21:08:59.377928Z",
"url": "https://files.pythonhosted.org/packages/b8/40/48d913b2c5a57b15daa712c9daf51b045d6627875740d40c08e55e9ee43b/vanguard_api-0.2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57b54643d88b33754e1e31ad89e68c2f7cb2ca5b59ce97891544343c861c4b48",
"md5": "0992438bc5caad1660db54404d9e6b78",
"sha256": "45b34ae08cc04fab04dc5c3b9b29d7f9fe541698a4e098a823bb80eff6206459"
},
"downloads": -1,
"filename": "vanguard_api-0.2.6.tar.gz",
"has_sig": false,
"md5_digest": "0992438bc5caad1660db54404d9e6b78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11865,
"upload_time": "2024-09-23T21:09:00",
"upload_time_iso_8601": "2024-09-23T21:09:00.858827Z",
"url": "https://files.pythonhosted.org/packages/57/b5/4643d88b33754e1e31ad89e68c2f7cb2ca5b59ce97891544343c861c4b48/vanguard_api-0.2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-23 21:09:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MaxxRK",
"github_project": "vanguard-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vanguard-api"
}
JSON
