| Name | schwab-dev JSON |
| Version |
0.0.6
JSON |
| download |
| home_page | None |
| Summary | Schwab API Python Client (unofficial) |
| upload_time | 2024-06-02 03:16:24 |
| maintainer | None |
| docs_url | None |
| author | Tyler Bowers |
| requires_python | None |
| license | None |
| keywords |
python
schwab
api
client
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Schwab-API-Python
This is an unofficial python program to access the Schwab api.
You will need a Schwab developer account [here](https://beta-developer.schwab.com/).
Join the [Discord group](https://discord.gg/m7SSjr9rs9)
## Quick setup
1. Create a new Schwab individual developer app with callback url "https://127.0.0.1" and wait until the status is "Ready for use", note that "Approved - Pending" will not work.
2. Enable TOS (Thinkorswim) for your Schwab account, it is needed for orders and other api calls.
3. Python version 3.11 or higher is required.
4. `pip3 install requests websockets`
5. Import the package `import schwabkit`
6. Create a client `schwabkit.Client('Your app key', 'Your app secret')`
## What can this program do?
- Authenticate and access the api
- Functions for all api functions (examples in `demo.py`)
- Auto "access token" updates (`.update_tokens_auto()`)
- Stream real-time data (`coming soon`)
- Automatically start/stop stream (`coming soon`)
### TBD
- Automatic refresh token updates. (Waiting for Schwab implementation)
- Customizable stream response handler. (Waiting for Schwab implementation)
## Usage and Design
This python client makes working with the TD/Schwab api easier.
The idea is to make an easy to understand, organized, and highly-automatic interface for the api.
Below is a light documentation on how it works, python is pseudocode-esk so if you are confused just read the code and follow the functions.
### Organization
The root of the client:
- `main.py` where the main program is run from, contains examples for you to get started with.
- `tokens.json` contains api tokens as well as dates for when they expire.
The schwabkit folder contains code for main operations:
- `api.py` contains functions relating to api calls, requests, and automatic token checker threads.
- `stream.py` contains functions for streaming data from websockets.
- `terminal.py` contains a program for making additional terminal windows and printing to the terminal with color.
## License (MIT)
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "schwab-dev",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, schwab, api, client",
"author": "Tyler Bowers",
"author_email": "tylerebowers@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a3/dc/890a29d61a8a30afcb501d3ea879987fdf86e32003750e92dc4d673d5b36/schwab-dev-0.0.6.tar.gz",
"platform": null,
"description": "# Schwab-API-Python \nThis is an unofficial python program to access the Schwab api. \nYou will need a Schwab developer account [here](https://beta-developer.schwab.com/). \nJoin the [Discord group](https://discord.gg/m7SSjr9rs9)\n\n\n## Quick setup\n1. Create a new Schwab individual developer app with callback url \"https://127.0.0.1\" and wait until the status is \"Ready for use\", note that \"Approved - Pending\" will not work.\n2. Enable TOS (Thinkorswim) for your Schwab account, it is needed for orders and other api calls.\n3. Python version 3.11 or higher is required. \n4. `pip3 install requests websockets`\n5. Import the package `import schwabkit`\n6. Create a client `schwabkit.Client('Your app key', 'Your app secret')`\n\n## What can this program do?\n - Authenticate and access the api \n - Functions for all api functions (examples in `demo.py`)\n - Auto \"access token\" updates (`.update_tokens_auto()`)\n - Stream real-time data (`coming soon`)\n - Automatically start/stop stream (`coming soon`)\n ### TBD \n - Automatic refresh token updates. (Waiting for Schwab implementation)\n - Customizable stream response handler. (Waiting for Schwab implementation)\n\n\n## Usage and Design\nThis python client makes working with the TD/Schwab api easier. \nThe idea is to make an easy to understand, organized, and highly-automatic interface for the api. \nBelow is a light documentation on how it works, python is pseudocode-esk so if you are confused just read the code and follow the functions. \n\n### Organization\n\nThe root of the client:\n - `main.py` where the main program is run from, contains examples for you to get started with.\n - `tokens.json` contains api tokens as well as dates for when they expire.\n\nThe schwabkit folder contains code for main operations: \n - `api.py` contains functions relating to api calls, requests, and automatic token checker threads.\n - `stream.py` contains functions for streaming data from websockets.\n - `terminal.py` contains a program for making additional terminal windows and printing to the terminal with color.\n\n## License (MIT)\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": null,
"summary": "Schwab API Python Client (unofficial)",
"version": "0.0.6",
"project_urls": null,
"split_keywords": [
"python",
" schwab",
" api",
" client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eaadc0b8cf4a3e8526c448edbf25ca2b3eb7eaaabda17f8cca915dc747640bce",
"md5": "421b6aedcdd8cc466fdc9ddb355acaa6",
"sha256": "a7f158032aefc1daf6be5026896dd149d8d942eb509bf17dd3cbada11d104c34"
},
"downloads": -1,
"filename": "schwab_dev-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "421b6aedcdd8cc466fdc9ddb355acaa6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11450,
"upload_time": "2024-06-02T03:16:22",
"upload_time_iso_8601": "2024-06-02T03:16:22.870304Z",
"url": "https://files.pythonhosted.org/packages/ea/ad/c0b8cf4a3e8526c448edbf25ca2b3eb7eaaabda17f8cca915dc747640bce/schwab_dev-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3dc890a29d61a8a30afcb501d3ea879987fdf86e32003750e92dc4d673d5b36",
"md5": "6ea3a2ec0c1a1fbae2680fe2512661f9",
"sha256": "10b8e4bb10476f3cad1bc652519a29500ad858d61d9185303edccd34e5b43408"
},
"downloads": -1,
"filename": "schwab-dev-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "6ea3a2ec0c1a1fbae2680fe2512661f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10741,
"upload_time": "2024-06-02T03:16:24",
"upload_time_iso_8601": "2024-06-02T03:16:24.570475Z",
"url": "https://files.pythonhosted.org/packages/a3/dc/890a29d61a8a30afcb501d3ea879987fdf86e32003750e92dc4d673d5b36/schwab-dev-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-02 03:16:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "schwab-dev"
}
