firstrade 0.0.20__py3-none-any.whl → 0.0.30__py3-none-any.whl

firstrade/urls.py

@@ -1,46 +1,76 @@
-def get_xml():
-    return "https://invest.firstrade.com/cgi-bin/getxml"
+def login():
+    return "https://api3x.firstrade.com/sess/login"
 
 
-def login():
-    return "https://invest.firstrade.com/cgi-bin/login"
+def request_code():
+    return "https://api3x.firstrade.com/sess/request_code"
+
 
+def verify_pin():
+    return "https://api3x.firstrade.com/sess/verify_pin"
 
-def pin():
-    return "https://invest.firstrade.com/cgi-bin/enter_pin?destination_page=home"
+
+def user_info():
+    return "https://api3x.firstrade.com/private/userinfo"
 
 
 def account_list():
-    return "https://invest.firstrade.com/cgi-bin/getaccountlist"
+    return "https://api3x.firstrade.com/private/acct_list"
+
+
+def account_balances(account):
+    return f"https://api3x.firstrade.com/private/balances?account={account}"
+
+
+def account_positions(account):
+    return f"https://api3x.firstrade.com/private/positions?account={account}&per_page=200"
+
+
+def quote(account, symbol):
+    return f"https://api3x.firstrade.com/public/quote?account={account}&q={symbol}"
 
 
-def quote(symbol):
-    return f"https://invest.firstrade.com/cgi-bin/getxml?page=quo&quoteSymbol={symbol}"
+def order():
+    return "https://api3x.firstrade.com/private/stock_order"
 
 
-def orderbar():
-    return "https://invest.firstrade.com/cgi-bin/orderbar"
+def order_list(account):
+    return f"https://api3x.firstrade.com/private/order_status?account={account}"
 
 
-def account_status():
-    return "https://invest.firstrade.com/cgi-bin/account_status"
+def account_history(account):
+    return f"https://api3x.firstrade.com/private/account_history?range=ytd&page=1&account={account}&per_page=200"
 
-def order_list():
-    return "https://invest.firstrade.com/cgi-bin/orderstatus"
 
+def cancel_order():
+    return "https://api3x.firstrade.com/private/cancel_order"
 
-def status():
-    return "https://invest.firstrade.com/scripts/profile/margin_v2.php"
+
+def option_dates(symbol):
+    return f"https://api3x.firstrade.com/public/oc?m=get_exp_dates&root_symbol={symbol}"
+
+
+def option_quotes(symbol, date):
+    return f"https://api3x.firstrade.com/public/oc?m=get_oc&root_symbol={symbol}&exp_date={date}&chains_range=A"
+
+
+def greek_options():
+    return "https://api3x.firstrade.com/private/greekoptions/analytical"
+
+
+def option_order():
+    return "https://api3x.firstrade.com/private/option_order"
 
 
 def session_headers():
     headers = {
-        "Accept": "*/*",
-        "Accept-Encoding": "gzip, deflate, br",
-        "Accept-Language": "en-US,en;q=0.9",
-        "Host": "invest.firstrade.com",
-        "Referer": "https://invest.firstrade.com/cgi-bin/main",
-        "Connection": "keep-alive",
-        "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36 Edg/116.0.1938.81",
+        "Accept-Encoding": "gzip",
+        "Connection": "Keep-Alive",
+        "Host": "api3x.firstrade.com",
+        "User-Agent": "okhttp/4.9.2",   
     }
     return headers
+
+
+def access_token():
+    return "833w3XuIFycv18ybi"

firstrade-0.0.30.dist-info/METADATA

