Deriv proposal_open_contract
Returns the current price and state of a contract the account holds. With subscribe set to 1 an update follows each time it changes, and with no contract_id the stream covers every open contract.
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 uses this to watch a contract after buying it: send it with the contract_id and subscribe set to 1.
The message
- Name
- proposal_open_contract
- Direction
- Request, sent by the client
- Carried by
- WebSocket. Deriv's page marks this call as needing a login with the trade scope, so it is sent on the connection of one account. 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.
- 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 |
|---|---|---|
| proposal_open_contractrequired | integer | Always 1. |
| contract_id | integer | The contract to report on, as portfolio or buy returns it. Left out, the stream covers all open contracts. |
| subscribe | integer | 1 starts a stream. The only value allowed is 1. |
| 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_open_contract: The contract as it stands now. This list is a selection: the vendor's definition holds about sixty fields, many of them for one contract type only.
| Name | Type | Description |
|---|---|---|
| proposal_open_contract.contract_id | integer | The id of the contract. |
| proposal_open_contract.contract_type | string | The contract type. |
| proposal_open_contract.underlying_symbol | string | The symbol the contract is on. |
| proposal_open_contract.currency | string | The currency of the contract. |
| proposal_open_contract.buy_price | string | The price the contract was bought at. |
| proposal_open_contract.bid_price | string | The price the contract could be sold back at now. |
| proposal_open_contract.payout | string | What the contract pays out. |
| proposal_open_contract.profit | string | The latest bid price less the buy price. |
| proposal_open_contract.profit_percentage | number | The profit as a percentage. |
| proposal_open_contract.current_spot | string | The current price of the symbol, where it is licensed to be streamed. |
| proposal_open_contract.current_spot_time | integer | The time of that price, as Unix time in seconds. |
| proposal_open_contract.entry_spot | string or null | The first valid price of the symbol for the contract. |
| proposal_open_contract.exit_spot | string or null | The price the contract ended on, or was sold at. |
| proposal_open_contract.date_start | integer | When the contract started, as Unix time in seconds. |
| proposal_open_contract.date_expiry | integer | When the contract ends, as Unix time in seconds. Not used for contracts counted in ticks. |
| proposal_open_contract.is_expired | integer | 1 where the contract has expired, 0 where it has not. |
| proposal_open_contract.is_sold | integer | 1 where the contract has been sold, 0 where it has not. |
| proposal_open_contract.is_valid_to_sell | integer | 1 where the contract can be sold back now, 0 where it cannot. |
| proposal_open_contract.is_valid_to_cancel | integer | 1 where the contract can be cancelled, 0 where it cannot. |
| proposal_open_contract.status | string or null | open, sold, won, lost or cancelled. |
| proposal_open_contract.sell_price | string or null | The price the contract was sold at, once it has been sold. |
| proposal_open_contract.sell_time | integer or null | When the contract was sold, as Unix time in seconds. |
| proposal_open_contract.limit_order | object | The stop loss, stop out and take profit on the contract. |
| proposal_open_contract.transaction_ids | object | The id of the buy transaction and, once sold, of the sell transaction. |
| proposal_open_contract.validation_error | string | The message where the contract fails validation, for example where it cannot be sold now. |
| proposal_open_contract.id | string | The id of the stream on this connection. |
| 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_type | string | Names the kind of answer. Here it is proposal_open_contract. The definition does not mark it as required on this answer. |
| 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_open_contract": 1,
"contract_id": 11111111,
"subscribe": 1
}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 |