# firstrade-api
A reverse-engineered python API to interact with the Firstrade 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 Firstrade. It uses the Session class from requests to get authorization cookies. The rest is done with reverse engineered requests to Firstrade's API.
In order to use Fractional shares you must accept the agreement on the website before using it in this API.
---
## Contribution
I am new to coding and new to open-source. I would love any help and suggestions!
## Setup
Install using pypi:
```
pip install firstrade
```
## Quikstart
The code below will:
- Login and print account info.
- Get a quote for 'INTC' and print out the information
- Place a market order for 'INTC' on the first account in the `account_numbers` list
- Print out the order confirmation
`Checkout test.py for sample code.`
This code is also in test.py
---
## Implemented Features
- [x] Login
- [x] Get Quotes
- [x] Get Account Data
- [x] Place Orders and Receive order confirmation
- [x] Get Currently Held Positions
- [x] Fractional Trading support (thanks to @jiak94)
- [x] Check on placed order status. (thanks to @Cfomodz)
## TO DO
- [ ] Cancel placed orders
- [ ] Options
- [ ] Give me some Ideas!
[](https://ko-fi.com/O5O6PTOYG)
Raw data
{
"_id": null,
"home_page": "https://github.com/MaxxRK/firstrade-api",
"name": "firstrade",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "FIRSTRADE, API",
"author": "MaxxRK",
"author_email": "maxxrk@pm.me",
"download_url": "https://files.pythonhosted.org/packages/b2/16/f1e6288df159b1e787de7de40cc1df7bef598f85e13b63cd18d5e6e0cf64/firstrade-0.0.17.tar.gz",
"platform": null,
"description": "# firstrade-api\n\nA reverse-engineered python API to interact with the Firstrade Trading platform.\n\nThis is not an official api! This api's functionality may change at any time.\n\nThis api provides a means of buying and selling stocks through Firstrade. It uses the Session class from requests to get authorization cookies. The rest is done with reverse engineered requests to Firstrade's API.\n\nIn order to use Fractional shares you must accept the agreement on the website before using it in this API.\n\n---\n\n## Contribution\n\nI am new to coding and new to open-source. I would love any help and suggestions!\n\n## Setup\n\nInstall using pypi:\n\n```\npip install firstrade\n```\n\n## Quikstart\n\nThe code below will:\n\n- Login and print account info.\n- Get a quote for 'INTC' and print out the information\n- Place a market order for 'INTC' on the first account in the `account_numbers` list\n- Print out the order confirmation\n\n`Checkout test.py for sample code.`\n\nThis code is also in test.py\n\n---\n\n## Implemented Features\n\n- [x] Login\n- [x] Get Quotes\n- [x] Get Account Data\n- [x] Place Orders and Receive order confirmation\n- [x] Get Currently Held Positions\n- [x] Fractional Trading support (thanks to @jiak94)\n- [x] Check on placed order status. (thanks to @Cfomodz)\n\n## TO DO\n\n- [ ] Cancel placed orders\n- [ ] Options\n- [ ] Give me some Ideas!\n\n[](https://ko-fi.com/O5O6PTOYG)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An unofficial API for Firstrade",
"version": "0.0.17",
"project_urls": {
"Download": "https://github.com/MaxxRK/firstrade-api/archive/refs/tags/0017.tar.gz",
"Homepage": "https://github.com/MaxxRK/firstrade-api"
},
"split_keywords": [
"firstrade",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92999e5fea51b6356541eb49f13016284ddb980ed5d7eb66652a2d6a024fe080",
"md5": "4ac2170e7ce144eae229b8750e771878",
"sha256": "229cba87ccd50704606ee9bbd2a36a4bc96bd2c5f8a12d6a37f47aee09ee3ab7"
},
"downloads": -1,
"filename": "firstrade-0.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ac2170e7ce144eae229b8750e771878",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9399,
"upload_time": "2024-05-08T01:47:02",
"upload_time_iso_8601": "2024-05-08T01:47:02.250719Z",
"url": "https://files.pythonhosted.org/packages/92/99/9e5fea51b6356541eb49f13016284ddb980ed5d7eb66652a2d6a024fe080/firstrade-0.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b216f1e6288df159b1e787de7de40cc1df7bef598f85e13b63cd18d5e6e0cf64",
"md5": "76b2e37a85d772a8131fab2deb9bcc16",
"sha256": "b441fea7710d1fc705f0afdeac8d70bbc876654d9d7bec12de21b3644fa5b181"
},
"downloads": -1,
"filename": "firstrade-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "76b2e37a85d772a8131fab2deb9bcc16",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9138,
"upload_time": "2024-05-08T01:47:03",
"upload_time_iso_8601": "2024-05-08T01:47:03.932814Z",
"url": "https://files.pythonhosted.org/packages/b2/16/f1e6288df159b1e787de7de40cc1df7bef598f85e13b63cd18d5e6e0cf64/firstrade-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 01:47:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MaxxRK",
"github_project": "firstrade-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "firstrade"
}
JSON
