Skip to main content

The unofficial Python client for the Coinbase Advanced Trade API

Project description

Coinbase Advanced Trade API Python Client

This is the unofficial Python client for the Coinbase Advanced Trade API. It allows users to interact with the API to manage their cryptocurrency trading activities on the Coinbase platform.

Features

  • Easy-to-use Python wrapper for the Coinbase Advanced Trade API
  • Supports all endpoints and methods provided by the official API
  • Lightweight and efficient wrapper
  • Added support for trading strategies covered on the YouTube channel

Setup

  1. Clone this repository or download the source files by running
       pip install coinbase-advancedtrade-python
    
  2. Set your API key and secret in config.py. To obtain your API key and secret, follow the steps below:
    • Log in to your Coinbase account.
    • Navigate to API settings.
    • Create a new API key with the appropriate permissions.
    • Copy the API key and secret to config.py.

Authentication

Here's an example of how to authenticate:

from coinbase_advanced_trader.config import set_api_credentials

# Set your API key and secret
API_KEY = "ABCD1234"
API_SECRET = "XYZ9876"

# Set the API credentials once, and it updates the CBAuth singleton instance
set_api_credentials(API_KEY, API_SECRET)

Usage of Strategies

Here's an example of how to use the strategies package to buy $20 worth of Bitcoin:

from coinbase_advanced_trader.strategies.limit_order_strategies import fiat_limit_buy

# Define the trading parameters
product_id = "BTC-USD"  # Replace with your desired trading pair
usd_size = 20  # Replace with your desired USD amount to spend``

# Perform a limit buy
limit_buy_order = fiat_limit_buy(product_id, usd_size)

Usage of Fear and Greed Index

from coinbase_advanced_trader.strategies.fear_and_greed_strategies import trade_based_on_fgi_simple

# Define the product id
product_id = "BTC-USD"

# Implement the strategy
trade_based_on_fgi_simple(product_id, 10)

Usage of Fear and Greed Index (Pro)

from coinbase_advanced_trader.strategies.fear_and_greed_strategies import trade_based_on_fgi_pro

# Define the product id
product_id = "BTC-USD"

# Define the custom schedule
custom_schedule = [
    {"threshold": 20, "factor": 1, "action": "buy"},
    {"threshold": 80, "factor": 0.5, "action": "buy"},
    {"threshold": 100, "factor": 1, "action": "sell"},
]

# Implement the strategy
response = trade_based_on_fgi_pro(product_id, 10, custom_schedule)

Documentation

For more information about the Coinbase Advanced Trader API, consult the official API documentation.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Author

Rhett Reisman

Email: rhett@rhett.blog

GitHub: https://github.com/rhettre/coinbase-advancedtrade-python

Disclaimer

This project is not affiliated with, maintained, or endorsed by Coinbase. Use this software at your own risk. Trading cryptocurrencies carries a risk of financial loss. The developers of this software are not responsible for any financial losses or damages incurred while using this software. Nothing in this software should be seen as an inducement to trade with a particular strategy or as financial advice.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coinbase-advancedtrade-python-0.1.6.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file coinbase-advancedtrade-python-0.1.6.tar.gz.

File metadata

File hashes

Hashes for coinbase-advancedtrade-python-0.1.6.tar.gz
Algorithm Hash digest
SHA256 009c8486576015d73e737475dadd8fa53734038bc2ccc315bdf5a05d4e377c0a
MD5 38551d5d3dce8a0e37344668a3f863bd
BLAKE2b-256 29c8ed5615fa4f21710b0d55e12878b49cb7f90119e492d05c953af8e4db89c2

See more details on using hashes here.

Provenance

File details

Details for the file coinbase_advancedtrade_python-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for coinbase_advancedtrade_python-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5388cee9320cab75c6b2af89971e74651f63d9db197de15840544f6108010d75
MD5 79045b57c905a77ff76e1a3c324be7ca
BLAKE2b-256 a5c4f19aaa89b7e8cc616333aef1c660c15bcdc68fd06118ecf3f6520788d86c

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page