Skip to content
A Zorro broker API plugin for Ally Invest, written in Win32 C++.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
AllyInvest
AllyTester
.gitattributes
.gitignore
AllyInvest.sln
LICENSE
README.md

README.md

Ally Invest Plugin for Zorro

Ally Invest is an low-commission stocks and options broker for USA residents. Ally offers its users a REST API, which uses XML and JSON. Orders are placed in a FIXML-variant language.

This plugin was written in Win32 C/C++ using Visual Studio 2017.

Build Instructions

All dependencies have been fully integrated into the folder and slightly modified where necessary. They are:

  • liboauthcpp (for OAuth 1.0a authentication)
  • pugixml (for XML parsing and writing)

This project includes a Visual Studio 2017 solution. You should be able to simply download the entire folder, open the solution, and build it, using the Release x86 build configuration.

Installation Instructions

To install the plugin, simply place the AllyInvest.dll file in the Plugin folder where Zorro is installed.

Login Instructions

To login with the Ally Plugin, you will first need to set up API access with Ally Invest. After you have set up your account with Ally, you must do the following:

  • Go to https://www.ally.com/invest/
  • Click Log In and enter your credentials
  • Click on your account (usually says "individual", depending on your type of account).
  • At the top, go to "Tools" -> "Ally Invest API" -> "Manage Applications"
  • Create a "Personal Application", and follow the steps. Your new application should have been created instantly.
  • Scroll down. Under "Developer Applications", click on the application you created.
  • You should see four scrambled keys. You will need these.
  • Open Zorro.
  • Set "Account" to "Real", and choose the "Ally Invest" plugin from the drop-down menus.
  • Under "User", enter your account number (not to be confused with your website login username)
  • For the password, paste the values in one after the other, in the exact order below (no spaces, no commas):
    1. Consumer Key
    2. Consumer Secret
    3. OAuth Token
    4. OAuth Token Secret

Plugin Capabilities

The following standard Zorro Broker API functions have been implemented:

  • BrokerOpen
  • BrokerHTTP
  • BrokerLogin
  • BrokerTime
  • BrokerAsset
  • BrokerHistory2
    • Historical data is only available for stocks in M1 and M5 formats.
    • Officially, the API only provides 5 days of history. (Nonetheless, the API appears to provide 1 year of equities history.)
    • No options history is available.
  • BrokerBuy
    • The broker API does not include "trade management".
    • Instead, one buys/sells to open and buys/sells to close.
  • BrokerCommand standard functions:
    • GET_COMPLIANCE
    • GET_POSITION
    • GET_OPTIONS
    • GET_UNDERLYING
    • SET_SYMBOL
    • SET_MULTIPLIER
    • SET_COMBO_LEGS
    • SET_DIAGNOSTICS

These BrokerCommand functions have originated with this plugin:

  • SET_COMBO_LEGS
    • Input: Only accepts 2, 3, or 4 as an input, for 2-leg, 3-leg, and 4-leg orders, respectively.
    • Returns 1 if command accepted, 0 if rejected.
    • To use, call the function and then call the orders immediately.
    • For example, if you SET_COMBO_LEGS to 2 and then request two options orders, the order will finally process after the second options order is received.
    • If the order fails, the last leg will return a failure. The script writer will be responsible for zeroing out the prior legs.
    • All of the legs must have matching expiration months and underlying symbols. Otherwise, the order will not be submitted.
    • Below is an example of a two-leg order message the plugin might submit to the Ally Invest servers:
<FIXML xmlns="http://www.fixprotocol.org/FIXML-5-0-SP2">
  <NewOrdMleg TmInForce="0" Px="-3.10" OrdTyp="2" Acct="12345678">
    <Ord OrdQty="4" PosEfct="O">
      <Leg Side="1" Strk="190" Mat="2014-01-18T00:00:00.000-05:00" MMY="201401" SecTyp="OPT" CFI="OC" Sym="IBM"/>
    </Ord>
    <Ord OrdQty="4" PosEfct="O">
      <Leg Side="2" Strk="200" Mat="2014-01-18T00:00:00.000-05:00" MMY="201401" SecTyp="OPT" CFI="OC" Sym="IBM"/>
    </Ord>
  </NewOrdMleg>
</FIXML>
  • SET_DIAGNOSTICS
    • Input: 1 to enable, 0 to disable.
    • Returns 1 if command accepted, 0 if command rejected.
    • When enabled, all xml communications will be dumped into the Zorro\Log folder for diagnostic purposes.

Known Issues

  1. On holidays, broker API might say that the market is open when it is closed. Broker has not solved this issue as of 2017-05.
  2. Server will sometimes return ask/bid quotes of 0.00 after hours / on weekends. In this case, the plugin might use the latest historical M1 data instead and treat it as a quote. However, it will declare a spread of zero.

MIT License

This project is MIT-licensed. See the LICENSE.md file for more details.

Resources

You can’t perform that action at this time.