GuidesAPI Reference
DocumentationLog In

REST API Changelog

Release notes for the Prime REST API

2022-SEP-2

Additions
Add 3 new fields in allocations of GET /v1/portfolios/{portfolio_id}/allocations:

  • "allocation_completed_at"
  • "order_ids"
  • "fees_allocated_leg" of destination level

2022-AUG-12

Additions

  • GET /v1/portfolios/{portfolio_id}/allocations endpoint is now available to get a list of 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 field type, which refers to a block trade

Get Order by Order ID:

  • Added a new possible value BLOCK to the field type, 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 a COST_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.

List Activities:

  • Users can now filter by a new type of activity called: ACTIVITY_TYPE_CONVERSION.

List Wallet Transactions:

  • 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.

List Portfolio Transactions:

  • 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.

List Activities:

  • Users can now filter by a new type of activity called an allocation: ACTIVITY_CATEGORY_ALLOCATION

2022-APR-22

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.

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

Additions

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

Removals

  • The total_result_count field has been removed from the pagination 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 and GET /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 a type 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 within GET /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 and transfer_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 and transfer_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.