This repo contains a suite of Python sample code that desmonstrates the use of OANDA's v20 REST API along with OANDA's v20 bindings for Python.
The following procedure describes how to create a virtualenv appropriate for running the v20 sample code:
#
# Set up the virtualenv and install required packages. By default the
# virtualenv will be setup to use python3. If python2 is desired, use the make
# target "bootstrap-python2" and the virtualenv will be created under
# "env-python2"
#
user@host: ~/v20-python-samples$ make bootstrap
#
# Enter the virtualenv
#
user@host: ~/v20-python-samples$ source env/bin/activate
#
# Create the v20-* launch entry points in the virtualenv. These entry points
# are aliases for the scripts which use the v20 REST API to interact with an
# account (e.g. v20-market-order, v20-trades-list, etc.)
#
(env)user@host: ~/v20-python-samples$ python setup.py developThe v20-python-samples virtualenv must be activated to ensure that the current enviroment is set up correctly to run the sample code. This is done using the virualenv's activate script:
user@host: ~/v20-python-samples$ source env/bin/activate
(env)user@host: ~/v20-python-samples$The "(env)" prefix found in the prompt indicates that we are using the virtualenv "env". To leave the virtualenv, run the deactivate function:
(env)user@host: ~/v20-python-samples$ deactivate
user@host: ~/v20-python-samples$ Most of the examples provided use a v20.conf discussed below. For a full
example of how to create and use a v20 API context without the configuration
wrapper, please examine src/market_order_full_example.py. This program
enables the creation of a limited Market Order solely based on command line
arguments.
Using OANDA's v20 REST API requires configuration to set up connections and interact with the endpoints. This configuration includes:
- API hostname
- API port
- API token
- username of client
- Account ID of account being manipulated
To simplify the management of this configuration, the v20 Python sample code requires that a configuration file be created. All of the sample code loads this configuration file prior to connecting to the v20 system.
The v20 configuration is stored in a YAML file that resembles the following:
hostname: api-fxpractice.oanda.com
streaming_hostname: stream-fxpractice.oanda.com
port: 443
ssl: true
token: e6ab562b039325f12a026c6fdb7b71bb-b3d8721445817159410f01514acd19hbc
username: user
accounts:
- 101-001-100000-001
- 101-001-100000-002
active_account: 101-001-100000-001v20 configuration files may be generated manually, however a script is provided that
will generate one interactively located at src/configure.py.
To run it and generate a v20 configuration file, simply run:
(env)user@host: ~/v20-python-samples$ v20-configureand follow the instructions.
There are several ways to load a v20 configuration file in each of v20 sample scripts:
The --config options allows you to specify the location of a valid v20 configuration file v20. Example:
(env)user@host: ~/v20-python-samples$ v20-account-details --config /home/user/v20.confThe default location for the v20 configuration file is ~/.v20.conf. If a v20
configuration file exists in the default location, no --config option needs
to be used. Example:
# Looks for config file at ~/.v20.conf
(env)user@host: ~/v20-python-samples$ v20-account-detailsThis V20_CONF environment variable changes what the default location of the
v20 configuration file is. If a configuration file exists in this location, no
--config option needs to be used. Example:
(env)user@host: ~/v20-python-samples$ export V20_CONF=/home/user/v20.conf
(env)user@host: ~/v20-python-samples$ v20-account-detailsFollowing is a listing of the sample code provided. More details can be found in the READMEs provided in each src directory.