2025-OCT-23
Added new endpoint to preview unstake operations before execution. Prime Rest API:- Preview Unstake:
POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/unstake/preview- preview an unstaking request and see the estimated amount that would be unstaked
2025-OCT-23
Added Client Order ID (ClOrdID) idempotency across all prime trading surfaces (FIX, REST, & UI). Prime trading now enforces that ClOrdIDs are unique for 24hrs, for both open and closed orders. This change is scoped at the portfolio level. Consider the following scenario:- Client places a
NewOrderSingle (D)withClOrdID (11) = "test-clordID-1" - The order,
"test-clordID-1"fills - Client places another
NewOrderSingle (D)with the sameclordID (11) "test-clordID-1" - This second order is rejected with the error message:
"duplicate client order ID"
ClOrdID (11) idempotency continues to be enforced for open orders, scoped at the portfolio level. 2025-OCT-15
Added new security and permission features for API keys:- API Key Scopes – Set fine-grained permissions:
- Endpoint-specific access (e.g., allow Get Wallet Balance but not Get Portfolio Balances)
- Category-level READ/WRITE access (e.g., all READ order endpoints only)
- Broad ALL READ / ALL WRITE access across categories
2025-OCT-10
Added new Cross Margin Overview API to get detailed overview for the Cross Margin product. REST Path:GET /v1/entities/<prime_entity_id>/cross_margin
Example Response Structure:
2025-OCT-12
Added new GET endpoint to return candles of specified symbols. The request requires the following parameters: REST Path:GET /v1/portfolios/{portfolio_id}/candles
2025-JUL-02
Added new endpoint to get the margin call details for a given entity ID. This GET endpoint returns a list of margin calls for the specified entity. The request requires the following parameters:2025-JUN-26
Added new endpoint to get the risk limits for a given portfolio ID. This GET endpoint returns the risk limits for the specified portfolio. The request requires the following parameters:2025-Q3
Added following fields to Prime Rest API:-
Get Order By Order ID and List Portfolio Orders now supports:
raise_exactwhich returns a boolean indicating if an order is a raise exact orderdisplay_base_sizeanddisplay_quote_sizewhich returns the display size in the order currency. If the order does not have a display size, the response is empty.
-
Get Order Preview now supports:
raise_exactwhich returns a boolean indicating if an order is a raise exact orderdisplay_base_sizeanddisplay_quote_sizewhich returns the display size in the order currency. If the order does not have a display size, the response is empty.stop_pricefor a Stop Limit order displayed in quote currency
-
List Order Fills and List Portfolio Fills now supports:
- Add
venue_feewhich returns the venue fee in quote currency if the entity is enabled for cost-plus pricing. - Add
CES_commissionwhich returns the Client Execution Services commission of the trade.
- Add
- If user enters both
base_quantityandquote_value, an error is thrown - If user enters
base_quantityanddisplay_quote_size, an error is thrown - If user enters
quote_valueanddisplay_base_size, an error is thrown - If user enters both
display_quote_sizeanddisplay_base_size, an error is thrown
- Orders Channel now supports:
user_idwhich returns the unique user_id in each responsevenue_feewhich returns the venue fee in quote currency if entity is enabled for cost-plus pricing.commissionwhich returns the trading fee of the order.CES_commissionwhich returns the Client Execution Services commission of the trade.
- Products Channel now supports:
price_incrementpermissionswhich always returns PRODUCT_PERMISSION_READ and if the client can trade the product pair also returns PRODUCT_PERMISSION_TRADE
- Execution Report (8)
TimeInForcewhich returns the Time in force for the orderStopPricefor a Stop Limit order displayed in quote currencyMaxShowdisplays Maximum quantity within an order to be shown to other customers (Display Size). Only present on LIMIT orders.FilledValuepresents the sum of fills (inclusive of fees) in quote units of an order
2025-OCT-09
Added support for the Ethereum Pectra upgrade with significant enhancements to ETH staking functionality. Flexible Staking Amounts:- Stake any amount between 32 ETH and 180,000 ETH (not restricted to multiples of 32 ETH)
- Minimum stake amount remains 32 ETH
- Maximum stake amount per wallet: 180,000 ETH (100 validators × 1,800 ETH target size)
- Minimum unstake amount reduced from 32 ETH to 1 ETH
- Partial unstaking now supports flexible amounts (not restricted to multiples of 32 ETH)
- Validators with a balance less than 32 ETH will be automatically fully unstaked
- Claim Rewards:
POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/staking/claim_rewards- claim staking rewards
2025-OCT-2
Added support for editing open LIMIT, ST0P-LIMIT, TWAP, or VWAP orders via REST and FIX- Prime REST API: Edit Order
- Prime FIX API: Order Cancel/Replace Request <G>
2025-SEP-16
RFQ now supports size in the base or quote asset. To support this offering we’ve be deprecated therfq_product_detail fields: min_notional_size and max_notional_size and introduce the new fields:
min_base_sizemax_base_sizemin_quote_sizemax_quote_size
2025-AUG-01
Added support for counterparty transfers via the Coinbase Transfer Network, enabling instant and fee-less transfers between Coinbase customers. Prime Rest API:- Get Portfolio Counterparty ID:
GET /v1/portfolios/{portfolio_id}/counterparty- retrieve your portfolio’s unique counterparty ID for receiving transfers - Create Withdrawal now supports
DESTINATION_COUNTERPARTYdestination type for sending transfers to other Coinbase customers
- Get your portfolio’s counterparty ID:
- Send transfer to another portfolio:
2025-JUL-29
Staking Solana (SOL) now enabled with validator address support. Prime Rest API:- Initiate Staking now supports optional
validator_addressparameter- For SOL staking only, optional
validator_addressmust be the vote account address. Defaults to Coinbase validator when not specified.
- For SOL staking only, optional
- Unstake input schema updated to exclude
validator_addressparameter (staking-only) - Updated
amountparameter descriptions to specify “(ETH only)” behavior for both staking and unstaking
2025-JUL-22
Added support for Post-Only instructions on limit orders Prime Rest API:- Create Order now supports POST_ONLY on type: LIMIT
- Additional value for NewOrder (D): Support for Post-Only Orders
- Tag 18 (ExecInst): A (Post-Only)
- Supported TimeInForce values:
- 6 = GTD (Good Till Date)
- 1 = GTC (Good Till Cancel)
- Notes
- Post-Only orders (18=A) are now supported with TImeInForce values of GTD and GTC
2025-JUL-14
- Added the following fields to Products and Products Channel for Websocket feed inside
rfq_product_detail:min_base_sizeThe minimum the size can be when submitted in the base assetmax_base_sizeThe maximum the size can be when submitted in the base assetmin_quote_sizeThe minimum the size can be when submitted in the quote assetmax_quote_sizeThe maximum the size can be when submitted in the quote asset
2025-JUN-18
- Added support for Prime Limit Fill or Kill (
FOK) order with size in quote order instructions.- FIX
CashOrderQty(152)withTimeInForce(59)FILL_OR_KILL - REST create order
quote_valuewithtime_in_forceFILL_OR_KILL
- FIX
2025-APR-28
Added new POST endpoints to create staking/unstaking transactions. These endpoints initially support ETH only. Staking is a request to stake or delegate funds to a validator, and unstaking is a request to unstake delegated or staked funds in a wallet. The request requires the following parameters:2025-APR-15
Added optional query parameter to the REST API Get Portfolio Commission endpoint. This parameter allows you to request commission rates for a specific product ID. The request looks like the following: Path Parameters2025-JAN-18
Added new endpoint to update a Prime Onchain Wallet address group. This PUT endpoint replaces the existing address group with the new address group. The request requires portfolio ID and address group as shown below:2024-DEC-17
Added new endpoint to list your onchain address groups. This GET endpoint lists all address groups for a given portfolio ID. The response consists of the following:2025-APR-7
- Added the following field to Products and Products Channel for Websocket feed:
rfq_product_detailcontains product details for placing RFQ orders, which includes the following sub-fields:tradabledetermines if the product is tradable for RFQmin_notional_sizeis the minimum notional size for RFQ ordersmax_notional_sizeis the maximum notional size for RFQ orders
2025-MAR-27
Created API references for the following Prime endpoints- List Interest Accruals
- Get Entity Locate Availabilities
- Get Margin Information
- List Margin Call Summaries
- Get Trade Finance Tiered Pricing Fees
- List Portfolio Interest Accruals
- Get Portfolio Buying Power
- Get Portfolio Credit Information
- List Existing Locates
- Create New Locates
- List Margin Conversions
- Get Portfolio Withdrawal Power
- List Aggregate Entity Positions
- List Entity Positions
- List Entity Balances
2025-MAR-24
- Added the following field to List Portfolio Balances, Get Wallet Balance:
unbondable_amountis the amount available for unbonding/unstaking, in whole units
2025-FEB-26
Added support for Request For Quote Prime Rest API:- Create Quote: Request: Creates a RFQ
- Accept Quote: Accepts a RFQ
- Server now supports a new message type sent by the client: Quote Request <R>
- Server now sends a new message type: Quote <S>
- Server now sends a new message type: Quote Acknowledgment <b>
- Server now supports new values on New Order Single <D>
2025-FEB-12
- Updated the following endpoints to support the new
networkfield for Prime Multinetwork Support:- List Assets, will return
network_detailsfor each asset supported by the entity - List Portfolio Transactions, will return the
networkfield in the response if the transaction is onchain - List Wallet Transactions, will return the
networkfield in the response if the transaction is onchain - Get Transaction by Transaction ID, will return the
networkfield in the response if the transaction is onchain - Create Withdrawal, will take in optional
networkfield as a request parameter and return thenetworkfield in the response if the withdrawal is onchain - List Portfolio Wallets, will return the
networkfield in the response if the wallet is a vault wallet - Get Wallet by Wallet ID, will return the
networkfield in the response if the wallet is a vault wallet - Create Wallet, will take in optional
networkfield as a request parameter and return thenetworkfield in the response if the wallet is a vault wallet - Get Wallet Deposit Instructions, will take in the optional
networkfield as a request parameter and return thenetworkfield in the response if the deposit instruction is onchain
- List Assets, will return
2025-JAN-31
- Added Create Onchain Transaction, which allows you to create on-chain transactions for a given portfolio wallet.
2024-JAN-17
- Added FCM futures API series including
- Get Entity Positions, retrieving given entity’s active positions with optional input
product_id - Get Entity FCM Balance, retrieving given entity’s current FCM balance
- List Entity Futures Sweeps, retrieving given entity’s sweep requests up to 1000
- Schedule Entity Futures Sweep, scheduling a sweep for given entity. Only one pending sweep is allowed at a time.
currencyis required to be provided. - Cancel Entity Futures Sweep, canceling the pending sweep request for a given entity. If there is no pending available, a 404 will be returned.
- Set Auto Sweep, setting the
auto_sweepstatus of a given entity. Auto sweep will automatically sweep all available balance by each settlement.
- Get Entity Positions, retrieving given entity’s active positions with optional input
2024-DEC-17
- Added
user_contextto List Open Orders, List Portfolio Orders, Get Order By ID. - Added
Text(58),OrdType(40),Price(44) to Execution Report (8). - Added
user_context,limit_px,side,order_typeto the Orders Channel.
2024-DEC-12
- Updated
WEB3wallet type toONCHAINontypefield in request and response for Create Wallet, List Wallets, and Get Wallet by Wallet ID - Added support for creating
ONCHAINwallets to Create Wallet - Added
VISIBILITYfield to List Wallets and Get Wallet by Wallet ID - Updated
WEB3_TRANSACTIONtransaction type toONCHAIN_TRANSACTIONin request parameters and responses for List Portfolio Transactions, List Wallet Transactions, and Get Transaction by Transaction ID. All transactions previously marked asWEB3_TRANSACTIONwill now be returned asONCHAIN_TRANSACTION.
2024-DEC-05
Addedproduct_id field to Orders Channel’s messages.
2024-OCT-18
Added support for filtered Level2 Data Channel by venue configuration for Websocket feed:- Updated L2_data channel request to include
venue_filteringboolean. - Updated L2_data channel response to include
venue_configurationfor each product.
2024-OCT-15
- List Portfolio Fills: Added new endpoint to retrieve fills across orders on a given portfolio.
2024-OCT-2
- Added FIX tag DropCopyFlag (9406) to Logon (A).
2023-NOV-20
Added support for Stop Limit orders:- Updated Create Order and Get Order Preview with order type
STOP_LIMIT, a conditional order combined of stop order and limit order. Thestop_pricefield is required for this new order type. - Added FIX Target Strategy Type
SLfor the new Stop Limit order andStopPx(99) to NewOrderSingle.
2023-OCT-31
- Added FIX tag ParticipationRate (849) to NewOrderSingle.
2023-OCT-26
- Updated Create Order and Get Order Preview with new parameter called
historical_povthat estimates participation rate for a TWAP/VWAP order. Can be specified instead of expiry time.
2023-SEP-11
- Updated FIX tag TargetStrategy (847) by adding Immediate or Cancel (
IOC) support to NewOrderSingleLIMITorders.
2023-SEP-08
Added endpoints to support Net Allocations:- Create Net Allocation: Added new endpoint to create a net allocation from a given portfolio.
- Get Allocations By Netting ID: Added new endpoint to retrieve allocations by netting ID.
2023-AUG-28
- Added
net_average_filled_priceto List Open Orders, List Portfolio Orders, Get Order By ID. - Added
NetAvgPrice(8006),EffectiveTime(168),NoMiscFees(136),MiscFeeAmt(137),MiscFeeCurr(138),MiscFeeType(139) to Execution Report (8). - Added
net_avg_pxto the Orders Channel.
2023-AUG-10
Updated List Open Orders:- Fixed query parameters
order_type,order_side,sort_direction,start_date, andend_datewhich can again be used to filter orders. - Deprecated query parameters
limit, andcursor. - Deprecated field
paginationfrom response payload.
2023-AUG-08
- Updated the WebSocket feed rate limiting specs with the latest service configuration.
2023-JUL-25
- Updated FIX TimeInForce (59) with support for Fill or Kill (
FOK).
2023-JUN-29
Added volume-weighted average price trading (VWAP):
- Create Order, Get Order Preview: Added a new
typevalue calledVWAP - List Open Orders, List Portfolio Orders: Users can filter by new
order_typecalledVWAP
2023-MAR-17
Added 2 new response properties to Get Portfolio credit Information:adjusted_credit_utilizedadjusted_portfolio_equity
2023-MAR-09
- Enabled Replay for all FIX clients.
2023-FEB-10
- Added FIX tag
IsRaiseExact(8999) to NewOrderSingle messages for all order types (LIMIT, MARKET, TWAP).
2023-JAN-24
- Added FIX tag
SenderSubID(50) to ExecReports.
2022-NOV-09
- Fixed WebSocket bug whereby clients subscribed to Orders Channels could receive updates from product IDs different from the ones provided in subscription message.
2022-OCT-19
Updated WebSocket:- Improved performance of server’s resource usage.
- Added new time formatting definition fields,
timestampandevent_time.
2022-SEP-02
Added 3 new response properties to Get Portfolio Allocations:allocation_completed_atorder_idsfees_allocated_legof destination level
2022-AUG-12
Added new endpoint List Portfolio Allocations returns a list of allocations.2022-AUG-10
-
Updated List Open Orders, List Portfolio Orders:
- Users can now filter by a new
order_typecalled:BLOCK - Added a new possible value
BLOCKto the fieldtype, which refers to a block trade
- Users can now filter by a new
-
Updated Get Order by Order ID:
- Added a new possible value
BLOCKto the fieldtype, which refers to a block trade
- Added a new possible value
2022-JUL-27
-
Updated List Open Orders, Get Order by Order ID, and List Portfolio Orders:
- Users can now see a field
exchange_fee, populated when the order was placed with aCOST_PLUScommission configuration.
- Users can now see a field
-
Added the following fields to List Portfolio Balances, Get Wallet Balance:
bonded_amountis the amount currently locked due to bonding/staking, potentially subject to an unbonding period, in whole unitsreserved_amountis the amount that must remain in the wallet due to the protocol, in whole unitsunbonding_amountis the amount that is in the process of unbonding, in whole unitsunvested_amountis the unrealized amount subject to a vesting schedule, in whole unitspending_rewards_amountis the pending bonding/staking rewards that have not yet been realized, in whole unitspast_rewards_amountis the previously realized bonding/staking rewards, in whole unitsbondable_amountis the amount available for bonding/staking, in whole units
2022-JUL-01
Added support for conversions:- Create Conversion is now available to perform conversions between USD and USDC.
- List Activities can now be filtered by a new type of activity called:
ACTIVITY_TYPE_CONVERSION. - Added the conversion
destination_symbolfield to List Wallet Transactions, List Portfolio Transactions, and Get Transaction by Transaction ID - Added
CONVERSIONfilter to List Wallet Transactions and List Portfolio Transactions,
2022-JUN-08
-
Added the following endpoints
- Get Address Book:
GET /v1/portfolios/{portfolio_id}/address_book - Create Address Book Entry:
POST /v1/portfolios/{portfolio_id}/address_book
- Get Address Book:
-
Updated List Activities with new type of activity,
ACTIVITY_CATEGORY_ALLOCATION
2022-MAY-19
- Added FIX tag
MaxShow(201) to NewOrderSingle for LIMIT orders.
2022-APR-22
-
Updated List Portfolio Orders:
- The
product_idsparameter is no longer required. If not specified you get all products. - The 31 day limit has been removed so you can now request orders for any time period using
start_dateandend_date. Theend_dateparameter is still optional, but if not specified you get orders fromstart_dateto the end of time. Previously, it returnedstart_datetostart_date+ 31 days.
- The
-
Updated List Open Orders:
- The
product_idsparameter is no longer required. If not specified you get all products. - All other query params are currently non-functional and result in an error if used. This includes:
order_type,cursor,limit,sort_direction,start_date,order_side, andend_date. - The maximum number of orders returned is 1000. If a client has more than 1000 open orders, an error is returned prompting the user to use WebSocket API, or FIX API to stream open orders.
- The
2022-APR-07
-
Added the
has_nextboolean field to thepaginationfield in the response body. Thehas_nextfield indicates if there is more data available to paginate through. -
Removed the
total_result_countfield has been removed from thepaginationfield in the response body.
2022-MAR-24
Added:- Create Withdrawal is now available to request new withdrawal transactions from a portfolio wallet.
- Create Transfer is now available to request new transfers between portfolio wallets.
2022-MAR-19
Added:- Get Entity Payment Method is now available to retrieve payment method information related to investment vehicles.
- Create Wallet is now available to request new wallets for a portfolio.
2022-MAR-07
Added:- List Activities is now available to retrieve a list of activities related to a given portfolio.
- Get Activity by Activity ID is now available to retrieve a specific activity.
2022-FEB-15
Fixed:- Blockchain Network Ids (
blockchain_ids) now appear in the Transaction response. - Pagination was fixed for List Open Orders and List Order Fills
2022-JAN-31
Added:- Get Portfolio Credit Information returns 200 response if post trade credit is not enabled.
- List Portfolio Balances has a new
typefilter. - Get Portfolio Commission is now available to retrieve commissions for your portfolio.
2022-JAN-19
Fixed:- The
account_identifierfield now appears within Get Wallet Deposit Instructions. - Missing Transaction resources now appear in List Portfolio Transactions.
- The fields
transfer_fromandtransfer_tonow appear in the Transaction resource for withdrawals and deposits. - External address deposit information is now included in the Transaction resource response.
2022-JAN-15
Additions:- For deposits and withdrawals to bank accounts, the payment method associated with that bank account now appears in the Transaction response as the
transfer_fromandtransfer_totype. - Added non-balance impacting transaction types to List Portfolio Transactions.
2021-DEC-15
- Welcome to the Coinbase Prime REST API.