Guides

Account setup

This section will guide you through creating your Deriv account and seamlessly registering your application.

Create a Deriv account

  1. Visit https://api.deriv.com/
  2. Click Sign Up on the top right corner of the page.
  3. Provide your Email Address, create a strong Password, and select your Country.
  4. Check your inbox for a verification email and click the link to confirm your account.
  5. Log in after verification and add additional information, such as your Full Name, Date of Birth, and Phone Number, to complete your profile.

πŸ“˜

Tips:

  1. Never share the token publicly
  2. You can revoke or delete tokens anytime in the Manage Tokens tab.
  3. You can also create API tokens directly through the Deriv API using OAuth2. This method is useful for scripts or applications that create programmatic tokens.

Register your Deriv application

  1. Open the Dashboard and select the Register Application tab.
  2. Choose the API Token you want to use.
  3. Provide a Name for your application.
  4. Add the Markup fee.

    πŸ“˜

    Note:

    Markup is the commission added to the trade price to earn additional income. More details on markup calculation are available here.

  5. Fill in OAuth details:
    1. Redirect URL: This URL enables your users to log in to your app using their Deriv accounts without an API token.
    2. Verification URL: Used for email verification. If provided, the URL with the verification token is sent to the user’s email; otherwise, the Redirect URL is used.
      For example, if your domain is <https://example.com>and your authorisation and authentication are handled by verfiy, your URLs will be:
      https://example.com/verify
  6. Select the authorization scope and click Create.

Your app will now be available under the Manage Applications tab.

Create a Deriv API token

  1. Go to your account settings.
  2. Click API Token on the left pane.
  3. Choose the desired access level (scopes):
    1. Read: Allows reading market data and account info, but not trading.
    2. Trade: Grants full access to trade and manage funds and sensitive data.
    3. Payments: Allows withdrawal to payment agents and makes inter-account transfers.
    4. Trading Information: Allows reading trading history.
    5. Admin: Allows opening accounts, managing settings and token usage, and more.

      ❗️

      Not Recommended

      Admin Scope provides extensive access to all account functions, making it potentially dangerous if misused. Only select this option if absolutely necessary and ensure the token is handled securely.

  4. Enter a descriptive name for the token
  5. Click Create to generate the token
  6. You can find the token listed below.