@@ -0,0 +1,225 @@
+Metadata-Version: 2.1
+Name: firstrade
+Version: 0.0.30
+Summary: An unofficial API for Firstrade
+Home-page: https://github.com/MaxxRK/firstrade-api
+Download-URL: https://github.com/MaxxRK/firstrade-api/archive/refs/tags/0030.tar.gz
+Author: MaxxRK
+Author-email: maxxrk@pm.me
+License: MIT
+Keywords: FIRSTRADE,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: requests
+Requires-Dist: beautifulsoup4
+Requires-Dist: lxml
+
+# 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!
+
+## Disclaimer
+I am not a financial advisor and not affiliated with Firstrade 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 firstrade
+```
+
+## Quikstart
+
+The code below will:
+- Login and print account info.
+- Get a quote for 'INTC' and print out the information
+- Place a dry run market order for 'INTC' on the first account in the `account_numbers` list
+- Print out the order confirmation
+- Contains a cancel order example
+- Get an option Dates, Quotes, and Greeks
+- Place a dry run option order
+
+```python
+from firstrade import account, order, symbols
+
+# Create a session
+ft_ss = account.FTSession(username="", password="", email = "", profile_path="")
+need_code = ft_ss.login()
+if need_code:
+    code = input("Please enter the pin sent to your email/phone: ")
+    ft_ss.login_two(code)
+
+# Get account data
+ft_accounts = account.FTAccountData(ft_ss)
+if len(ft_accounts.account_numbers) < 1:
+    raise Exception("No accounts found or an error occured exiting...")
+
+# Print ALL account data
+print(ft_accounts.all_accounts)
+
+# Print 1st account number.
+print(ft_accounts.account_numbers[0])
+
+# Print ALL accounts market values.
+print(ft_accounts.account_balances)
+
+# Get quote for INTC
+quote = symbols.SymbolQuote(ft_ss, ft_accounts.account_numbers[0], "INTC")
+print(f"Symbol: {quote.symbol}")
+print(f"Tick: {quote.tick}")
+print(f"Exchange: {quote.exchange}")
+print(f"Bid: {quote.bid}")
+print(f"Ask: {quote.ask}")
+print(f"Last: {quote.last}")
+print(f"Bid Size: {quote.bid_size}")
+print(f"Ask Size: {quote.ask_size}")
+print(f"Last Size: {quote.last_size}")
+print(f"Bid MMID: {quote.bid_mmid}")
+print(f"Ask MMID: {quote.ask_mmid}")
+print(f"Last MMID: {quote.last_mmid}")
+print(f"Change: {quote.change}")
+print(f"High: {quote.high}")
+print(f"Low: {quote.low}")
+print(f"Change Color: {quote.change_color}")
+print(f"Volume: {quote.volume}")
+print(f"Quote Time: {quote.quote_time}")
+print(f"Last Trade Time: {quote.last_trade_time}")
+print(f"Real Time: {quote.realtime}")
+print(f"Fractional: {quote.is_fractional}")
+print(f"Company Name: {quote.company_name}")
+
+# Get positions and print them out for an account.
+positions = ft_accounts.get_positions(account=ft_accounts.account_numbers[1])
+print(positions)
+for item in positions["items"]:
+    print(
+        f"Quantity {item["quantity"]} of security {item["symbol"]} held in account {ft_accounts.account_numbers[1]}"
+    )
+
+# Get account history (past 200)
+history = ft_accounts.get_account_history(account=ft_accounts.account_numbers[0])
+for item in history["items"]:
+    print(f"Transaction: {item["symbol"]} on {item["report_date"]} for {item["amount"]}.")
+
+
+# Create an order object.
+ft_order = order.Order(ft_ss)
+
+# Place dry run order and print out order confirmation data.
+order_conf = ft_order.place_order(
+    ft_accounts.account_numbers[0],
+    symbol="INTC",
+    price_type=order.PriceType.LIMIT,
+    order_type=order.OrderType.BUY,
+    duration=order.Duration.DAY,
+    quantity=1,
+    dry_run=True,
+)
+
+print(order_conf)
+
+if "order_id" not in order_conf["result"]:
+    print("Dry run complete.")
+    print(order_conf["result"])
+else:
+    print("Order placed successfully.")
+    print(f"Order ID: {order_conf["result"]["order_id"]}.")
+    print(f"Order State: {order_conf["result"]["state"]}.")
+
+# Cancel placed order
+# cancel = ft_accounts.cancel_order(order_conf['result']["order_id"])
+# if cancel["result"]["result"] == "success":
+    # print("Order cancelled successfully.")
+# print(cancel)
+
+# Check orders
+recent_orders = ft_accounts.get_orders(ft_accounts.account_numbers[0])
+print(recent_orders)
+
+#Get option dates
+option_first = symbols.OptionQuote(ft_ss, "INTC")
+for item in option_first.option_dates["items"]:
+    print(f"Expiration Date: {item["exp_date"]} Days Left: {item["day_left"]} Expiration Type: {item["exp_type"]}")
+
+# Get option quote
+option_quote = option_first.get_option_quote("INTC", option_first.option_dates["items"][0]["exp_date"])
+print(option_quote)
+
+# Get option greeks
+option_greeks = option_first.get_greek_options("INTC", option_first.option_dates["items"][0]["exp_date"])
+print(option_greeks)
+
+print(f"Placing dry option order for {option_quote["items"][0]["opt_symbol"]} with a price of {option_quote["items"][0]["ask"]}.")
+print("Symbol readable ticker 'INTC'")
+
+# Place dry option order
+option_order = ft_order.place_option_order(
+    account=ft_accounts.account_numbers[0],
+    option_symbol=option_quote["items"][0]["opt_symbol"],
+    order_type=order.OrderType.BUY_OPTION,
+    price_type=order.PriceType.MARKET,
+    duration=order.Duration.DAY,
+    contracts=1,
+    dry_run=True,
+)
+
+print(option_order)
+
+# Delete cookies
+ft_ss.delete_cookies()
+```
+
+`You can also find this code in test.py`
+
+---
+
+## Implemented Features
+
+- [x] Login (With all 2FA methods now supported!) 
+- [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)
+- [x] Cancel placed orders
+- [x] Options (Orders, Quotes, Greeks)
+- [x] Order History
+
+## TO DO
+
+- [ ] Test options fully
+- [ ] Give me some Ideas!
+
+## Options
+
+### I am very new to options trading and have not fully tested this feature.
+
+Please:
+- USE THIS FEATURE LIKE IT IS A ALPHA/BETA
+- PUT IN A GITHUB ISSUE IF YOU FIND ANY PROBLEMS
+  
+## 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)

firstrade-0.0.30.dist-info/RECORD

@@ -0,0 +1,11 @@
+firstrade/__init__.py,sha256=fNiWYgSTjElY1MNv0Ug-sVLMTR2z_Ngri_FY7Pekdrw,95
+firstrade/account.py,sha256=U9U-LXmOS3pQK7WjQ3oXqlKvl3r-2kphBPvWGsD3q9Y,13287
+firstrade/exceptions.py,sha256=tL9hXGTZM1Ds0yWNCLSqD7hdcL_157CHLJT0e7AjxOg,1893
+firstrade/order.py,sha256=_IwKsJ58A8KxiiaFFNbGBE7sak4G23s4_uFaCSovx00,8789
+firstrade/symbols.py,sha256=9HKvg-rqX3GNCUKHtIOw81_MNkboamihmAaj6MpheW0,7930
+firstrade/urls.py,sha256=7jeIaRERP8yDbZrnw2QcWn2J0z2MYKSNFJhJvef8I2Q,1859
+firstrade-0.0.30.dist-info/LICENSE,sha256=wPEQjDqm5zMBmEcZp219Labmq_YIjhudpZiUzyVKaFA,1057
+firstrade-0.0.30.dist-info/METADATA,sha256=jNfpF431f4pEIsEBTc3dI8IUlIxhI4TZJcoXp0API8U,7186
+firstrade-0.0.30.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+firstrade-0.0.30.dist-info/top_level.txt,sha256=tdA8v-KDxU1u4VV6soiNWGBlni4ojv_t_j2wFn5nZcs,10
+firstrade-0.0.30.dist-info/RECORD,,

{firstrade-0.0.20.dist-info → firstrade-0.0.30.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.3.0)
+Generator: setuptools (72.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

firstrade-0.0.20.dist-info/METADATA

@@ -1,81 +0,0 @@
-Metadata-Version: 2.1
-Name: firstrade
-Version: 0.0.20
-Summary: An unofficial API for Firstrade
-Home-page: https://github.com/MaxxRK/firstrade-api
-Download-URL: https://github.com/MaxxRK/firstrade-api/archive/refs/tags/0020.tar.gz
-Author: MaxxRK
-Author-email: maxxrk@pm.me
-License: MIT
-Keywords: FIRSTRADE,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: requests
-Requires-Dist: beautifulsoup4
-Requires-Dist: lxml
-
-# 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
-
-`Checkout test.py for sample code.`
-
-This code 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.`
-
----
-
-## 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!
-
-## 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) 

