Getting Started

Welcome to the Deriv Core API documentation!

This guide provides everything you need to integrate core services, from user authentication to currency exchange rates and global data access, deposits and withdrawal, wallets and much more.

Overview

The core API is designed for businesses and developers looking to integrate currency exchange, secure user authentication, profile management, and financial functionalities directly into their platforms.

Key Features

Easy Authentication: Secure Login and Verification methods to authenticate users .

Client Account Management: Create, Manage Profile, and view Client details .

Currency Conversion: Get real-time Exchange Rates rates and perform conversions .

Country Information: Access data on supported Countries Rules, including Currencies, Locations, and available Platforms .

Cahier: Perform Deposits, convininet Withdrawl of funds and manage your Wallets .

Sign up and Verify to obtain an API key.
The API key is your unique identifier and will authenticate your requests.

Errors

Core uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Cores’s servers (these are rare).

HTTP Status Code	Status	Description
200	OK	Everything worked as expected.
400	Bad Request	The request was unacceptable, often due to missing a required parameter.
401	Unauthorized	No valid API key provided.
402	Request Failed	The parameters were valid but the request failed.
403	Forbidden	The API key doesn’t have permissions to perform the request.
404	Not Found	The requested resource doesn’t exist.
409	Conflict	The request conflicts with another request (perhaps due to using the same idempotent key).
429	Too Many Requests	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504	Server Errors	Something went wrong on the server’s end. (These are rare.)

Data Attributes

code
nullable string
For some errors that could be handled programmatically, a short string indicating the error code reported.

error_code
nullable string
A short string indicating the reason for the decline.

message
nullable string
A human-readable message providing more details about the error. For request errors, these messages can be shown to users.

Meta Attributes

endpoint
string
The API endpoint that was used for this request.

method
string
The HTTP method used for the request.

timing
integer
The time it took to process the request, in milliseconds.

Also checkout champion trader!

Deriv Core API Documentation

Getting Started #

Overview#

Key Features#

Errors#

Getting Started

Overview

Key Features

Errors