- Requests: HTTP for Humans
-
install it using pip
pip install requests
-
- Pandas
-
install it using pip
pip install pandas
-
class ApiClient
in qtx.py
is provisioned to make API requests. In the constructor of the ApiClient
class, a dictionary of default headers for all requests can be supplied so that headers need not be supplied with each request.
default_headers = { 'x-api-key' : '<token>' }
client = ApiClient(default_headers)
To make a GET request, ApiClient.get()
method is used with following params
api_key
: API key required for authenticating the requestsname
:string
api name which will be appended to base_urlparams
:dict
of url params
EXAMPLE
from qtx import qtx
api = "market-data-eod"
params = {
'securityId': 'NSE:NNFM',
'startDate': '2017-02-08',
'endDate': '2017-02-10'
}
api_key = '<api_token>'
client = qtx.ApiClient()
print client.get(api_key, api, params).data_frame()
The get()
method returns a Response
object from which below methods can be used to get response data as json or Pandas DataFrame.
client.get(api_key, name, queryparams).json()
will return response data as json, andclient.get(api_key, name, queryparams).data_frame()
will return response data as pandas DataFrame
python tests/test.py