firstrade-0.0.20.dist-info/RECORD

@@ -1,10 +0,0 @@
-firstrade/__init__.py,sha256=fNiWYgSTjElY1MNv0Ug-sVLMTR2z_Ngri_FY7Pekdrw,95
-firstrade/account.py,sha256=xDgTMXDy2UWUNi4kboXAKKBrbmZGpXLJ11MCHlMvzB0,9218
-firstrade/order.py,sha256=chDqutqA3H7_5NMnleGoqD3OdHms4iTCRZ34lKZ1_FU,8507
-firstrade/symbols.py,sha256=tZD7jexvyvh1rTaOdAKv_vyZWzpjffvl_nPwBe1QaiA,3633
-firstrade/urls.py,sha256=OrfXGDsNpA2rTm4o55KAQzpeigG_pxufWyTDBlbhJYQ,1248
-firstrade-0.0.20.dist-info/LICENSE,sha256=wPEQjDqm5zMBmEcZp219Labmq_YIjhudpZiUzyVKaFA,1057
-firstrade-0.0.20.dist-info/METADATA,sha256=9Uhmo3S2cvYc5fyTpyACPxHTpCIS5p1GgBOqb2csZ-A,2399
-firstrade-0.0.20.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
-firstrade-0.0.20.dist-info/top_level.txt,sha256=tdA8v-KDxU1u4VV6soiNWGBlni4ojv_t_j2wFn5nZcs,10
-firstrade-0.0.20.dist-info/RECORD,,