Update urls.py - Options Orders

docs/changelog.rst

@@ -5,6 +5,15 @@ Changelog
 
 .. towncrier release notes start
 
+Pyrh 2.1.3 (2024-08-07)
+=======================
+
+Features
+--------
+
+- Added Option orders support for build and execution (#317)
+
+
 Pyrh 2.1.2 (2023-03-04)
 =======================
 

newsfragments/317.misc

@@ -0,0 +1 @@
+- Added Option orders support for build and execution (#317)

pyrh/urls.py

@@ -33,6 +33,7 @@
 OPTIONS_BASE = API_BASE / "options/"
 OPTIONS_CHAIN_BASE = OPTIONS_BASE / "chains/"
 OPTIONS_INSTRUMENTS_BASE = OPTIONS_BASE / "instruments/"
+OPTIONS_ORDERS_BASE = OPTIONS_BASE / "orders/"
 
 # User
 USER = API_BASE / "user/"
@@ -117,6 +118,21 @@ def build_orders(order_id: Optional[str] = None) -> URL:
     else:
         return ORDERS_BASE
 
+def build_options_orders(order_id: Optional[str] = None) -> URL:
+    """Build endpoint to place options orders."
+
+    Args:
+        order_id: the id of the order
+
+    Returns:
+        A constructed URL for a particular order or the base URL for options orders.
+
+    """
+    if order_id is not None:
+        return OPTIONS_ORDERS_BASE / f"{order_id}/"
+    else:
+        return OPTIONS_ORDERS_BASE
+
 
 def build_news(stock: str) -> URL:
     """Build news endpoint for a particular stock