Prime Broker Changelog

These release notes list changes to Coinbase Prime Broker.

​

2025-JUN-18

• Added support for Prime Limit Fill or Kill (FOK) order with size in quote order instructions.
  • FIX CashOrderQty(152) with TimeInForce(59) FILL_OR_KILL
  • REST create order quote_value with time_in_force FILL_OR_KILL

​

2025-APR-7

• Added the following field to Products and Products Channel for Websocket feed:
  • rfq_product_detail contains product details for placing RFQ orders, which includes the following sub-fields:
    • tradable determines if the product is tradable for RFQ
    • min_notional_size is the minimum notional size for RFQ orders
    • max_notional_size is 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_amount is 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

Prime FIX API:

• 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 network field for Prime Multinetwork Support:
  • List Assets, will return network_details for each asset supported by the entity
  • List Portfolio Transactions, will return the network field in the response if the transaction is onchain
  • List Wallet Transactions, will return the network field in the response if the transaction is onchain
  • Get Transaction by Transaction ID, will return the network field in the response if the transaction is onchain
  • Create Withdrawal, will take in optional network field as a request parameter and return the network field in the response if the withdrawal is onchain
  • List Portfolio Wallets, will return the network field in the response if the wallet is a vault wallet
  • Get Wallet by Wallet ID, will return the network field in the response if the wallet is a vault wallet
  • Create Wallet, will take in optional network field as a request parameter and return the network field in the response if the wallet is a vault wallet
  • Get Wallet Deposit Instructions, will take in the optional network field as a request parameter and return the network field in the response if the deposit instruction is onchain

​

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. currency is 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_sweep status of a given entity. Auto sweep will automatically sweep all available balance by each settlement.

​

2024-DEC-17

• Added user_context to 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_type to the Orders Channel.

​

2024-DEC-12

• Updated WEB3 wallet type to ONCHAIN on type field in request and response for Create Wallet, List Wallets, and Get Wallet by Wallet ID
• Added support for creating ONCHAIN wallets to Create Wallet
• Added VISIBILITY field to List Wallets and Get Wallet by Wallet ID
• Updated WEB3_TRANSACTION transaction type to ONCHAIN_TRANSACTION in request parameters and responses for List Portfolio Transactions, List Wallet Transactions, and Get Transaction by Transaction ID. All transactions previously marked as WEB3_TRANSACTION will now be returned as ONCHAIN_TRANSACTION.

​

2024-DEC-05

Added product_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_filtering boolean.
• Updated L2_data channel response to include venue_configuration for 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. The stop_price field is required for this new order type.
• Added FIX Target Strategy Type SL for the new Stop Limit order and StopPx (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_pov that 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 NewOrderSingle LIMIT orders.

​

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_price to 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_px to the Orders Channel.

​

2023-AUG-10

Updated List Open Orders:

• Fixed query parameters order_type, order_side, sort_direction, start_date, and end_date which can again be used to filter orders.
• Deprecated query parameters limit, and cursor.
• Deprecated field pagination from 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 type value called VWAP
• List Open Orders, List Portfolio Orders: Users can filter by new order_type called VWAP

​

2023-MAR-17

Added 2 new response properties to Get Portfolio credit Information:

• adjusted_credit_utilized
• adjusted_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, timestamp and event_time.

​

2022-SEP-02

Added 3 new response properties to Get Portfolio Allocations:

• allocation_completed_at
• order_ids
• fees_allocated_leg of 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_type called: BLOCK
  • Added a new possible value BLOCK to the field type, which refers to a block trade

• Updated Get Order by Order ID:

  • Added a new possible value BLOCK to the field type, which refers to a block trade

​

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 a COST_PLUS commission configuration.

• Added the following fields to List Portfolio Balances, Get Wallet Balance:

  • bonded_amount is the amount currently locked due to bonding/staking, potentially subject to an unbonding period, in whole units
  • reserved_amount is the amount that must remain in the wallet due to the protocol, in whole units
  • unbonding_amount is the amount that is in the process of unbonding, in whole units
  • unvested_amount is the unrealized amount subject to a vesting schedule, in whole units
  • pending_rewards_amount is the pending bonding/staking rewards that have not yet been realized, in whole units
  • past_rewards_amount is the previously realized bonding/staking rewards, in whole units
  • bondable_amount is 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_symbol field to List Wallet Transactions, List Portfolio Transactions, and Get Transaction by Transaction ID
• Added CONVERSION filter 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

• 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_ids parameter 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_date and end_date. The end_date parameter is still optional, but if not specified you get orders from start_date to the end of time. Previously, it returned start_date to start_date + 31 days.

• Updated List Open Orders:

  • The product_ids parameter 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, and end_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.

​

2022-APR-07

• Added the has_next boolean field to the pagination field in the response body. The has_next field indicates if there is more data available to paginate through.

• Removed the total_result_count field has been removed from the pagination field 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 type filter.
• Get Portfolio Commission is now available to retrieve commissions for your portfolio.

​

2022-JAN-19

Fixed:

• The account_identifier field now appears within Get Wallet Deposit Instructions.
• Missing Transaction resources now appear in List Portfolio Transactions.

Additions:

• The fields transfer_from and transfer_to now 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_from and transfer_to type.
• Added non-balance impacting transaction types to List Portfolio Transactions.

​

2021-DEC-15

• Welcome to the Coinbase Prime REST API.