create_connection_object: Create a kite connect connection object.
In prodipta/kiteconnect3: Connect to Zerodha Kite Connect API version 3

Description Usage Arguments Details Value

This function returns an object of kite connect type, given the input parametrs.

1	create_connection_object(params)

params

a list mapping object property name to values. See details for more.

This function creates an S4 object from the input parameters. The required parameters are api_key, api_secret. If root (the api root), routes (the list of api endpoints) and login (the login url) is supplied, they are used. Otherwise the internally defined values are used. Only a single instance of this class per 'api_key' should be initialized. Parameters should be a named list of all inputs to create a connection. The important attributes are: api_key( character) - your api key; api_secret(character) - your api secret (both of these are available on the developer page in your kite app, and must be supplied during object creation); request_token(character) - should be set after a successful login flow; access_token(character) - obtained using fetch_access_token function (which also set the attribute 'details'). Some attributes like root (api root URL), login (kite api specific login URL) and routes (list of api end points) are optional and recommended to use the default values. Other attributes which are not implemented are: debug(logical); micro_cache (logical); session_hook(function); timeout(numeric) and proxies(character).

S4 object for kite connect which can be used in further api calls.

prodipta/kiteconnect3 documentation built on Sept. 24, 2020, 8:30 a.m.