Deriv proposal
Asks what one contract would cost now: the price, the payout and a description of it, with an id that buy accepts. With subscribe set to 1 the price is sent again as it changes.
Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.
This is a message of the Deriv WebSocket API, not an HTTP endpoint. It has no method and no path: it is sent as JSON over an open WebSocket connection.
Deriv's workflow page puts this first in a trade: send proposal, then send buy with the id and the ask price from the answer. The definition says some contracts on the symbols R_10, R_25, R_50, R_75, R_100, RDBULL and RDBEAR are not streamed, because their price does not change.
The message
- Name
- proposal
- Direction
- Request, sent by the client
- Carried by
- WebSocket. Deriv's page marks this call as needing no login, so it can be sent on the public connection as well. The demo and real addresses are not opened as printed: POST /trading/v1/options/accounts/{accountId}/otp returns the address for one account with a one time password already in it.
- Public market data, no login
- wss://api.derivws.com/trading/v1/options/ws/public
- Demo account
- wss://api.derivws.com/trading/v1/options/ws/demo
- Real account
- wss://api.derivws.com/trading/v1/options/ws/real
Fields
| Name | Type | Description |
|---|---|---|
| proposalrequired | integer | Always 1. |
| amount | number | The stake or the payout wanted. Which of the two it is, basis says. |
| barrier | string | The barrier of the contract, or the digit predicted for a digit contract. The definition says contracts shorter than 24 hours take a barrier relative to the entry price, written with a plus or minus sign, except on synthetic indices, which take either kind. |
| barrier2 | string | The lower barrier, for contracts that have two. |
| basis | string | payout or stake: what amount means. |
| cancellation | string | How long the option to cancel lasts. For MULTUP and MULTDOWN contracts only. |
| contract_typerequired | string | The contract type. The definition lists 35, among them CALL, PUT, HIGHER, LOWER, ONETOUCH, NOTOUCH, MULTUP, MULTDOWN, ACCU, TURBOSLONG, TURBOSSHORT, VANILLALONGCALL and VANILLALONGPUT. |
| currencyrequired | string | The currency of the account. No other currency is accepted. |
| date_expiry | integer | When the contract ends, as Unix time in seconds. Either this or duration is needed. |
| duration | integer | How long the contract lasts, in the unit given by duration_unit. Either this or date_expiry is needed. |
| duration_unit | string | The unit of duration: s for seconds, m for minutes, h for hours, d for days, t for ticks. |
| growth_rate | number | The growth rate of an accumulator contract. |
| limit_order | object | An order that closes the contract when a condition is met, holding take_profit, stop_loss or both as numbers. For MULTUP, MULTDOWN and ACCU contracts only. |
| multiplier | number | The multiplier, for contracts that are not binary options. |
| payout_per_point | number | The payout for each point. Where it is given, the barrier is worked out from it. |
| selected_tick | integer | The tick predicted to be the highest or the lowest. For TICKHIGH and TICKLOW contracts. |
| subscribe | integer | 1 starts a stream of prices for this contract. The only value allowed is 1. |
| underlying_symbolrequired | string | The symbol the contract is on, by the code active_symbols returns. |
| passthrough | object | Anything you want carried through the call. It comes back unchanged inside echo_req. |
| req_id | integer | A number of your own that is returned on the answer, so answers can be matched to requests. |
What arrives
proposal: The price of the contract now. The vendor's definition holds further fields for single contract types: this list is the common ones.
| Name | Type | Description |
|---|---|---|
| proposal.ask_pricerequired | number | The price to buy the contract at. It is what buy takes as its price. |
| proposal.date_startrequired | integer | When the contract starts, as Unix time in seconds. |
| proposal.date_expiry | integer | When the contract ends, as Unix time in seconds. |
| proposal.idrequired | string | The id of this proposal on this connection. It is what buy takes, and forget stops the stream with it. |
| proposal.longcoderequired | string | The contract described in a sentence. |
| proposal.payoutrequired | number | What the contract pays out. |
| proposal.spotrequired | number | The current price of the symbol, where no licence restriction on the price feed applies. |
| proposal.spot_timerequired | integer | The time of that price, as Unix time in seconds. |
| proposal.commission | number or null | The commission, as a percentage. |
| proposal.cancellation | object | The price and the expiry of the option to cancel, where the contract has one. |
| proposal.contract_details | object | Barriers, stake limits and payout limits worked out for the contract. |
| proposal.limit_order | object | The stop loss, take profit and stop out that apply, for contracts with a limit order. |
| proposal.validation_params | object | The smallest and largest stake, payout, stop loss and take profit the contract accepts. |
| subscription.idrequired | string | The id of the stream on this connection. Sent with forget to stop it. The subscription object is present only where the request asked for a stream. |
| echo_reqrequired | object | A copy of the request that was sent. |
| msg_typerequired | string | Names the kind of answer. Here it is proposal. |
| req_id | integer | The number the request carried. Present only where the request had one. |
Sample
Written by this site from the fields recorded on this page. It has not been run against a terminal, a server or an account, and the values in it are placeholders. No credential is typed into it: where a field holds one, the placeholder says where it comes from. Nothing is entered on this site.
{
"proposal": 1,
"amount": 100,
"barrier": "+0.1",
"basis": "payout",
"contract_type": "HIGHER",
"currency": "USD",
"duration": 60,
"duration_unit": "s",
"underlying_symbol": "R_100"
}Limits that apply at Deriv
| Limit | Value | Scope | Source |
|---|---|---|---|
| Headline limit | 80/min per logged in user (REST)Sources conflict developers.deriv.com states 60, checked . Deriv's API overview in the text form it publishes for AI tools gives REST 60 requests a minute per token, where its Limits page gives 80 a minute per logged in user. The same overview also gives 100 WebSocket requests a second per connection, 100 active subscriptions per connection and 5 concurrent WebSocket connections per user, none of which the Limits page mentions. Deriv's own pages disagree; the conflict is labelled, not resolved. Pace against 60. | user, REST | developers.deriv.comchecked |