GBM Plus API Python Library

The GBM Plus API Python library aims to provide all current API calls to interface with the GBM Plus/Homebroker platform.

Setup

1. Get the CLIENT_ID from the GBM Plus login dashboard

2. Keep your USER_EMAIL, USER_PASSWORD and CLIENT_ID safe and secure. You can use environment variables for development.

3. Install the latest version of Python 3

4. Use pip (or an alternative such as easy_install) to install the library from the Python Package Index:

   • pip install gbmplus
   • If you have both Python3 and Python2 installed, you may need to use pip3 (so pip3 install gbmplus) along with python3 on your system
   • If gbmplus was previously installed, you can upgrade to the latest non-beta release with pip install --upgrade gbmplus

Usage

1. Export your USER_EMAIL, USER_PASSWORD and CLIENT_ID as environment variables, for example:

   Linux

   export USER_EMAIL="xxxxxx@xxxxx.com"
   export USER_PASSWORD="shabadabadashabadabadaenelcentrodelplaneta"
   export CLIENT_ID="xxxxxxxxxxxxxxxxxxx"
   

   Windows Powershell

   $env:USER_EMAIL="xxxxxx@xxxxx.com"
   $env:USER_PASSWORD="shabadabadashabadabadaolvidadoenlabanqueta"
   $env:CLIENT_ID="xxxxxxxxxxxxxxxxxxx"
   

2. Alternatively, define your USER_EMAIL, USER_PASSWORD and CLIENT_ID as variables in your source code; this method is not recommended due to its inherent insecurity.

3. Single line of code to import and use the library goes at the top of your script:

   import gbmplus
   

4. Instantiate the client (API consumer class), optionally specifying any of the parameters available to set:

   trader_object = gbmplus.GBMPlusAPI(output_log=False)
   

5. Make API calls in your source code, using the format client.scope.operation, where client is the name you defined in the previous step (trader_object above), scope is the corresponding scope that represents a module, and operation is the operation of the API endpoint. For example, to make a call to get the list of Accounts (or Strategies), use this function call:

   accounts = trader_object.accounts.getAccounts()
   print(accounts)
   

Examples

You can find working example scripts in the examples folder.