Prime Broker Changelog
These release notes list changes to Coinbase Prime Broker.
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_price
field is required for this new order type. - Added FIX Target Strategy Type
SL
for 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_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 NewOrderSingleLIMIT
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-10
Updated List Open Orders:
- Fixed query parameters
order_type
,order_side
,sort_direction
,start_date
, andend_date
which can again be used to filter orders. - Deprecated query parameters
limit
, andcursor
. - 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 calledVWAP
- List Open Orders, List Portfolio Orders: Users can filter by new
order_type
calledVWAP
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
andevent_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 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
BLOCK
to 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_PLUS
commission configuration.
- Users can now see a field
-
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 unitsreserved_amount
is the amount that must remain in the wallet due to the protocol, in whole unitsunbonding_amount
is the amount that is in the process of unbonding, in whole unitsunvested_amount
is the unrealized amount subject to a vesting schedule, in whole unitspending_rewards_amount
is the pending bonding/staking rewards that have not yet been realized, in whole unitspast_rewards_amount
is the previously realized bonding/staking rewards, in whole unitsbondable_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
- 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_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
andend_date
. Theend_date
parameter is still optional, but if not specified you get orders fromstart_date
to the end of time. Previously, it returnedstart_date
tostart_date
+ 31 days.
- The
-
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
, 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_next
boolean field to thepagination
field in the response body. Thehas_next
field indicates if there is more data available to paginate through. -
Removed the
total_result_count
field has been removed from thepagination
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
andtransfer_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
andtransfer_to
type. - Added non-balance impacting transaction types to List Portfolio Transactions.
2021-DEC-15
- Welcome to the Coinbase Prime REST API.