Coinbase Advanced API Python SDK

---

Getting Started

Welcome to the official Coinbase Advanced API Python SDK. This python project was created to allow coders to easily plug into the Coinbase Advanced API

• Docs: https://docs.cdp.coinbase.com/advanced-trade/docs/welcome/

• Python SDK: https://github.com/coinbase/coinbase-advanced-py

For detailed exercises on how to get started using the SDK look at our SDK Overview: https://docs.cdp.coinbase.com/advanced-trade/docs/sdk-overview

---

Contents:

• REST API Client
  • RESTClient Constructor
    • RESTClient
  • REST Utils
    • get()
    • post()
    • put()
    • delete()
  • Accounts
    • get_accounts()
    • get_account()
  • Products
    • get_products()
    • get_product()
    • get_product_book()
    • get_best_bid_ask()
  • Market Data
    • get_candles()
    • get_market_trades()
  • Orders
    • create_order()
    • market_order()
    • market_order_buy()
    • market_order_sell()
    • limit_order_ioc()
    • limit_order_ioc_buy()
    • limit_order_ioc_sell()
    • limit_order_gtc()
    • limit_order_gtc_buy()
    • limit_order_gtc_sell()
    • limit_order_gtd()
    • limit_order_gtd_buy()
    • limit_order_gtd_sell()
    • limit_order_fok()
    • limit_order_fok_buy()
    • limit_order_fok_sell()
    • stop_limit_order_gtc()
    • stop_limit_order_gtc_buy()
    • stop_limit_order_gtc_sell()
    • stop_limit_order_gtd()
    • stop_limit_order_gtd_buy()
    • stop_limit_order_gtd_sell()
    • trigger_bracket_order_gtc()
    • trigger_bracket_order_gtc_buy()
    • trigger_bracket_order_gtc_sell()
    • trigger_bracket_order_gtd()
    • trigger_bracket_order_gtd_buy()
    • trigger_bracket_order_gtd_sell()
    • get_order()
    • list_orders()
    • get_fills()
    • edit_order()
    • preview_edit_order()
    • cancel_orders()
    • preview_order()
    • preview_market_order()
    • preview_market_order_buy()
    • preview_market_order_sell()
    • preview_limit_order_ioc()
    • preview_limit_order_ioc_buy()
    • preview_limit_order_ioc_sell()
    • preview_limit_order_gtc()
    • preview_limit_order_gtc_buy()
    • preview_limit_order_gtc_sell()
    • preview_limit_order_gtd()
    • preview_limit_order_gtd_buy()
    • preview_limit_order_gtd_sell()
    • preview_limit_order_fok()
    • preview_limit_order_fok_buy()
    • preview_limit_order_fok_sell()
    • preview_stop_limit_order_gtc()
    • preview_stop_limit_order_gtc_buy()
    • preview_stop_limit_order_gtc_sell()
    • preview_stop_limit_order_gtd()
    • preview_stop_limit_order_gtd_buy()
    • preview_stop_limit_order_gtd_sell()
    • preview_trigger_bracket_order_gtc()
    • preview_trigger_bracket_order_gtc_buy()
    • preview_trigger_bracket_order_gtc_sell()
    • preview_trigger_bracket_order_gtd()
    • preview_trigger_bracket_order_gtd_buy()
    • preview_trigger_bracket_order_gtd_sell()
    • close_position()
  • Portfolios
    • get_portfolios()
    • create_portfolio()
    • get_portfolio_breakdown()
    • move_portfolio_funds()
    • edit_portfolio()
    • delete_portfolio()
  • Futures
    • get_futures_balance_summary()
    • list_futures_positions()
    • get_futures_position()
    • schedule_futures_sweep()
    • list_futures_sweeps()
    • cancel_pending_futures_sweep()
    • get_intraday_margin_setting()
    • get_current_margin_window()
    • set_intraday_margin_setting()
  • Perpetuals
    • allocate_portfolio()
    • get_perps_portfolio_summary()
    • list_perps_positions()
    • get_perps_position()
    • get_perps_portfolio_balances()
    • opt_in_or_out_multi_asset_collateral()
  • Fees
    • get_transaction_summary()
  • Converts
    • create_convert_quote()
    • get_convert_trade()
    • commit_convert_trade()
  • Public
    • get_unix_time()
    • get_public_product_book()
    • get_public_products()
    • get_public_product()
    • get_public_candles()
    • get_public_market_trades()
  • Payments
    • list_payment_methods()
    • get_payment_method()
  • Data API
    • get_api_key_permissions()
• Websocket API Client
  • WSClient Constructor
    • WSClient
  • WebSocket Utils
    • open()
    • open_async()
    • close()
    • close_async()
    • subscribe()
    • subscribe_async()
    • unsubscribe()
    • unsubscribe_async()
    • unsubscribe_all()
    • unsubscribe_all_async()
    • sleep_with_exception_check()
    • sleep_with_exception_check_async()
    • run_forever_with_exception_check()
    • run_forever_with_exception_check_async()
    • raise_background_exception()
  • Channels
    • heartbeats()
    • heartbeats_async()
    • heartbeats_unsubscribe()
    • heartbeats_unsubscribe_async()
    • candles()
    • candles_async()
    • candles_unsubscribe()
    • candles_unsubscribe_async()
    • market_trades()
    • market_trades_async()
    • market_trades_unsubscribe()
    • market_trades_unsubscribe_async()
    • status()
    • status_async()
    • status_unsubscribe()
    • status_unsubscribe_async()
    • ticker()
    • ticker_async()
    • ticker_unsubscribe()
    • ticker_unsubscribe_async()
    • ticker_batch()
    • ticker_batch_async()
    • ticker_batch_unsubscribe()
    • ticker_batch_unsubscribe_async()
    • level2()
    • level2_async()
    • level2_unsubscribe()
    • level2_unsubscribe_async()
    • user()
    • user_async()
    • user_unsubscribe()
    • user_unsubscribe_async()
    • futures_balance_summary()
    • futures_balance_summary_async()
    • futures_balance_summary_unsubscribe()
    • futures_balance_summary_unsubscribe_async()
  • Exceptions
    • WSClientException()
    • WSClientConnectionClosedException()
• Websocket User API Client
  • WSUserClient Constructor
    • WSUserClient
  • WebSocket Utils
    • open()
    • open_async()
    • close()
    • close_async()
    • subscribe()
    • subscribe_async()
    • unsubscribe()
    • unsubscribe_async()
    • unsubscribe_all()
    • unsubscribe_all_async()
    • sleep_with_exception_check()
    • sleep_with_exception_check_async()
    • run_forever_with_exception_check()
    • run_forever_with_exception_check_async()
    • raise_background_exception()
  • Channels
    • heartbeats()
    • heartbeats_async()
    • heartbeats_unsubscribe()
    • heartbeats_unsubscribe_async()
    • user()
    • user_async()
    • user_unsubscribe()
    • user_unsubscribe_async()
    • futures_balance_summary()
    • futures_balance_summary_async()
    • futures_balance_summary_unsubscribe()
    • futures_balance_summary_unsubscribe_async()
  • Exceptions
• Authentication
  • build_rest_jwt()
  • build_ws_jwt()
  • format_jwt_uri()