Skip to main content

Questrade API wrapper for Python

Project description

Build Status

Qtrade

This is a very basic Python 3 wrapper for the Questrade API, a Canadian low cost broker.

Installation

This package is available via PyPI and can be installed via the command

pip install qtrade

Usage

The main class of the package is called Questrade and houses most of the functionality provided by the package. Below are a few examples for possible use cases.

Token management

The central class can be initialized via

from qtrade import Questrade

qtrade = Questrade(access_code='<access_code>')
qtrade.get_access_token()

where <access_code> is the token that one gets from the Questrade API portal. It is called access_code since this initial token is used to get the full token data that will include

{'access_token': <access_token>,
 'api_server': '<api_url>',
 'expires_in': 1234,
 'refresh_token': <refresh_token>,
 'token_type': 'Bearer'}

The first call initializes the class and the second call gets the full token.

Another way to initialize the class is to use a token yaml-file via:

qtrade = Questrade(token_yaml='<yaml_path>')

where the yaml-file would have the general form

access_token: <access_token>
api_server: <api_url>
expires_in: 1234
refresh_token: <refresh_token>
token_type: Bearer

If the token is expired, one can use

qtrade.refresh_token()

to refresh the access token using the saved refresh token.

Once the tokens are set correctly, I have currently added methods to get ticker quotes, the current status of all positions in any Questrade account that is associated with the tokens, any account activities such as trades and dividend payments as well as historical data for tickers that are supported by Questrade.

Basic functionality

There currently exists some basic functionality to get stock information via

aapl, amzn = qtrade.ticker_information(['AAPL', 'AMZN'])

and current stock quotes can be obtained via

aapl, amzn = qtrade.get_quote(['AAPL', 'AMZN'])

In addition, one can get historical stock quotes via

aapl_history = = qtrade.get_historical_data('AAPL', '2018-08-01', '2018-08-21','OneHour')

Here, the last input parameter is the interval between quotes. Another option could be 'OneDay'. For more options, see the Questrade API description.

Account information

In addition, the Questrade API gives access to account information about the accounts connected to the token. The accounts IDs can be accessed via

account_ids = qtrade.get_account_id()

By using the correct account ID, one can get the positions of the accounts via

positions = qtrade.get_account_positions(account_id=123456)

Finally, there exists a method to get all account activities (trades, dividends recieved, etc.) of an account in a certain time frame via

activities = qtrade.get_account_activities(123456, '2018-08-01', '2018-08-16')

Contributors

There is a test suite that can be run via python -m pytest.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for qtrade, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size qtrade-0.1.1-py3-none-any.whl (7.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size qtrade-0.1.1.tar.gz (6.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page