Deriv forget
Stops one stream at once, by the id the stream's own messages carry in subscription.id. This is how a subscription is ended.
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.
The message
- Name
- forget
- 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 |
|---|---|---|
| forgetrequired | string | The id of the stream to stop, 32 to 128 characters long. |
| 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
forget: Whether a stream was stopped.
| Name | Type | Description |
|---|---|---|
| forget | integer | 1 where the stream was found and stopped, 0 where no stream had that id. |
| echo_reqrequired | object | A copy of the request that was sent. |
| msg_typerequired | string | Names the kind of answer. Here it is forget. |
| 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.
{
"forget": "<the subscription id of the stream>"
}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 |