Broker API HubMenu

Deriv transaction

messagetransactionDeriv WebSocket APIWebSocketAccount

Opens a stream of the account's transactions: a message arrives for each buy, sell, deposit and withdrawal. subscribe must be 1, and without it no records are returned.

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.

Independent and unofficialdevelopers.deriv.comchecked The definition file it was checked against

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
transaction
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

NameTypeDescription
transactionrequiredintegerAlways 1.
subscriberequiredintegerAlways 1. This call exists only as a stream.
passthroughobjectAnything you want carried through the call. It comes back unchanged inside echo_req.
req_idintegerA number of your own that is returned on the answer, so answers can be matched to requests.

What arrives

transaction: One transaction on the account, sent as it happens.

NameTypeDescription
transaction.actionstringWhat happened: buy, sell, deposit or withdrawal.
transaction.amountnumberThe amount of the transaction.
transaction.balancenumberThe balance of the account.
transaction.contract_idinteger or nullThe contract the transaction belongs to, where it belongs to one.
transaction.currencystringThe currency of the transaction.
transaction.date_expiryintegerWhen the contract ends, as Unix time in seconds. The definition says it is approximate on a buy.
transaction.idstringThe id of the stream on this connection.
transaction.longcodestringThe contract described in a sentence.
transaction.purchase_timeintegerWhen the contract was bought. Present on a sell only.
transaction.transaction_idintegerThe id of the transaction. Each buy, sell and payment has its own.
transaction.transaction_timeintegerWhen the transaction happened: the purchase time for a buy, the sale time for a sell.
transaction.underlying_symbolstringThe symbol of the contract.
subscription.idrequiredstringThe 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_reqrequiredobjectA copy of the request that was sent.
msg_typerequiredstringNames the kind of answer. Here it is transaction.
req_idintegerThe 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.

{
  "transaction": 1,
  "subscribe": 1
}

Limits that apply at Deriv

LimitValueScopeSource
Headline limit80/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, RESTdevelopers.deriv.comchecked