Skip to main content
# GdaxCli

[![travis-build-badge][7]][8]

A commandline client for cryptocurrency trading on [GDAX][1] (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, ..
```

## Configuring

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

1. Login to your GDAX account
2. Go to **Settings** > **API** or [https://www.gdax.com/settings/api][4]
3. Select the **trade** permission and generate an API key
4. Run `bash make.sh configure` and copy paste the passphrase, key and secret accordingly

See [gdax docs][5] for more information on the API key.

**TODO**: mention the sandbox

## Changes

See [CHANGES][CHANGES.md]

## Contributing

See [CONTRIBUTING][CONTRIBUTING.md].

## License

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

Code is released under [the MIT License][2].

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.

[1]: https://www.gdax.com/
[2]: https://choosealicense.com/licenses/mit/
[4]: https://www.gdax.com/settings/api
[5]: https://docs.gdax.com/#generating-an-api-key
[6]: https://public.sandbox.gdax.com
[7]: https://travis-ci.org/sonph/gdaxcli.svg?branch=master
[8]: https://travis-ci.org/sonph/gdaxcli


Release files for gdaxcli 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for gdaxcli 0.1.1
File Interpreter ABI Platform
gdaxcli-0.1.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Release files / gdaxcli-0.1.1-py2.py3-none-any.whl

Download URL gdaxcli-0.1.1-py2.py3-none-any.whl
Size 5.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
93efc3418906e172e8f6af00e1d16844b916a0b6c7e82988d7c8618e58eb8515
BLAKE2b-256 checksum
How to use checksums
697052b3e0301152e8bd34aa952b8c6ce40479e1e78a90bb5a60ef5a07b16784
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.1 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page