Legacy vs New API
Comprehensive guides comparing Deriv Legacy API and New API endpoint by endpoint.
Before you start
- Review the breaking changes for each endpoint you use
- Test your integration in a development environment first
- Update your code to use the new field names and parameters
- Plan your development approach for the New API version
Data Endpoints
Active symbols
7 ChangesRetrieves all currently active trading symbols. Response fields renamed, spot and display fields removed, filtering parameters removed and contract_type values changed.
Contracts for
6 ChangesGet available contracts for a symbol. Request parameters, market data, display and Snowball fields removed, and display_number_of_contracts can be null.
Ticks
Stream real-time ticks for one or more symbols. Unchanged in the New API.
Ticks history
1 ChangeGet historical tick data. The count parameter default changed from 5000 to 1000.
Account Endpoints
Balance
4 ChangesGet the current account balance with real-time updates. The account and loginid parameters and the accounts and total response objects are removed.
Portfolio
3 ChangesGet current portfolio. The market symbol field is renamed, and the loginid parameter and app_id field are removed.
Profit table
3 ChangesGet profit/loss history. The loginid parameter and app_id field removed, and contract_type values changed.
Statement
5 ChangesGet account statement. The loginid parameter and transfer fields removed, fewer action_type values, and app_id changed from integer to string.
Transaction
6 ChangesSubscribe to transaction notifications. The loginid parameter and contract fields are removed, the market symbol field is renamed, and fewer transaction types are reported.
Trading Endpoints
Buy
4 ChangesPurchase contracts. The loginid parameter removed, parameters.symbol renamed to parameters.underlying_symbol, six parameters fields removed, and the contract_type values changed.
Cancel
1 ChangeCancel an active contract. The loginid parameter is removed; the response is unchanged.
Contract update
1 ChangeUpdate a contract's take profit and stop loss. The loginid parameter is removed, and the response adds display_order_amount.
Contract update history
1 ChangeGet a contract's update history. The loginid parameter is removed; the response is unchanged.
Proposal
7 ChangesGet contract pricing. The market symbol field is renamed, request parameters and contract types are removed, and display_value and Snowball response fields are removed. Only streaming proposal IDs can be bought.
Proposal open contract
8 ChangesGet open contract details. The loginid parameter is removed, price and spot fields are now strings, the market symbol field is renamed, and tick, display and Snowball fields are removed.
Sell
1 ChangeSell an active contract. The loginid parameter is removed; the response is unchanged.
Subscription Endpoints
Comparison Tips
Field name changes
symbol is now underlying_symbol.Removed features
Simplified responses
Test thoroughly
Any other questions? Get in touch