Crate deriv_api_schema

Source
Expand description

§Deriv API Schema

Auto-generated Rust types for the Deriv API. These types are generated from the official API documentation.

This crate provides strongly typed request and response structures for all API endpoints.

Structs§

AccountItem
AccountListItem
AccountListRequest
Returns all accounts belonging to the authorized user.
AccountListResponse
Returns all accounts belonging to the authorized user.
ActiveSymbolItem
The information about each symbol.
ActiveSymbolsRequest
Retrieve a list of all currently active symbols (underlying markets upon which contracts are available for trading).
ActiveSymbolsResponse
A message containing the list of active symbols.
Additional
Additional information required by the document type.
Address
POA authentication status details.
AfterFirstDepositRequirements
After first deposit requirements
ApiTokenRequest
This call manages API tokens
ApiTokenResponse
The result of the API token request made.
AppDeleteRequest
The request for deleting an application.
AppDeleteResponse
The result of delete application request made.
AppGet
The information of the requested application.
AppGetRequest
To get the information of the OAuth application specified by ‘app_id’
AppGetResponse
A message with requested application details
AppListItem
AppListRequest
List all of the account’s OAuth applications
AppListResponse
A message with created applications
AppMarkupDetailsRequest
Retrieve details of app_markup according to criteria specified.
AppMarkupDetailsResponse
Per transaction reporting of app_markup
AppMarkupStatisticsRequest
Retrieve statistics of app_markup.
AppMarkupStatisticsResponse
Per application reporting of app_markup
AppRegisterRequest
Register a new OAuth application
AppRegisterResponse
A message with created application details
AppUpdate
Information of the updated application.
AppUpdateRequest
Update a new OAuth application
AppUpdateResponse
A message with created application
AssetIndexRequest
Retrieve a list of all available underlyings and the corresponding contract types and duration boundaries. If the user is logged in, only the assets available for that user’s landing company will be returned.
AssetIndexResponse
A message with Asset Index
Authorize
Account information for the holder of the token.
AuthorizeRequest
Authorize current WebSocket session to act on behalf of the owner of a given token. Must precede requests that need to access client account, for example purchasing and selling contracts or viewing portfolio.
AuthorizeResponse
A message containing account information for the holder of that token.
AvailableItem
AvailableServiceItem
BalanceRequest
Get user account balance
BalanceResponse
Return details of user account balance
Buy
Receipt confirmation for the purchase
BuyContractForMultipleAccounts
Receipt confirmation for the purchase
BuyContractForMultipleAccountsRequest
Buy a Contract for multiple Accounts specified by the tokens parameter. Note, although this is an authorized call, the contract is not bought for the authorized account.
BuyContractForMultipleAccountsResponse
A message with transaction results is received
BuyRequest
Buy a Contract
BuyResponse
A message with transaction results is received
Cancel
Receipt for the transaction
CancelRequest
Cancel contract with contract id
CancelResponse
A message with transaction results is received
CandleItem
CashierOneOfSub1
Response for type `api’.
CashierRequest
Request the cashier info for the specified type.
CashierResponse
Cashier information for the specified type.
ClientKycStatus
[Optional] Pertains to client KYC. Returned only if the client fails to meet the requirements, including proof of identity (POI), validity of the tax identification number (TIN), and proof of address (POA).
ClientKycStatusRequirements
[Optional] Pertains to client KYC. Returned only if the client fails to meet the requirements, including proof of identity (POI), validity of the tax identification number (TIN), and proof of address (POA).
CommonReportingStandard
Common Reporting Standard
ComplianceRequirements
Compliance requirements
ConfirmEmailRequest
Verifies the email for the user using verification code passed in the request object
ConfirmEmailResponse
Confirm Email Response
ContractUpdateHistoryItem
Contains the changed parameter.
ContractUpdateHistoryRequest
Request for contract update history.
ContractUpdateHistoryResponse
Contract update history status
ContractUpdateRequest
Update a contract condition.
ContractUpdateResponse
Contract update status
ContractsFor
List of available contracts. Note: if the user is authenticated, then only contracts allowed under his account will be returned.
ContractsForCompanyRequest
Get the list of currently available contracts for a given landing company.
ContractsForCompanyResponse
Get the list of currently available contracts for a given landing company.
ContractsForRequest
For a given symbol, get the list of currently available contracts, and the latest barrier and duration limits for each contract.
ContractsForResponse
Get the list of currently available contracts
CopyStartRequest
Start copy trader bets
CopyStartResponse
A message with results is received
CopyStopRequest
Stop copy trader bets
CopyStopResponse
A message with results is received
CopytradingListRequest
Retrieves a list of active copiers and/or traders for Copy Trading
CopytradingListResponse
Details of copiers and/or traders for Copy Trading
CopytradingStatisticsRequest
Retrieve performance, trading, risk and copiers statistics of trader.
CopytradingStatisticsResponse
The statistics of the trader.
CreateItem
CryptoConfigRequest
The request for cryptocurrencies configuration.
CryptoConfigResponse
The response will display the configuration details related to cryptocurrencies
CryptoEstimationsRequest
Get the current estimations for cryptocurrencies. E.g. Withdrawal fee.
DataItem
Deposit
[Optional] Result for deposit action.
Details
Extra information about the error.
Disclaimer
Disclaimer configuration
DocumentUploadRequest
Request KYC information from client
DocumentUploadResponse
Receive details of uploaded authentication documents
DurationItem
EconomicCalendarRequest
Specify a currency to receive a list of events related to that specific currency. For example, specifying USD will return a list of USD-related events. If the currency is omitted, you will receive a list for all currencies.
EconomicCalendarResponse
A list of economic events.
Error
Error in MT5 account details.
ExchangeRatesRequest
Retrieves the exchange rate from a base currency to a target currency supported by the system.
ExchangeRatesResponse
The exchange rate values from the specified base currency to the specified target currency supported by the system.
ExchangeVerificationCodeRequest
Verifies the code and returns a new code if verification is successful
ExchangeVerificationCodeResponse
Exchange Verification Code Response
FeatureFlag
[Optional] Enable or disable one or multiple features.
FinancialAssessmentQuestionsRequest
This call gets the financial assessment questionnaire structure, which defines the questions, possible answers, and flow logic for the financial assessment form.
FinancialAssessmentQuestionsResponse
Returns the questionnaire structure defining the financial assessment questions and logic
ForgetAllRequest
Immediately cancel the real-time streams of messages of given type.
ForgetAllResponse
The result of forget all request made.
ForgetRequest
Immediately cancel the real-time stream of messages with a specific ID.
ForgetResponse
The result of forget request made.
ForwardStartingOptionItem
Geolocation
Geographical location of the server.
GetAccountStatusRequest
Get Account Status
GetAccountStatusResponse
A message with Account Status
GetFinancialAssessmentRequest
This call gets the financial assessment details. The ‘financial assessment’ is a questionnaire that clients of certain Landing Companies need to complete, due to regulatory and KYC (know your client) requirements.
GetFinancialAssessmentResponse
This call gets the financial assessment details of client’s account.
GetLimitsRequest
Trading and Withdrawal Limits for a given user
GetLimitsResponse
Trading and Withdrawal Limits
GetSelfExclusionRequest
Allows users to exclude themselves from the website for certain periods of time, or to set limits on their trading activities. This facility is a regulatory requirement for certain Landing Companies.
GetSelfExclusionResponse
A message with User Self-Exclusion
GetSettingsRequest
Get User Settings (email, date of birth, address etc)
GetSettingsResponse
A message with User Settings
GetThirdPartyRedirectRequest
Get Third Party Redirect URL for sso login.
GetThirdPartyRedirectResponse
The result for Third Party Redirect URL for sso login.
History
Historic tick data for a given symbol. Note: this will always return the latest possible set of ticks with accordance to the parameters specified.
Identity
POI authentication status details.
IdentityVerificationDocumentAddRequest
Adds document information such as issuing country, id and type for identity verification processes.
IdentityVerificationDocumentAddResponse
Adds document information such as issuing country, id and type for identity verification processes.
JurisdictionRiskAssessment
Jurisdiction Risk Assessment
KycAuthStatusOneOfSub0
Proof of Identity (POI) and Proof of Address (POA) authentication status details.
KycAuthStatusOneOfSub1Value
KycAuthStatusRequest
Get KYC Authentication Status
KycAuthStatusResponse
A message with KYC Authentication Status.
LandingCompanyDetailsRequest
The company has a number of licensed subsidiaries in various jurisdictions, which are called Landing Companies (and which are wholly owned subsidiaries of the Deriv Group). This call provides information about each Landing Company.
LandingCompanyDetailsResponse
A message with Landing Company.
LandingCompanyInfo
LandingCompanyRequest
The company has a number of licensed subsidiaries in various jurisdictions, which are called Landing Companies. This call will return the appropriate Landing Company for clients of a given country. The landing company may differ for derived contracts (Synthetic Indices) and Financial contracts (Forex, Stock Indices, Commodities).
LandingCompanyResponse
Returns the Landing Company for clients of a given country.
LastRejected
Details on the rejected POA attempt.
LegalRequirements
Legal requirements for the Landing Company
LimitOrder
Specify limit order to update.
LinkedToItem
ListItem
LoginHistoryItem
User login history
LoginHistoryRequest
Retrieve a summary of login history for user.
LoginHistoryResponse
Recent login/logout history records
LogoutRequest
Logout the session
LogoutResponse
The response of logout request made.
MarketItem
Mt5DepositRequest
This call allows deposit into MT5 account from Binary account.
Mt5DepositResponse
The result of MT5 deposit request.
Mt5GetSettingsRequest
Get MT5 user account settings
Mt5GetSettingsResponse
Get MT5 user settings
Mt5LoginListItem
Mt5LoginListRequest
Get list of MT5 accounts for client
Mt5LoginListResponse
Get list of MT5 accounts for client.
Mt5NewAccountRequest
This call creates new MT5 user, either demo or real money user.
Mt5NewAccountResponse
Create MT5 account Receive
Mt5PasswordChangeRequest
To change passwords of the MT5 account.
Mt5PasswordChangeResponse
MT5 user password change receive
Mt5PasswordCheckRequest
This call validates the main password for the MT5 user
Mt5PasswordCheckResponse
MT5 user password check receive
Mt5PasswordResetRequest
To reset the password of MT5 account.
Mt5PasswordResetResponse
MT5 user password reset receive
Mt5WithdrawalRequest
This call allows withdrawal from MT5 account to Binary account.
Mt5WithdrawalResponse
The result of MT5 withdrawal request made.
NewAccountMaltainvestRequest
This call opens a new real-money account with the maltainvest Landing Company. This call can be made from a virtual-money account or real-money account at Deriv (Europe) Limited. If it is the latter, client information fields in this call will be ignored and data from your existing real-money account will be used.
NewAccountMaltainvestResponse
Create maltainvest account Receive
NewAccountRealRequest
This call opens a new real-money account. This call can be made from a virtual-money or a real-money account. If it is the latter, client information fields in this call will be ignored and data from your existing real-money account will be used.
NewAccountRealResponse
Create real account Receive
NewAccountVirtualRequest
Create a new virtual-money account.
NewAccountVirtualResponse
Create virtual-money account
NewPartnerAccountRequest
This call opens a new Real-Partner Account
NewPartnerAccountResponse
Create real partner account - Receive
NonParticipatingJurisdictions
NPJ configuration
OauthAppItem
OauthAppsRequest
List all my used OAuth applications.
OauthAppsResponse
A message with used applications
Ohlc
Historic tick data for a given symbol. Note: this will always return the latest possible set of ticks with accordance to the parameters specified.
P2pAdvertCreateRequest
Creates a P2P (Peer to Peer) advert. Can only be used by an approved P2P advertiser.
P2pAdvertCreateResponse
Returns the information of the created P2P (Peer to Peer) advert.
P2pAdvertInfoRequest
Retrieve information about a P2P advert.
P2pAdvertInfoResponse
Returns information about the given advert ID.
P2pAdvertListRequest
Returns available adverts for use with p2p_order_create .
P2pAdvertListResponse
Available adverts matching the requested criteria.
P2pAdvertUpdateRequest
Updates a P2P advert. Can only be used by the advertiser.
P2pAdvertUpdateResponse
Returns information about the updated advert.
P2pAdvertiserAdvertsRequest
Returns all P2P adverts created by the authorized client. Can only be used by a registered P2P advertiser.
P2pAdvertiserAdvertsResponse
All adverts belonging to the current advertiser.
P2pAdvertiserCreateRequest
Registers the client as a P2P advertiser.
P2pAdvertiserCreateResponse
Returns information of the created advertiser.
P2pAdvertiserInfoRequest
Retrieve information about a P2P advertiser.
P2pAdvertiserInfoResponse
Returns information about the given advertiser ID.
P2pAdvertiserListRequest
Retrieve advertisers has/had trade with the current advertiser.
P2pAdvertiserListResponse
Retrieve advertisers has/had trade with the current advertiser.
P2pAdvertiserRelationsRequest
Updates and returns favourite and blocked advertisers of the current user.
P2pAdvertiserRelationsResponse
Returns information about favourite and blocked advertisers.
P2pAdvertiserUpdateRequest
Update the information of the P2P advertiser for the current account. Can only be used by an approved P2P advertiser.
P2pAdvertiserUpdateResponse
Returns latest information of the advertiser.
P2pChatCreateRequest
Creates a P2P chat for the specified order.
P2pChatCreateResponse
Information of the created P2P chat.
P2pCountryListRequest
List all or specific country and its payment methods.
P2pCountryListResponse
List all or specific country and its payment methods.
P2pOrderCancelRequest
Cancel a P2P order.
P2pOrderCancelResponse
Result of the P2P order cancellation.
P2pOrderConfirmRequest
Confirm a P2P order.
P2pOrderConfirmResponse
Result of the P2P order confirmation.
P2pOrderCreateRequest
Creates a P2P order for the specified advert.
P2pOrderCreateResponse
The information about the created P2P order.
P2pOrderDisputeRequest
Dispute a P2P order.
P2pOrderDisputeResponse
Result of the P2P order disputing.
P2pOrderInfoRequest
Retrieves the information about a P2P order.
P2pOrderInfoResponse
Information of the P2P order.
P2pOrderListRequest
List active orders.
P2pOrderListResponse
All orders matching the requested criteria.
P2pOrderReviewRequest
Creates a review for the specified order.
P2pOrderReviewResponse
Response for creating a P2P order review.
P2pPaymentMethodsRequest
List all P2P payment methods.
P2pPaymentMethodsResponse
List all P2P payment methods.
P2pPingRequest
Keeps the connection alive and updates the P2P advertiser’s online status. The advertiser will be considered offline 60 seconds after a call is made.
P2pPingResponse
The response of P2P ping request.
P2pSettingsRequest
Request P2P Settings information.
P2pSettingsResponse
Information of the P2P settings.
Parameters
[Optional] Used to pass the parameters for contract buy.
PartnerAccountCreationRequest
This call initiates the state machine for account creation process
PartnerAccountCreationResponse
Create partner accounts - Receive
PartnerAccountCreationStatusRequest
This call polls the state machine and returns the completion status for each step.
PartnerAccountCreationStatusResponse
A response message containing the status of partner account creation process
PartnerAccountsRequest
Get All Partner Accounts (Partner account details like website, provider, company details)
PartnerAccountsResponse
Get All Partner Accounts (Partner account details like website, provider, company details)
PartnerSettingsRequest
Get Partner Settings (Partner Type, Company Details etc)
PartnerSettingsResponse
Get Partner Settings (Partner Type, Company Details etc)
PartnerSettingsUpdateRequest
A message with Partner Settings
PartnerSettingsUpdateResponse
A message with Partner Settings
PaymentMethodItem
A payment method suported for the given country
PaymentMethodsRequest
Will return a list payment methods available for the given country. If the request is authenticated the client’s residence country will be used.
PaymentMethodsResponse
List of available payment methods for a given country.
PaymentagentCreateRequest
Saves client’s payment agent details.
PaymentagentCreateResponse
Sets client’s payment agent details.
PaymentagentDetailsRequest
Gets client’s payment agent details.
PaymentagentDetailsResponse
Gets client’s payment agent details.
PaymentagentList
Payment Agent List
PaymentagentListRequest
Will return a list of Payment Agents for a given country for a given currency. Payment agents allow users to deposit and withdraw funds using local payment methods that might not be available via the main website’s cashier system.
PaymentagentListResponse
A message with Payment Agent List
PaymentagentTransferRequest
Payment Agent Transfer - this call is available only to accounts that are approved Payment Agents.
PaymentagentTransferResponse
The result of transfer request made.
PaymentagentWithdrawJustificationRequest
Provide justification to perform withdrawal using a Payment Agent.
PaymentagentWithdrawJustificationResponse
The result of payment agent withdrawal justification request made.
PaymentagentWithdrawRequest
Initiate a withdrawal to an approved Payment Agent.
PaymentagentWithdrawResponse
The result of payment agent withdrawal request made.
PayoutCurrenciesRequest
Retrieve a list of available option payout currencies. If a user is logged in, only the currencies available for the account will be returned.
PayoutCurrenciesResponse
List of available payout currencies.
PhoneNumberItem
PingRequest
To send the ping request to the server. Mostly used to test the connection or to keep it alive.
PingResponse
The response of ping request.
PortfolioRequest
Receive information about my current portfolio of outstanding options
PortfolioResponse
Receive a list of outstanding options in the user’s portfolio
Postcode
Postcode configuration
ProfitTableRequest
Retrieve a summary of account Profit Table, according to given search criteria
ProfitTableResponse
A summary of account profit table is received
ProofOfOwnership
[Optional] It contains info about the proof of ownership being uploaded (mandatory for proof_of_ownership document type)
ProposalOpenContractRequest
Get latest price (and other information) for a contract in the user’s portfolio
ProposalOpenContractResponse
Latest price and other details for an open contract in the user’s portfolio
ProposalRequest
Gets latest price for a specific contract.
ProposalResponse
Latest price and other details for a given contract
RealityCheckRequest
Retrieve summary of client’s trades and account for the Reality Check facility. A ‘reality check’ means a display of time elapsed since the session began, and associated client profit/loss. The Reality Check facility is a regulatory requirement for certain landing companies.
RealityCheckResponse
This gives summary of client’s trades and account for reality check
ResidenceListItem
ResidenceListRequest
This call returns a list of countries and 2-letter country codes, suitable for populating the account opening form.
ResidenceListResponse
A message with Residence List
ResultItemAnyOfSub0
Receipt for one contract
ResultItemAnyOfSub1
Error message
RevokeOauthAppRequest
Used for revoking access of particular app.
RevokeOauthAppResponse
A message with revoking a used application
Rights
Rights assigned to the MT5 account.
RiskLevel
Risk level configuration
ScheduleItem
Periods of availabily. A null value will clear the existing schedule.
Sell
Receipt for the transaction
SellContractForMultipleAccountsRequest
Sell contracts for multiple accounts simultaneously. Uses the shortcode response from buy_contract_for_multiple_accounts to identify the contract, and authorisation tokens to select which accounts to sell those contracts on. Note that only the accounts identified by the tokens will be affected. This will not sell the contract on the currently-authorised account unless you include the token for the current account.
SellContractForMultipleAccountsResponse
Confirmation of the sale status for the selected contracts and accounts.
SellExpiredRequest
This call will try to sell any expired contracts and return the number of sold contracts.
SellExpiredResponse
The result of sell expired contract
SellRequest
Sell a Contract as identified from a previous portfolio call.
SellResponse
A message with transaction results is received
ServerInfo
Trade server information.
SetAccountCurrencyRequest
Set account currency, this will be default currency for your account i.e currency for trading, deposit. Please note that account currency can only be set once, and then can never be changed.
SetAccountCurrencyResponse
Status of set account currency call
SetFinancialAssessmentResponse
Set Financial Assessment Receive
SetSelfExclusionRequest
Set Self-Exclusion (this call should be used in conjunction with get_self_exclusion)
SetSelfExclusionResponse
A message with User Self-Exclusion
SetSettingsRequest
Set User Settings (this call should be used in conjunction with get_settings)
SetSettingsResponse
A message with User Settings
StatementRequest
Retrieve a summary of account transactions, according to given search criteria
StatementResponse
A summary of account statement is received
StatesListItem
StatesListRequest
For a given country, returns a list of States of that country. This is useful to populate the account opening form.
StatesListResponse
A message with States List
Submarket
The submarket in which the underlyings listed in symbol located.
SubmarketItem
Subscription
For subscription requests only.
SupportedDocumentItem
SupportedPaymentMethodItem
SymbolItem
Tax
Tax configuration
Tick
Tick by tick list of streamed data
TicksBatchItem
TicksBatchRequest
Initiate a continuous stream of spot price updates for a group symbols.
TicksBatchResponse
Latest spot price for a group symbols. Continuous responses with a frequency of up to one second.
TicksHistoryRequest
Get historic tick data for a given symbol.
TicksHistoryResponse
Historic tick data for a single symbol
TicksRequest
Initiate a continuous stream of spot price updates for a given symbol.
TicksResponse
Latest spot price for a given symbol. Continuous responses with a frequency of up to one second.
TimeRequest
Request back-end server epoch time.
TimeResponse
The result of server time request.
TinValidationsRequest
Get the validations for Tax Identification Numbers (TIN)
TinValidationsResponse
A message with validations for Tax Identification Numbers (TIN)
TncApprovalRequest
To approve the latest version of terms and conditions.
TncApprovalResponse
The result of T&C approval request.
TopupVirtualRequest
When a virtual-money’s account balance becomes low, it can be topped up using this call.
TopupVirtualResponse
The result of virtual money top up
TradeDurationItem
TradeType
List of trade types available for the symbols.
TradingDurationItem
TradingDurationsRequest
Retrieve a list of all available underlyings and the corresponding contract types and trading duration boundaries. If the user is logged in, only the assets available for that user’s landing company will be returned.
TradingDurationsResponse
A message with trading duration information for symbol and contract combinations.
TradingPlatformInvestorPasswordResetRequest
Reset the investor password of a Trading Platform Account
TradingPlatformInvestorPasswordResetResponse
The result of the Trading Platform investor password reset.
TradingPlatformPasswordResetRequest
Reset the password of a Trading Platform Account
TradingPlatformPasswordResetResponse
The result of the Trading Platform password reset.
TradingPlatformStatusRequest
Request trading platform status
TradingPlatformStatusResponse
Provides current suspension status of trading platforms
TradingServerItem
TradingServersRequest
Get the list of servers for a trading platform.
TradingServersResponse
Get list of servers for the platform provided.
TradingTimes
The trading times structure is a hierarchy as follows: Market -> SubMarket -> Underlyings
TradingTimesRequest
Receive a list of market opening times for a given date.
TradingTimesResponse
A message with Trading Times
TransactionRequest
Subscribe to transaction notifications
TransactionResponse
Return transaction updates
TransferBetweenAccountsRequest
This call allows transfers between accounts held by a given user. Transfer funds between your fiat and cryptocurrency accounts (for a fee). Please note that account_from should be same as current authorized account.
TransferBetweenAccountsResponse
The result of transfer order.
Turnover
Turnover configuration
UnsubscribeEmailRequest
It unsubscribe user from the email subscription.
UnsubscribeEmailResponse
The result of the unsubscribe email request.
UrlItem
UrlParameters
[Optional] Extra parameters that can be attached to the verify email link URL.
VerifyEmailRequest
Verify an email address for various purposes. The system will send an email to the address containing a security code for verification.
VerifyEmailResponse
Verify Email Receive
WebsiteConfigRequest
Request server config.
WebsiteConfigResponse
All config related settings.
WebsiteStatusRequest
Request server status.
WebsiteStatusResponse
Server status alongside general settings like call limits, currencies information, supported languages, etc.
WhiteLabelLinks
Links to access MT5 application for different platforms.
WithdrawOneOfSub0
Result for withdraw operation.
WithdrawOneOfSub1
Result for dry_run validation.

Enums§

AcceptRisk
Show whether client has accepted risk disclaimer.
AccountCategory
Category of the account.
AccountList
Must be 1
AccountOpeningReason
[Optional] Purpose and reason for requesting the account opening.
AccountOpeningSelfDeclarationRequired
Flag which indicates whether self declaration is required for account opening
AccountTurnover
[Optional] The anticipated account turnover.
AccountType
Type of the account.
Accounts
[Optional] To control the list of accounts returned when account_from or account_to is not provided. brief (default value) means that accounts with mt5 account_type will be excluded; it will run faster. all means that all accounts with any account_type (including mt5) will be returned.
Action
Type of operation, which is requested.
ActionType
[Optional] To filter the statement according to the type of transaction.
ActiveSymbols
If you use brief, only a subset of fields will be returned.
AddToLoginHistory
[Optional] Send this when you use api tokens for authorization and want to track activity using login_history call.
AdjustStartTime
[Optional] 1 - if the market is closed at the end time, or license limit is before end time, adjust interval backwards to compensate.
AllowCopiers
[Optional] Boolean value 1 or 0, indicating permission to allow others to follow your trades. Note: not applicable for Virtual account. Only allow for real money account.
AllowForwardStarting
1 if the symbol is tradable in a forward starting contract, 0 if not.
ApiToken
Must be 1
AppList
Must be 1
AppMarkupDetails
Must be 1
AppMarkupStatistics
Must be 1
AppRegister
Must be 1
AssetIndex
Must be 1
Balance
Must be 1
BarrierCategoryItem
BarrierRange
[Optional] Barrier range for callputspread.
Basis
[Optional] Indicate whether amount is ‘payout’ or ‘stake’.
BlockTrade
[Optional] Indicates if this is block trade ad or not. Default: 0.
Cashier
Operation which needs to be requested from cashier
CfdExperience
How much experience do you have in CFD trading?
CfdFrequency
How many CFD trades have you placed in the past 12 months?
CfdTradingDefinition
In your understanding, CFD trading allows you to:
ClientType
[Optional] Indicates whether this is for a client requesting an account with professional status.
CodeOfConductApproval
Indicates client’s agreement with the Code of Conduct.
ConfirmEmail
Must be 1
ContractType
A valid contract-type
ContractTypeItem
ContractUpdate
Must be 1
ContractUpdateHistory
Must be 1
ContractsForCompany
Must be 1
CopytradingList
Must be 1
CopytradingStatistics
Must be 1
CounterpartyType
[Optional] Filter the adverts by counterparty_type.
CreatedFor
[Optional] Purpose of the email verification. If set to ‘account_opening’, the API will only return the verification response without updating the user’s email verification status.
CryptoConfig
Must be 1
CryptoEstimations
Must be 1
Delete
[Optional] If set to 1, permanently deletes the advert.
DemoAccount
0 for real accounts; 1 for virtual/demo accounts.
Description
[Optional] If set to 1, will return full contracts description.
Disabled
Flag to represent if this server is currently disabled or not
DisputeReason
The predefined dispute reason
DocumentFormat
Document file format
DocumentType
Document type
DocumentUpload
Must be 1
DryRun
[Optional] If set to 1, only validation is performed. Only applicable for withdraw using crypto provider and api type.
DurationUnit
[Optional] Duration unit is s: seconds, m: minutes, h: hours, d: days, t: ticks
DxtradeUserException
Boolean value 1 or 0, indicating if user email belong to dxtrade exception list.
EconomicCalendar
Must be 1
EmailConsent
[Optional] Boolean value 1 or 0, indicating permission to use email address for any contact which may include marketing
EmailUnsubscribeStatus
1: email notification unsubscribed sucssesfully, 0: failed to unsubscribed email notification
Environment
The environment. E.g. Deriv-Server.
ExchangeIsOpen
1 if market is currently open, 0 if closed.
ExchangeRates
Must be 1
ExchangeVerificationCode
Must be 1
FatcaDeclaration
[Optional] Indicates client’s self-declaration of FATCA.
FavouritesOnly
[Optional] Only show adverts from favourite advertisers. Default is 0.
FinancialAssessmentQuestions
Must be 1
Forget
If set to 1, stream exited and stopped. If set to 0, stream did not exist.
GetAccountStatus
Must be 1
GetFinancialAssessment
Must be 1
GetLimits
Must be 1
GetSelfExclusion
Must be 1
GetSettings
Must be 1
GetThirdPartyRedirect
Must be 1
Granularity
[Optional] Only applicable for style: candles. Candle time-dimension width setting. (default: 60).
HasRealityCheck
Flag to indicate whether reality check is applicable for this Landing Company. 1: applicable, 0: not applicable. The Reality Check is a feature that gives a summary of the client’s trades and account balances on a regular basis throughout his session, and is a regulatory requirement for certain Landing Companies.
HideClientScheduleUnavailable
[Optional] If set to 1, adverts for which the current user’s shcedule does not have availability from now until the full possible order expiry are not returned.
HideIneligible
[Optional] If set to 1, adverts for which the current user does not meet counteryparty terms are not returned.
Id
Server unique id.
IdentityVerificationDocumentAdd
Must be 1
IncludeSpread
[Optional] 1 - Request for ask and bid rates along with the spot rate. Only available if target_currency is provided.
IsActive
[Optional] Activate or deactivate the advert.
IsBlocked
[Optional] Used to return only blocked or unblocked partners
IsDisabled
Boolean value: 1 or 0, indicating whether the account is marked as disabled or not.
IsListed
[Optional] Used to set if the advertiser’s adverts could be listed. When 0, adverts won’t be listed regardless of they are active or not. This doesn’t change the is_active of each individual advert.
IsTradingSuspended
1 indicates that trading is currently suspended, 0 if not.
IsVirtual
Boolean value: 1 or 0, indicating whether the account is a virtual-money account.
KycAuthStatus
Must be 1
LandingCompanieItem
LandingCompany
[Optional] Indicates which landing company to get a list of contracts for. If you are logged in, your account’s landing company will override this field.
LandingCompanyDetails
Landing company shortcode.
LandingCompanyShort
[Optional] If specified, will return only the underlyings for the specified landing company.
LeverageImpactTrading
How does leverage affect CFD trading?
LeverageTradingHighRiskStopLoss
Leverage trading is high-risk, so it’s a good idea to use risk management features such as stop loss. Stop loss allows you to
LifetimeValid
[Optional] Boolean value that indicates whether this document is lifetime valid (only applies to POI document types, cancels out the expiration_date given if any)
LoginHistory
Must be 1
Logout
Must be 1
Market
The short market name.
MarketType
Market type of account.
MsgType
Action name of the request made.
Mt5AccountCategory
[Optional] To choose whether account is conventional or swap_free. Unavailable for financial_stp MT5_account_type
Mt5AccountType
[Optional] Financial: Variable spreads, High leverage. Financial STP: Variable spreads, Medium Leverage, more products. If ‘account_type’ set to ‘financial’, setting ‘mt5_account_type’ is also required.
Mt5Deposit
Must be 1
Mt5GetSettings
Must be 1
Mt5LoginList
Must be 1
Mt5NewAccount
Must be 1
Mt5PasswordChange
Must be 1
Mt5PasswordCheck
Must be 1
Mt5PasswordReset
Must be 1
Mt5Withdrawal
Must be 1
Name
The name of third party platform for redirect URL.
NewAccountMaltainvest
Must be 1
NewAccountReal
Must be 1
NewAccountVirtual
Must be 1
NewPartnerAccount
Must be 1
NewTokenScopeItem
Required when create new token
NonPepDeclaration
[Optional] Indicates client’s self-declaration of not being a PEP/RCA (Politically Exposed Person/Relatives and Close Associates). Effective for real accounts only.
OauthApps
Must be 1
Official
Boolean value: 1 or 0, indicating 1 if app is an official app and 0 incase of unofficial app
P2pAdvertCreate
Must be 1
P2pAdvertInfo
Must be 1
P2pAdvertList
Must be 1
P2pAdvertUpdate
Must be 1
P2pAdvertiserAdverts
Must be 1
P2pAdvertiserCreate
Must be 1
P2pAdvertiserInfo
Must be 1
P2pAdvertiserList
Must be 1
P2pAdvertiserPaymentMethods
Must be 1
P2pAdvertiserRelations
Must be 1
P2pAdvertiserUpdate
Must be 1
P2pChatCreate
Must be 1
P2pCountryList
Must be 1
P2pOrderCancel
Must be 1
P2pOrderConfirm
Must be 1
P2pOrderCreate
Must be 1
P2pOrderDispute
Must be 1
P2pOrderInfo
Must be 1
P2pOrderList
Must be 1
P2pOrderReview
Must be 1
P2pPaymentMethods
Must be 1
P2pPing
Must be 1
P2pSettings
Must be 1
PageType
[Optional] To determine document side
PartnerAccountCreation
Must be 1
PartnerAccountCreationStatus
Must be 1
PartnerAccounts
Must be 1
PartnerSettings
Must be 1
PartnerSettingsUpdate
Must be 1
PartnerSignup
Flag which indicates whether partner signup is available in this country
PartnerType
Defines whether this partner is an individual or a company. Only applicable for partners
PasswordType
[Optional] Type of the password to reset.
PaymentMethods
Must be 1
PaymentagentCreate
Must be 1
PaymentagentDetails
Must be 1
PaymentagentTransfer
Must be 1
PaymentagentWithdraw
Must be 1
PaymentagentWithdrawJustification
Must be 1
PayoutCurrencies
Must be 1
Ping
Must be 1
Platform
Name of trading platform.
PoaStatus
Status of proof of address (POA).
PoiStatus
Status of proof of identity (POI).
Portfolio
Must be 1
Product
Product name that Deriv offer
ProductType
[Optional] The product type.
ProfitTable
Must be 1
Proposal
Must be 1
ProposalOpenContract
Must be 1
Provider
[Optional] Cashier provider.
QueryItem
Keys that you need back in response.
RateType
Type of rate, fixed or floating.
RealityCheck
Must be 1
Recommended
Flag to represent if this is server is recommended based on client’s country of residence.
RequestProfessionalStatus
[Optional] Required when client wants to be treated as professional. Applicable for financial accounts only.
RequiredInitialMargin
When would you be required to pay an initial margin?
ResidenceList
Must be 1
ResidentSelfDeclaration
[Optional] Indicates client’s self declaration for opening account under own initiative, must be 1
RiskClassification
Risk classification of the client.
RiskTolerance
Do you understand that you could potentially lose 100% of the money you use to trade?
Salutation
Accept any value in enum list.
ScopeItem
SecretQuestion
[Optional] Accept any value in enum list. Required for new account and existing client details will be used if client open another account.
SellContractForMultipleAccounts
Must be 1
SellExpired
Must be 1
Service
Service used for the current POI status.
SetAccountCurrency
1: success, 0: no change
SetFinancialAssessment
Must be 1
SetSelfExclusion
Must be 1
SetSettings
Must be 1
ShowName
[Optional] When 1, the advertiser’s real name will be displayed on to other users on adverts and orders.
SignupDevice
[Optional] Show whether user has used mobile or desktop.
Sort
[Optional] Sort direction on transaction_time. Other fields sort order is ASC.
SortBy
[Optional] How the results are sorted.
SortFieldItem
SourceOfExperience
How much knowledge and experience do you have in relation to online trading?
Statement
Must be 1
Status
Current POA status.
StatusCode
The status code of the withdrawal.
Style
[Optional] The tick-output style.
SubAccountCategory
Sub account category refer to the additional risk management
SubAccountType
Sub account type
Subscribe
[Optional] If set to 1, will send updates whenever there is an update to the order.
SupportProfessionalClient
Flag that indicates whether the landing company supports professional accounts or not
TicksBatch
Must be 1
Time
Must be 1
TinNotMandatory
Flag that indicates whether tax identifier number is not mandatory for the current country and landing company.
TinSkipped
[Optional] Whether the client has skipped the TIN form. Only applicable for real money account.
TinValidations
Must be 1
TncAcceptance
The tnc acceptance status of the user.
TncApproval
Set terms and conditions 1: success
TopupVirtual
Must be 1
TradePartners
[Optional] Get all advertisers has/had trade.
TradeRiskProfile
[Only for Snowball] The trade risk profile for the Snowball contract. Higher risk profile offers higher coupon rate at the expense of higher probability of breaching caution price
TradingDurations
Must be 1
TradingExperienceFinancialInstruments
How much experience do you have with other financial instruments?
TradingFrequencyFinancialInstruments
How many trades have you placed with other financial instruments in the past 12 months?
TradingHub
[Optional] Enable/Disable Trading Hub dashboard
TradingPlatformInvestorPasswordReset
Must be 1
TradingPlatformPasswordReset
If set to 1, the investor password has been reset.
TradingPlatformStatus
Must be 1
TradingServers
Must be 1
Transaction
Must be 1
TransferBetweenAccounts
If account_from or account_to is not provided, it just returns the available accounts.
Transfers
Type of transfers allowed between the account and the currently authorized account.
Type
The advertisement represents the intention to perform this action on your Deriv account funds.
UnsubscribeEmail
Must be 1
UpgradeLimits
[Optional] Used to upgrade daily limits of eligible advertiser.
UseClientLimits
[Optional] If set to 1, ads that exceed this account’s balance or turnover limits will not be shown.
ValidForCurrentIpOnly
[Optional] If you set this parameter during token creation, then the token created will only work for the IP address that was used to create the token
ValidTin
Indicates whether the tax identification number (TIN) is valid (1) or not (0).
VerifyEmail
1 for success (secure code has been sent to the email address)
Wallet
[Optional] Boolean value 1 or 0 indicating whether to enable/disable this feature
WalletSignup
Flag which indicates whether wallet signup is available in this country
WebsiteConfig
Must be 1
WebsiteStatus
Must be 1