Utilities APIs
Utilities APIs provide essential information and utility functions for the platform’s operations. They offer functionalities for retrieving economic calendar events, managing real-time message streams, and accessing details about landing companies and server statuses.
Additionally, these APIs include utility features like server time, ping requests, and country/state lists for account management.
These APIs ensure smooth platform operations and deliver up-to-date trading and account management information.
# | API Name | Description | Send | Subscribe | Scope |
---|---|---|---|---|---|
1 | Economic Calendar | Retrieve a list of economic events for a specific currency. If no currency is specified, the list includes all currencies. | ✔ | ✘ | NA |
2 | Forget | Immediately cancels the real-time stream of messages with a specific ID. | ✔ | ✘ | NA |
3 | Forget All | Immediately cancels all real-time streams of messages of a given type. | ✔ | ✘ | NA |
4 | Landing Company | Retrieve the appropriate landing company based on the client’s country. Different landing companies may be returned for derived contracts (e.g., Synthetic Indices) and financial contracts (e.g., Forex, Stock Indices, Commodities). | ✔ | ✘ | NA |
5 | Landing Company Details | Provides information about each landing company, which are licensed subsidiaries of the Deriv Group. | ✔ | ✘ | NA |
6 | Ping | Sends a ping request to the server, mainly used to test the connection or to keep it alive. | ✔ | ✘ | NA |
7 | Countries List | Retrieve a list of countries and their two-letter codes, suitable for populating the account opening form. | ✔ | ✘ | NA |
8 | States List | Retrieve the list of servers available for the trading platform. | ✔ | ✘ | NA |
9 | Server Time | Requests the back-end server epoch time. | ✔ | ✘ | NA |
10 | Server List | Retrieves a list of servers for a trading platform. | ✔ | ✘ | Read |
11 | Trading Times | Retrieve market opening times for a specified date. | ✔ | ✘ | NA |
12 | Server Status | Requests the server status. | ✔ | ✘ | NA |
Updated 11 days ago