https://github.com/j-w-yun/gdax-api-python

Impeccably documented, lightweight, authenticated client for GDAX API in Python.
https://github.com/j-w-yun/gdax-api-python

cryptocurrency cryptocurrency-exchanges gdax gdax-api gdax-python python

Last synced: about 7 hours ago
JSON representation

Impeccably documented, lightweight, authenticated client for GDAX API in Python.

• Host: GitHub
• URL: https://github.com/j-w-yun/gdax-api-python
• Owner: j-w-yun
• License: mit
• Created: 2018-01-24T01:00:25.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-28T06:51:23.000Z (almost 6 years ago)
• Last Synced: 2024-10-08T16:55:47.435Z (about 1 month ago)
• Topics: cryptocurrency, cryptocurrency-exchanges, gdax, gdax-api, gdax-python, python
• Language: Python
• Homepage:
• Size: 20.5 KB
• Stars: 6
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# IMPORTANT

As of December 31, 2018, GDAX API is no longer supported by Coinbase. Instead, please refer to https://docs.pro.coinbase.com/

As of yet, gdax-api does not support the new Coinbase API. Please refrain from using any code in this repository to transact on Coinbase until further notice.

# gdax-api-python

More information can be found at:

    https://docs.gdax.com/

## Dependencies

If you are installing gdax-api with native pip, skip this step.

    $ pip install requests

## Install

#### Installing with native pip

    $ pip install gdax-api

#### Validate your installation

Start a terminal.

Invoke python from your shell as follows:

    $ python

Enter the following short program inside the python interactive shell:

    >>> import gdax

    >>> client = gdax.PublicClient()

    >>> print(client.get_currencies())

If the system outputs a JSON response from GDAX, then you are ready to begin using gdax-api in your programs.

## Usage

#### Public Client

To access the public client, create a PublicClient

    client = gdax.PublicClient()

Get product order book

    client.get_product_order_book(client.ETH_USD, 1)

Get product ticker

    client.get_product_ticker(client.ETH_USD)

Get trades

    client.get_trades(client.ETH_USD)

Get historic rates

    client.get_historic_rates(client.ETH_USD, "2018-01-01", "2018-01-02", granularity=300)

Get currencies

    client.get_currencies()

Get API time

    client.time()

#### Authenticated Client

To access your authenticated client, create a PrivateClient

    client = gdax.PrivateClient(KEY, B64SECRET, PASSPHRASE)

List accounts

    client.list_accounts()

Get account

    client.get_account(account_id)

Get account history

    client.get_account_history(account_id)

Get holds

    client.get_holds(account_id)

Limit buy

    client.limit_buy(client.ETH_USD, price=1050, size=1)

Limit sell

    client.limit_sell(client.ETH_USD, price=3000, size=1)

Market buy

    client.market_buy(client.ETH_USD, size=1)

Market sell

    client.market_sell(client.ETH_USD, size=1)

Stop buy

    client.stop_buy(client.ETH_USD, price=1000)

Stop sell

    client.stop_sell(client.ETH_USD, price=1000)

Cancel order

    client.cancel_order(order_id)

Cancel all orders

    client.cancel_all()

List orders

    client.list_orders()

Get an order

    client.get_order(order_id)

## License

MIT. See LICENSE for details.