Add option base model

pyrh/endpoints.py

@@ -37,18 +37,13 @@ def edocuments():
     return API_BASE.with_path("/documents/")
 
 
-def instruments(instrument_id=None, option=None):
+def instruments(options=False):
     """
     Return information about a specific instrument by providing its instrument id.
     Add extra options for additional information such as "popularity"
     """
-    url = API_BASE.with_path(f"/instruments/")
-    if instrument_id is not None:
-        url += f"{instrument_id}"
-    if option is not None:
-        url += f"{option}"
-
-    return url
+    opt = "/options" if options else ""
+    return API_BASE.with_path(f"{opt}/instruments/")
 
 
 def margin_upgrades():
@@ -63,9 +58,9 @@ def notifications():
     return API_BASE.with_path("/notifications/")
 
 
-def orders(order_id=""):
-    return API_BASE.with_path(f"/orders/{order_id}/")
-
+def orders(order_id="", options=False):
+    opt = "/options" if options else ""
+    return base.with_path(f"{opt}/orders/{order_id}/")
 
 def password_reset():
     return API_BASE.with_path("/password_reset/request/")
@@ -75,16 +70,19 @@ def portfolios():
     return API_BASE.with_path("/portfolios/")
 
 
-def positions():
-    return API_BASE.with_path("/positions/")
+def positions(options=False):
+    opt = "/options" if options else ""
+    return API_BASE.with_path("{opt}/positions/")
 
 
 def quotes():
     return API_BASE.with_path("/quotes/")
 
 
-def historicals():
-    return API_BASE.with_path("/quotes/historicals/")
+def historicals(options=False):
+    if options:
+        return API_BASE.with_path(f"/marketdata/options/historicals/")
+    return API_BASE.with_path(f"/quotes/historicals/")
 
 
 def document_requests():

pyrh/models/option.py

@@ -0,0 +1,80 @@
+"""Current portfolio."""
+
+from typing import Any
+
+from marshmallow import fields, post_load
+
+from pyrh.common import JSON
+
+from .base import BaseModel, BaseSchema
+
+
+class Option(BaseModel):
+    """Robinhood Option data class. Represents an options instrument"""
+
+    pass
+
+
+class OptionSchema(BaseSchema):
+    """Robinhood Option schema data loader.
+    Sample result payload from 
+    {
+        "chain_id": "cee01a93-626e-4ee6-9b04-60e2fd1392d1",
+        "chain_symbol": "AAPL",
+        "created_at": "2020-03-31T01:27:43.249339Z",
+        "expiration_date": "2020-04-17",
+        "id": "f098f169-74f9-4b91-b955-6834e1b67a12",
+        "issue_date": "2004-11-29",
+        "min_ticks": {
+            "above_tick": "0.05",
+            "below_tick": "0.01",
+            "cutoff_price": "3.00"
+        },
+        "rhs_tradability": "untradable",
+        "state": "active",
+        "strike_price": "232.5000",
+        "tradability": "tradable",
+        "type": "put",
+        "updated_at": "2020-03-31T01:27:43.249354Z",
+        "url": "https://api.robinhood.com/options/instruments/f098f169-74f9-4b91-b955-6834e1b67a12/"
+    }
+    """
+
+    __model__ = Options
+
+    chain_id = fields.String()
+    chain_symbol = fields.String()
+    created_at = fields.NaiveDateTime()
+    expiration_date = fields.Date()
+    options_id = fields.String() 
+    issue_date = fields.Date()
+    min_ticks = fields.Dict()
+    rhs_tradability = fields.String()
+    state = fields.String()
+    strike_price = fields.Float()
+    tradability = fields.String()
+    options_type = fields.String()  
+    updated_at = fields.NaiveDateTime()
+    url = fields.URL()  
+
+    @post_load
+    def make_object(self, data: JSON, **kwargs: Any) -> Option:
+        """Build model for the Option class.
+
+        Args:
+            data: The JSON diction to use to build the Option.
+            **kwargs: Unused but required to match signature of `Schema.make_object`
+
+        Returns:
+            An instance of the Option class.
+
+        """
+        # Can potentially move this preprocessing part to a helper file
+        prefix = self.__class__.__name__.lower()
+        reserved_word_overwrite = ["type", "id"]
+        for attr in reserved_word_overwrite:
+            k, v = f"{prefix}_{attr}", data.pop("attr")
+            data[k] = v
+
+        data = data.get("results", [{}])[0]
+        return self.__model__(**data)

pyrh/robinhood.py

@@ -48,6 +48,27 @@ def investment_profile(self):
         """Fetch investment_profile."""
         return self.get(endpoints.investment_profile())
 
+    def get_instruments(self, symbol, match=True, options=False):
+    """Query for instruments that match with the given ticker.
+
+    Args:
+        symbol (str): stock ticker
+        match (bool): True if want exact match, False for partial match
+
+    Returns:
+        (:obj: (list)): JSON contents from `instruments` endpoint - list
+        of instruments that match the ticker
+    """
+    ticker = stock.upper()
+    params = {"symbol": ticker} if match else {"query": ticker}
+    res = self.get(endpoints.instruments(options=options), params=params)
+    results = res.get("results", [])
+    while res.get("next"):
+        res = res.get("next")
+        results.extend(res.get("results", []))
+    return results
+
+    @deprecated
     def instruments(self, stock):
         """Fetch instruments endpoint.
 
@@ -67,6 +88,7 @@ def instruments(self, stock):
 
         return res["results"]
 
+    @deprecated
     def instrument(self, id):
         """Fetch instrument info.