firstrade 0.0.14__py3-none-any.whl → 0.0.16__py3-none-any.whl

firstrade/order.py

@@ -1,13 +1,12 @@
 from enum import Enum
 
-from firstrade.account import FTSession
-from firstrade import urls
-
 from bs4 import BeautifulSoup
 
+from firstrade import urls
+from firstrade.account import FTSession
 
-class PriceType(str, Enum):
 
+class PriceType(str, Enum):
     """
     This is an :class: 'enum.Enum'
     that contains the valid price types for an order.
@@ -22,7 +21,6 @@ class PriceType(str, Enum):
 
 
 class Duration(str, Enum):
-
     """
     This is an :class:'~enum.Enum'
     that contains the valid durations for an order.
@@ -36,7 +34,6 @@ class Duration(str, Enum):
 
 
 class OrderType(str, Enum):
-
     """
     This is an :class:'~enum.Enum'
     that contains the valid order types for an order.
@@ -49,11 +46,11 @@ class OrderType(str, Enum):
 
 
 class Order:
-
     """
     This class contains information about an order.
     It also contains a method to place an order.
     """
+
     def __init__(self, ft_session: FTSession):
         self.ft_session = ft_session
         self.order_confirmation = {}
@@ -68,6 +65,7 @@ class Order:
         duration: Duration,
         price=0.00,
         dry_run=True,
+        notional=False,
     ):
         """
         Builds and places an order.
@@ -100,6 +98,7 @@ class Order:
             "submiturl": "/cgi-bin/orderbar",
             "orderbar_clordid": "",
             "orderbar_accountid": "",
+            "notional": "yes" if notional else "",
             "stockorderpage": "yes",
             "submitOrders": "1",
             "previewOrders": previewOrders,
@@ -162,3 +161,67 @@ class Order:
             order_confirmation["actiondata"] = action_data
         order_confirmation["errcode"] = order_data.find("errcode").text.strip()
         self.order_confirmation = order_confirmation
+
+
+def get_orders(ft_session, account):
+    """
+    Retrieves existing order data for a given account.
+
+    Args:
+        ft_session (FTSession): The session object used for making HTTP requests to Firstrade.
+        account (str): Account number of the account to retrieve orders for.
+
+    Returns:
+        list: A list of dictionaries, each containing details about an order.
+    """
+
+    # Data dictionary to send with the request
+    data = {
+        'accountId': account,
+    }
+
+    # Post request to retrieve the order data
+    response = ft_session.post(url=urls.order_list(), headers=urls.session_headers(), data=data).text
+
+    # Parse the response using BeautifulSoup
+    soup = BeautifulSoup(response, "html.parser")
+
+    # Find the table containing orders
+    table = soup.find('table', class_='tablesorter')
+    if not table:
+        return []
+
+    rows = table.find_all('tr')[1:]  # skip the header row
+
+    orders = []
+    for row in rows:
+        try:
+            cells = row.find_all('td')
+            tooltip_content = row.find('a', {'class': 'info'}).get('onmouseover')
+            tooltip_soup = BeautifulSoup(tooltip_content.split('tooltip.show(')[1].strip("');"), 'html.parser')
+            order_ref = tooltip_soup.find(text=lambda text: 'Order Ref' in text)
+            order_ref_number = order_ref.split('#: ')[1] if order_ref else None
+            status = cells[8]
+            # print(status)
+            sub_status = status.find('strong')
+            # print(sub_status)
+            sub_status = sub_status.get_text(strip=True)
+            # print(sub_status)
+            status = status.find('strong').get_text(strip=True) if status.find('strong') else status.get_text(strip=True)
+            order = {
+                'Date/Time': cells[0].get_text(strip=True),
+                'Reference': order_ref_number,
+                'Transaction': cells[1].get_text(strip=True),
+                'Quantity': int(cells[2].get_text(strip=True)),
+                'Symbol': cells[3].get_text(strip=True),
+                'Type': cells[4].get_text(strip=True),
+                'Price': float(cells[5].get_text(strip=True)),
+                'Duration': cells[6].get_text(strip=True),
+                'Instr.': cells[7].get_text(strip=True),
+                'Status': status,
+            }
+            orders.append(order)
+        except Exception as e:
+            print(f"Error parsing order: {e}")
+
+    return orders

firstrade/symbols.py

@@ -21,6 +21,8 @@ class SymbolQuote:
         low (float): The lowest price for the symbol during the trading day.
         volume (str): The volume of shares traded for the symbol.
         company_name (str): The name of the company associated with the symbol.
