GdaxCli

A commandline client for cryptocurrency trading on GDAX (Global Digital Assets Exchange).

TODO: Add features and goals here.

Work in progress.

Installation

Requires python 2.7+.

pip install gdaxcli

To run:

python -m gdaxcli

or add an alias to shorten the command:

echo "alias gdaxcli='python -m gdaxcli'" >> ~/.bashrc
source ~/.bashrc

so you can call:

gdaxcli <arguments>

Usage

Usage: gdaxcli <command> [arguments]
    products                      Lists products available for trading.
    ticker [product1 product2..]  Get current market ticker.

    balance                       Get account balance.
    history [account1 account2..] Get account history (transfer, match, fee, rebate).
                                      Default USD.

    fills [product]               Get recent fills.

    order list                    List open orders
    orders

    orders cancel <product>       Cancel all orders.
    order cancel all <product>

    order cancel <id>             Cancel order. Id can be a short prefix.

    order <limit/market/stop> <buy/sell> <product> <size> [price]
                                  Place an order. Limit price can be absolute or
                                      relative such as 180, 180.23, -1, +.5
                                      Product can be uppercased or lowercased.
                                      For example: eth-usd, BTC-GBP, ..

Example usage screencast (v0.1.1):

Configuring

To obtain an API key for your account to be used with this tool:

Login to your GDAX account
Go to Settings > API or https://www.gdax.com/settings/api
Select the Trade permission and generate an API key. This allows the software to only put in trade orders and not transfer, deposit or withdraw.
Run bash make.sh configure and copy paste the passphrase, key and secret accordingly. Data is saved to ~/.gdaxcli_config with chmod 600.

See gdax docs for more information on the API key and permissions.

TODO: mention the sandbox

Changes

See CHANGES

Contributing

See CONTRIBUTING.

License

DISCLAIMER: No warranty is provided for this software. Use it at your own risk.

Code is released under the MIT License.

Remember:

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sonph / gdaxcli

readme