Prime REST API Changelog
2023-SEP-08
Added endpoints to support Net Allocations:
- New endpoint to create a net allocation from a given portfolio.
Get Allocations By Netting ID:
- New endpoint to retrieve allocations by netting ID.
2023-AUG-10
- Query parameters
order_type
,order_side
,sort_direction
,start_date
, andend_date
are functional again and can be used to filter orders. - Query parameters
limit
, andcursor
are now deprecated. - Field
pagination
from response payload is deprecated.
2023-JUL-25
Additions
- TimeInForce
FILL_OR_KILL
enum added.
2023-JUN-29
Additions
Added volume-weighted average price trading (VWAP
):
Create Order, Get Order Preview:
- Added a new
type
value calledVWAP
- Added a new
List Open Orders, List Portfolio Orders:
- Users can filter by new
order_type
calledVWAP
- Users can filter by new
2023-MAR-17
Additions
Added 2 new response properties to Get Portfolio credit Information:
adjusted_credit_utilized
adjusted_portfolio_equity
2022-SEP-2
Additions
Added 3 new response properties to Get Portfolio Allocations:
allocation_completed_at
order_ids
fees_allocated_leg
of destination level
2022-AUG-12
Additions
Added new endpoint Get Portfolio Allocations returns a list of allocations.
GET /v1/portfolios/{portfolio_id}/allocations
2022-AUG-10
Additions
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
- Added a new possible value
BLOCK
to the fieldtype
, which refers to a block trade
2022-JUL-27
Additions
List Open Orders, Get Order by Order ID, List Portfolio Orders:
- Users can now see a field
exchange_fee
, populated when the order was placed with aCOST_PLUS
commission configuration.
List Portfolio Balances, Get Wallet Balance:
- Added a new field
bonded_amount
, which refers to the amount currently locked due to bonding/staking, potentially subject to an unbonding period, in whole units - Added a new field
reserved_amount
, which refers to the amount that must remain in the wallet due to the protocol, in whole units - Added a new field
unbonding_amount
, which refers to the amount that is in the process of unbonding, in whole units - Added a new field
unvested_amount
, which refers to the unrealized amount subject to a vesting schedule, in whole units - Added a new field
pending_rewards_amount
, which refers to the pending bonding/staking rewards that have not yet been realized, in whole units - Added a new field
past_rewards_amount
, which refers to the previously realized bonding/staking rewards, in whole units - Added a new field
bondable_amount
, which refers to the amount available for bonding/staking, in whole units
2022-JUL-01
Additions
POST /v1/portfolios/{portfolio_id}/wallets/{wallet_id}/conversion
endpoint is now available to perform conversions between USD and USDC.
- Users can now filter by a new type of activity called:
ACTIVITY_TYPE_CONVERSION
.
- Users can now filter by a new type of transaction called:
CONVERSION
. - Added a new field
destination_symbol
, which will contain the destination symbol of the conversion.
- Users can now filter by a new type of transaction called:
CONVERSION
. - Added a new field
destination_symbol
, which will contain the destination symbol of the conversion.
Get Transaction by Transaction ID:
- Added a new field
destination_symbol
, which will contain the destination symbol of the conversion.
2022-JUN-08
Additions
GET /v1/portfolios/{portfolio_id}/address_book
endpoint is now available to get a list of address book addresses.POST /v1/portfolios/{portfolio_id}/address_book
endpoint is now available to create an entry for a portfolio's trusted addresses.
- Users can now filter by a new type of activity called an allocation:
ACTIVITY_CATEGORY_ALLOCATION
2022-APR-22
- 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
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.
2022-APR-07
Additions
- The
has_next
boolean field has been added to thepagination
field in the response body. Thehas_next
field indicates if there is more data available to paginate through.
Removals
- The
total_result_count
field has been removed from thepagination
field in the response body.
2022-MAR-24
Additions
POST /v1/portfolios/:id/wallets/:wallet_id/withdrawals
endpoint is now available to request new withdrawal transactions from a portfolio wallet.POST /v1/portfolios/:id/wallets/:wallet_id/transfers
endpoint is now available to request new transfers between portfolio wallets.
2022-MAR-19
Additions
GET /v1/entities/:id/payment-method/:payment_method_id
endpoint is now available to retrieve payment method information related to investment vehicles.POST /v1/portfolios/:id/wallets
endpoint is now available to request new wallets for a portfolio.
2022-MAR-07
Additions
GET /v1/portfolios/:id/activities
endpoint is now available to retrieve a list of activities related to a given portfolio.GET /v1/portfolios/:id/activities/:activity_id
endpoint is now available to retrieve a specific activity.
2022-FEB-15
Fixes
- Blockchain Network Ids (
blockchain_ids
) should now appear in the Transaction response. GET /v1/portfolios/:id/orders
andGET /v1/portfolios/:id/order_fills
pagination should now function as expected.
2022-JAN-31
Additions
GET /v1/portfolios/:id/credit
will return 200 response if post trade credit is not enabled.
An enabled flag has also been added:
GET /v1/portfolios/:id/portfolio_balances
now has atype
filter.GET /v1/portfolios/:id/commissions
is now available to retrieve commissions for your portfolio.
2022-JAN-19
Fixes
- The
account_identifier
field now appears withinGET /v1/portfolios/:id/wallets/:wallet_id/deposit_instructions
. - The missing Transaction resources should now appear in
GET /v1/portfolio/:id/transactions
.
Additions
- The Transaction
transfer_from
andtransfer_to
fields should now appear in the Transaction resource for Transfer Withdrawals and Deposits. - External address deposit information should now be 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. - Non-balance impacting Transaction types now appear in
GET /v1/portfolios/:id/transactions
.
2021-DEC-15
- Welcome to the Coinbase Prime REST API.
2021-OCT-15
- Welcome to the Coinbase Prime REST API beta.