+        real_time (bool): If the quote is real-time or not
+        fractional (bool):  If the stock can be traded fractionally, or not
     """
 
     def __init__(self, ft_session: FTSession, symbol: str):
@@ -41,17 +43,19 @@ class SymbolQuote:
         quote = soup.find("quote")
         self.symbol = quote.find("symbol").text
         self.exchange = quote.find("exchange").text
-        self.bid = float(quote.find("bid").text)
-        self.ask = float(quote.find("ask").text)
-        self.last = float(quote.find("last").text)
-        self.change = float(quote.find("change").text)
+        self.bid = float(quote.find("bid").text.replace(",", ""))
+        self.ask = float(quote.find("ask").text.replace(",", ""))
+        self.last = float(quote.find("last").text.replace(",", ""))
+        self.change = float(quote.find("change").text.replace(",", ""))
         if quote.find("high").text == "N/A":
             self.high = None
         else:
-            self.high = float(quote.find("high").text)
+            self.high = float(quote.find("high").text.replace(",", ""))
         if quote.find("low").text == "N/A":
             self.low = "None"
         else:
-            self.low = float(quote.find("low").text)
+            self.low = float(quote.find("low").text.replace(",", ""))
         self.volume = quote.find("vol").text
         self.company_name = quote.find("companyname").text
+        self.real_time = quote.find("realtime").text == "T"
+        self.fractional = quote.find("fractional").text == "T"

firstrade/urls.py

@@ -25,6 +25,9 @@ def orderbar():
 def account_status():
     return "https://invest.firstrade.com/cgi-bin/account_status"
 
+def order_list():
+    return "https://invest.firstrade.com/cgi-bin/orderstatus"
+
 
 def status():
     return "https://invest.firstrade.com/scripts/profile/margin_v2.php"

firstrade-0.0.16.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.1
+Name: firstrade
+Version: 0.0.16
+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/0016.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
+
+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!
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O5O6PTOYG)

firstrade-0.0.16.dist-info/RECORD

@@ -0,0 +1,10 @@
+firstrade/__init__.py,sha256=fNiWYgSTjElY1MNv0Ug-sVLMTR2z_Ngri_FY7Pekdrw,95
+firstrade/account.py,sha256=xDgTMXDy2UWUNi4kboXAKKBrbmZGpXLJ11MCHlMvzB0,9218
+firstrade/order.py,sha256=BK2OmIOr_LO4SrNRVWjkydaoc_4fLkl6Rr7_LCRTyLE,7635
+firstrade/symbols.py,sha256=0lVuHgmrpwANyRlOlsXCTr6xsT5aWqBIIXH66q9ezb8,2675
+firstrade/urls.py,sha256=OrfXGDsNpA2rTm4o55KAQzpeigG_pxufWyTDBlbhJYQ,1248
+firstrade-0.0.16.dist-info/LICENSE,sha256=wPEQjDqm5zMBmEcZp219Labmq_YIjhudpZiUzyVKaFA,1057
+firstrade-0.0.16.dist-info/METADATA,sha256=bHjrgXkFBouGxytPrSiZJLFUJY3o-hcyH8fMymX_iQg,2307
+firstrade-0.0.16.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+firstrade-0.0.16.dist-info/top_level.txt,sha256=tdA8v-KDxU1u4VV6soiNWGBlni4ojv_t_j2wFn5nZcs,10
+firstrade-0.0.16.dist-info/RECORD,,

{firstrade-0.0.14.dist-info → firstrade-0.0.16.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

firstrade-0.0.14.dist-info/METADATA

@@ -1,137 +0,0 @@
-Metadata-Version: 2.1
-Name: firstrade
-Version: 0.0.14
-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/0014.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. 
-
- ---
-
-## 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
-
-```
-from firstrade import account, order, symbols
-
-# Create a session
-ft_ss = account.FTSession(username="", password="", pin="")
-
-# 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, "INTC")
-print(f"Symbol: {quote.symbol}")
-print(f"Exchange: {quote.exchange}")
-print(f"Bid: {quote.bid}")
-print(f"Ask: {quote.ask}")
-print(f"Last: {quote.last}")
-print(f"Change: {quote.change}")
-print(f"High: {quote.high}")
-print(f"Low: {quote.low}")
-print(f"Volume: {quote.volume}")
-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])
-for key in ft_accounts.securities_held:
-    print(
-        f"Quantity {ft_accounts.securities_held[key]['quantity']} of security {key} held in account {ft_accounts.account_numbers[1]}"
-    )
-
-# Create an order object.
-ft_order = order.Order(ft_ss)
-
-# Place order and print out order confirmation data.
-ft_order.place_order(
-    ft_accounts.account_numbers[0],
-    symbol="INTC",
-    price_type=order.PriceType.MARKET,
-    order_type=order.OrderType.BUY,
-    quantity=1,
-    duration=order.Duration.DAY,
-    dry_run=True,
-)
-
-# Print Order data Dict
-print(ft_order.order_confirmation)
-
-# Check if order was successful
-if ft_order.order_confirmation["success"] == "Yes":
-    print("Order placed successfully.")
-    # Print Order ID
-    print(f"Order ID: {ft_order.order_confirmation['orderid']}.")
-else:
-    print("Failed to place order.")
-    # Print errormessage
-    print(ft_order.order_confirmation["actiondata"])
-# Delete cookies
-ft_ss.delete_cookies()
-```
-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
-
-## TO DO
- - [ ] Check on placed order status.
- - [ ] Cancel placed orders
- - [ ] Options
- - [ ] Give me some Ideas!
-
-[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O5O6PTOYG)  

firstrade-0.0.14.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=qHVTufY3UbRakrjFPd6hv8fxknATSoHFy2E20zl4PGE,5130
-firstrade/symbols.py,sha256=m5v1QeY2crtNw7mymoV6wpD_J_M-avWK5Lz9DUZJpNE,2315
-firstrade/urls.py,sha256=nAKbOw30cediYI6JDaGc4gL7-m-7WKP3A--BEVrL_cI,1167
-firstrade-0.0.14.dist-info/LICENSE,sha256=wPEQjDqm5zMBmEcZp219Labmq_YIjhudpZiUzyVKaFA,1057
-firstrade-0.0.14.dist-info/METADATA,sha256=fMbzTBfjkCAElFkVCqmtUx_UGhAuP0DA4ZTB2_zRYyE,4076
-firstrade-0.0.14.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-firstrade-0.0.14.dist-info/top_level.txt,sha256=tdA8v-KDxU1u4VV6soiNWGBlni4ojv_t_j2wFn5nZcs,10
-firstrade-0.0.14.dist-info/RECORD,,