Coinbase Advanced API Python SDK

Endpoints return custom class objects. You can access defined fields using dot-notation. For fields that are not explicitly defined in the SDK's custom classes, use standard bracket notation to access the underlying data.

Example: Dot-notation (Defined fields)

product = client.get_product("BTC-USD")
print(product.price)

Example: Bracket notation (Undefined/Nested fields)

accounts = client.get_accounts()
# Accessing a nested field not explicitly defined in the SDK class
print(accounts.accounts[0].available_balance['value'])

Install the SDK using pip3 to begin using the Coinbase Advanced API and WebSocket API in your Python projects.

pip3 install coinbase-advanced-py

The Coinbase Advanced API Python SDK allows developers to interact with the Coinbase Advanced API. You can find the package on PyPI.

For detailed exercises and an overview of how to use the SDK, refer to the official SDK Overview.

pip install coinbase-advanced-py

Both the RESTClient and WSClient allow access to public endpoints without providing API keys. To use them unauthenticated, initialize the clients without any arguments.

Important Considerations:

• Private Endpoints: Attempting to call private endpoints or channels while unauthenticated will result in an error.
• Rate Limits: Unauthenticated requests are subject to more aggressive rate limiting. It is recommended to authenticate your requests whenever possible.
• REST vs WebSocket Behavior: In the REST client, public endpoints are distinct from their authenticated counterparts (e.g., get_public_products() vs get_products()). In the WebSocket client, channels typically handle both authenticated and unauthenticated requests, and most channels are public.

The SDK requires CDP API keys. It supports both Ed25519 (recommended) and ECDSA key types. The SDK automatically detects the key type and selects the correct JWT signing algorithm (EdDSA or ES256).

Supported Formats

• Ed25519: PKCS8 PEM (-----BEGIN PRIVATE KEY-----) or raw base64 (32-byte seed or 64-byte seed||pubkey).
• ECDSA: SEC1 PEM (-----BEGIN EC PRIVATE KEY-----).

Environment Variables

You can set your credentials in your environment to avoid hardcoding them:

For Ed25519:

export COINBASE_API_KEY="organizations/{org_id}/apiKeys/{key_id}"
export COINBASE_API_SECRET="YOUR_BASE64_ENCODED_ED25519_PRIVATE_KEY"

For ECDSA:

export COINBASE_API_KEY="organizations/{org_id}/apiKeys/{key_id}"
export COINBASE_API_SECRET="-----BEGIN EC PRIVATE KEY-----\nYOUR PRIVATE KEY\n-----END EC PRIVATE KEY-----\n"

To see rate limit information in your API responses, initialize the RESTClient with rate_limit_headers=True. This will append the rate limit headers from the Coinbase API to the response body.

client = RESTClient(api_key=api_key, api_secret=api_secret, rate_limit_headers=True)

You can use the RESTClient to access public data without authentication. For example, get_public_products() returns the same data as the authenticated get_products() method but does not require API keys.

from coinbase.rest import RESTClient
import json

client = RESTClient()

public_products = client.get_public_products()
print(json.dumps(public_products.to_dict(), indent=2))

The WSClient can subscribe to public channels like ticker without authentication. You must provide an on_message callback function during initialization to handle incoming data.

import time
from coinbase.websocket import WSClient

def on_message(msg):
    print(msg)

client = WSClient(on_message=on_message)

client.open()
client.ticker(product_ids=["BTC-USD"])

time.sleep(10)

client.ticker_unsubscribe(product_ids=["BTC-USD"])
client.close()

The RESTClient provides high-level hooks for various Coinbase API endpoints. You can call methods like get_accounts() or market_order_buy() to execute trades and manage accounts.

Tip: When calling order methods, setting client_order_id to an empty string will auto-generate a unique ID, but this removes the safeguard against accidental duplicate orders.

from json import dumps
from coinbase.rest import RESTClient

client = RESTClient()

# Get all accounts
accounts = client.get_accounts()
print(dumps(accounts.to_dict(), indent=2))

# Place a market buy order
order = client.market_order_buy(client_order_id="clientOrderId", product_id="BTC-USD", quote_size="1")
print(dumps(order.to_dict(), indent=2))