Add client changes

Author: areed1192

ibw/client.py

@@ -309,12 +309,15 @@ def _headers(self, mode: str = 'json') -> Dict:
         """ 
             Returns a dictionary of default HTTP headers for calls to TD Ameritrade API,
             in the headers we defined the Authorization and access token.
+        
+        Arguments:
+        ----
+        mode {str} -- Defines the content-type for the headers dictionary.
+            default is 'json'. Possible values are ['json','form']
 
-            NAME: mode
-            DESC: Defines the content-type for the headers dictionary.
-                  default is 'json'. Possible values are ['json','form']
-            TYPE: String
-
+        Returns:
+        ----
+        Dict
         """
 
         if mode == 'json':
@@ -326,41 +329,43 @@ def _headers(self, mode: str = 'json') -> Dict:
 
 
     def _build_url(self, endpoint: str) -> str:
-        """
-            builds a url for a request.
-
-            NAME: endpoint
-            DESC: The URL that needs conversion to a full endpoint URL.
-            TYPE: String
+        """Builds a url for a request.
 
-            RTYPE: String
+        Arguments:
+        ----
+        endpoint {str} -- The URL that needs conversion to a full endpoint URL.
 
+        Returns:
+        ----
+        {srt} -- A full URL path.
         """
 
         # otherwise build the URL
         return urllib.parse.unquote(urllib.parse.urljoin(self.ib_gateway_path, self.api_version) + r'portal/' + endpoint)
 
 
     def _make_request(self, endpoint: str, req_type: str, params: Dict = None) -> Dict:
-        """
-            Handles all the requests made by the client and correctly organizes
-            the information so it is sent correctly. Additionally it will also
-            build the URL.
+        """Handles the request to the client.
 
-            NAME: endpoint
-            DESC: The endpoint we wish to request.
-            TYPE: String
+        Handles all the requests made by the client and correctly organizes
+        the information so it is sent correctly. Additionally it will also
+        build the URL.
 
-            NAME: type
-            DESC: Defines the type of request to be made. Can be one of four
-                  possible values ['GET','POST','DELETE','PUT']
-            TYPE: String
+        Arguments:
+        ----
+        endpoint {str} -- The endpoint we wish to request.
+
+        req_type {str} --  Defines the type of request to be made. Can be one of four
+            possible values ['GET','POST','DELETE','PUT']
+
+        params {dict} -- Any arguments that are to be sent along in the request. That
+            could be parameters of a 'GET' request, or a data payload of a
+            'POST' request.
+        
+        Returns:
+        ----
+        {Dict} -- A response dictionary.
 
-            NAME: params
-            DESC: Any arguments that are to be sent along in the request. That
-                  could be parameters of a 'GET' request, or a data payload of a
-                  'POST' request.
-            TYPE: Dictionary
         """
 
         # first build the url
@@ -421,18 +426,24 @@ def _make_request(self, endpoint: str, req_type: str, params: Dict = None) -> Di
 
 
     def _prepare_arguments_list(self, parameter_list: List[str]) -> str:
-        """
-            Some endpoints can take multiple values for a parameter, this
-            method takes that list and creates a valid string that can be
-            used in an API request. The list can have either one index or
-            multiple indexes.
+        """Prepares the arguments for the request.
 
-            NAME: parameter_list
-            DESC: A list of paramater values assigned to an argument.
-            TYPE: List
+        Some endpoints can take multiple values for a parameter, this
+        method takes that list and creates a valid string that can be
+        used in an API request. The list can have either one index or
+        multiple indexes.
 
-            EXAMPLE:
-            SessionObject.prepare_arguments_list(parameter_list = ['MSFT', 'SQ'])
+        Arguments:
+        ----
+        parameter_list {List} -- A list of paramater values assigned to an argument.
+
+        Usage:
+        ----
+            >>> SessionObject._prepare_arguments_list(parameter_list=['MSFT','SQ'])
+        
+        Returns:
+        ----
+        {str} -- The joined list.
 
         """
 
@@ -445,7 +456,6 @@ def _prepare_arguments_list(self, parameter_list: List[str]) -> str:
 
         return parameter_list
 
-
     """
         SESSION ENDPOINTS
     """
@@ -1025,6 +1035,25 @@ def futures_search(self, symbols: List[str]) -> Dict:
 
         return content        
 
+    def symbols_search_list(self, symbols: List[str]) -> Dict:
+        """
+            Returns a list of non-expired future contracts for given symbol(s).
+
+            NAME: Symbol
+            DESC: List of case-sensitive symbols separated by comma.
+            TYPE: List<String>
+
+            RTYPE: Dictionary
+        """
+
+        # define the request components
+        endpoint = '/trsrv/stocks'
+        req_type = 'GET'
+        payload = {'symbols':'{}'.format(','.join(symbols))}
+        content = self._make_request(endpoint = endpoint, req_type = req_type, params = payload)
+
+        return content     
+
     """
         PORTFOLIO ACCOUNTS ENDPOINTS
     """

samples/test_client.py samples/api_client.pysamples/test_client.py renamed to samples/api_client.py

@@ -22,12 +22,12 @@
 # create a new session
 ib_client.create_session()
 
-# Logout of the client.
-logout_response = ib_client.logout()
-print(logout_response)
+# # Logout of the client.
+# logout_response = ib_client.logout()
+# print(logout_response)
 
-# close the current session.
-ib_client.close_session()
+# # close the current session.
+# ib_client.close_session()
 
 
 # '''