Advanced Trade API Changelog
These release notes list changes to the Coinbase Advanced Trading API.
2024-MAY-03
- Added
retail_portfolio_id
to the Get Accounts endpoint to filter accounts by portfolio. Also addedretail_portfolio_id
to the Get Account and Get Accounts response bodies. - Updated the description of the
view_only
response field in the Get Product and Get Products endpoints to clarify that field is only set to true for expired FCM products.
2024-APR-22
Released breaking changes to our Perpetual Futures endpoints:
- Get Perpetuals Portfolio Summary:
GET /intx/portfolio
- List Perpetuals Positions:
GET /intx/positions
- Get Perpetuals Position:
GET /intx/positions
2024-APR-18
-
Updated Postman Collections & Environments and added additional setup details
-
Updated the docs to reflect API Key changes:
-
Coinbase Cloud is now Coinbase Development Platform (CDP)
-
Both Advanced Trade and Sign in with Coinbase support API keys created on CDP
-
Legacy keys are now optional for both Advanced Trade and Sign in with Coinbase
- Added dedicated pages on REST Legacy Keys and WebSocket Legacy Keys
- Simplified top-level Authentation page to only Creating API Keys
-
-
Renamed SDK client tutorials:
- Renamed the SDK REST client page to Make Your First Trade
- Renamed the SDK WebSocket client page to Listen for Order Updates
2024-APR-16
Added support for FOK orders in Beta:
-
Released a fill or kill (FOK) order type. This feature is currently in open Beta and may be taken down to resolve issues during testing. FOK orders are either fully filled immediately or killed and cannot be
postOnly
. FOK orders are validated at most 20% away from mid market in either direction. -
FOK orders can be simulated via the Preview Order endpoint. This is available to all users and is not under experiment.
2024-APR-10
Removed the authentication requirement from all WebSocket channels except the User Channel. This feature is in Beta and the best way to subscribe to the WebSocket is still with a Cloud API key.
2024-APR-09
Released the following public market data endpoints, which no longer require authentication to access:
- List Public Products: Returns a list of the available currency pairs for trading.
- Get Public Product: Returns information on a single product by product ID.
- Get Public Product Book: Returns a list of bids/asks for a single product.
- Get Public Market Trades: Returns a snapshot information by product ID about the last trades (ticks) and best bid/ask.
- Get Public Product Candles: Returns rates for a single product by product ID, grouped in buckets.
2024-APR-08
-
Added the following new properties to the WebSocket Ticker channel:
"best_bid": "21931.98",
"best_bid_quantity": "8000.21",
"best_ask": "21933.98",
"best_ask_quantity": "8038.07770938"
2024-APR-04
- Added REST endpoint Close Position, to close open positions for a specified
product_id
.
2024-APR-02
- Added
entry-vwap
field for Get Perpetuals Position and List Perpetuals Positions to reflect the Average Entry Price of the position.
2024-MAR-29
- Removed need for
audience
field on JWTs (using Cloud API Keys). Updated the Authentication Overview and WebSocket Authentication pages accordingly.
2024-MAR-28
- Rolling out a new order type called Bracket. This feature is currently in closed beta and may be taken down to resolve issues during testing. Bracket is an order type available on Coinbase Advanced that allows users to buy/sell with a limit price while mitigating potential losses in volatile markets. A single SELL order can specify the limit price for momentum trading strategies, and a trigger price used to automatically trigger a sale to reduce risk exposure in case the market moves against you. More information on bracket orders can be found here: https://help.coinbase.com/en/coinbase/trading-and-funding/advanced-trade/order-types
- Added Bracket orders to preview endpoint. This will be available to all users, and is not under experiment.
2024-MAR-27
- Removed need for
timestamp
in Websocket messages signed with JWT (using Cloud API Keys).
2024-MAR-20
- Added support for Multiple Portfolios in Preview Order by adding
retail_portfolio_id
to the request.
2024-MAR-12
- Added Limit Price and Stop Limit Price to messages for the Websocket User Channel
2024-MAR-11
-
Added support for Limit IOC orders with the Create Order API:
-
New object parameter
sor_limit_ioc
(Smart Order Routing) Limit IOC (Immediate Or Cancel):"sor_limit_ioc": {
"quote_size": "10.00",
"limit_price": "10000.00"
}
-
-
The WebSocket Status Channel was updated so that when clients subscribe, they are automatically subscribed to all products if
product_ids
is not provided (as opposed to no products).
2024-MAR-06
- Added List Payment Methods which allows users to get a list of payment methods.
- Added Get Payment Method which allows users to get a payment method by ID.
2024-MAR-04
Released the following Postman Collections & Environments for download:
2024-FEB-22
- Renamed Get Unix Time to Get Server Time. Converted it to a public endpoint which means it no longer requires authentication to access.
2024-FEB-05
- Added Preview Order which allows users to preview the results of an order request.
2024-JAN-31
- Released the Advanced API Python WebSocket SDK.
- Added support for Perpetual Futures trading.
/orders
endpoints can now be used for perpetual futures trading and order management.- Added the following new
/intx
Perpetual Futures endpoints:- Get Perpetuals Portfolio Summary
GET /intx/portfolio
- List Perpetuals Positions
GET /intx/positions
- Get Perpetuals Position
GET /intx/positions
- Allocate Portfolio
POST /intx/allocate
- Get Perpetuals Portfolio Summary
2024-JAN-30
Support for Multiple Portfolios is live in production. You can filter by retail_portfolio_id
in List Orders and Create order.
2024-JAN-19
- Added "Getting Started" section to the Advanced API Python SDK Overview.
- Added JWT generation examples using the SDK to the Authentication Overview and WebSocket Authentication pages.
2024-JAN-16
Cancel orders now have a maximum of 100 order_ids
that can be cancelled per request. This number may be subject to change in emergency, but if a request exceeds the max, then an InvalidArgument
error code will be returned with an error message denoting the limit Too many orderIDs entered, limit is _
.
2024-JAN-04
Released the Advanced API Python SDK.
2024-JAN-02
Added support for Coinbase Financial Markets (CFM) futures trading.
/orders
endpoints can now be used for CFM futures trading and order management.- Added the following new
/cfm
Futures endpoints:- Get Futures Balance Summary
GET /cfm/balance_summary
- List Futures Positions
GET /cfm/positions
- Get Futures Position
GET /cfm/positions/{product_id}
- Schedule Futures Sweep
POST /cfm/sweeps/schedule
- List Futures Sweeps
GET /cfm/sweeps
- Cancel Pending Futures Sweep
DELETE /cfm/sweeps
- Get Futures Balance Summary
2023-DEC-11
Added support for Multiple Portfolios:
Filtering by Retail Portfolio ID
- Added new filtering parameter
retail_portfolio_id
to List Orders and Create order.
Endpoints
-
Added the following new
/portfolios
endpoints:- List Portfolios
GET /portfolios
- Create Portfolio
POST /portfolios
- Move Portfolio Funds
POST /portfolios/move_funds
- Get Portfolio Breakdown
GET /portfolios/{portfolio_uuid}
- Delete Portfolio
DELETE /portfolios/{portfolio_uuid}
- Edit Portfolio
PUT /portfolios/{portfolio_uuid}
- List Portfolios
2023-DEC-06
Added Get UNIX Time which allows users to get the current time from the Coinbase Advanced API.
2023-NOV-27
Added conversion endpoints that support USD and USDC:
- Create Convert Quote creates quotes for converting currencies.
- Commit Convert Trade commits a trade for converting currencies.
- Get Convert Trade returns a trade for converting currencies.
2023-NOV-13
- Added Edit Order which allows users to edit orders. Only limit order types, with time in force type of good-till-cancelled can be edited.
- Added Edit Order Preview which allows users to preview an edit request's results. Only limit order types, with time in force type of good-till-cancelled can be previewed for an edit.
- Added
edit_history
to response from Get Order, List Orders
2023-JUL-26
Added product_id
to candles channel to provide product-level granularity on candle subscriptions
2023-JUL-25
Increased the REST API rate limit to 30 requests per second per IP.
2023-JUL-10
Added candles channel to provide real-time product candles with per second updates.
2023-JUN-23
Added heartbeats channel to provide keepalive mechanism for client websocket connections.
2023-JUN-20
Added Get Best Bid/Ask which returns the best bid/ask for all products.
2023-JUN-15
Added Get Product Book which returns a list of bids and asks.
2023-JUN-01
Added the ability to trade with 230+ USDC pairs with Advanced Trade REST API. Explore with List Products.
2023-MAY-25
Increased the REST API rate limit from 10 to 20 requests per second.
2023-FEB-09
Fix:
- List Accounts pagination was not working for some requests.
- Get Market Trades
best_ask
andbest_bid
are now populated in the response. - All channels bug where unsubscribing from one product sometimes unsubscribes for all.
2023-JAN-06
Feature:
- Market trades channel was added to send real-time updates of trades in specified markets.
- OAauth2 is now officially supported as an authentication option.
Fix:
-
Create Order was cancelling post-only orders placed with an invalid limit price immediately after placement.
- Post only orders on BUY side are required to have a limit price lower than best ask, and
- Post only orders on SELL side are required to have a limit price higher than best bid.
If these conditions are not met on an endpoint call, the order will now be rejected with a corresponding error.
2022-DEC-21
Feature:
- WebSocket API rate limits increased to 750 requests per second.
- User channel supports new fields:
product_id
,creation_time
,order_side
,order_type
.
Fix:
- List Products offset was not always being honoured in the request.
- List Fills scope changed to wallet:transactions:read.
- Get Account was sometimes returning 0 incorrectly as the account's balance.
- Get Order was incorrectly returning postOnly as false.
2022-DEC-09
Fix:
- Get Transaction Summary no longer requires a
user_native_currency
(the field has been deprecated).
2022-DEC-07
- GA release of the Advanced Trade REST API and WebSocket protocols.
2022-NOV-15
- Public BETA release of the Advanced Trade REST API and WebSocket protocols.