Skip to main content

Quick Start

Create API Key​

Before using the API, you need to create an API key in the BYDOXE platform.

  1. Log in to BYDOXE
  2. Navigate to API Management in your account settings
  3. Click Create API Key
  4. Set the API key permissions and IP whitelist (recommended)
  5. Enter your passphrase and save your credentials securely
Important
  • SecretKey is randomly generated by the system and used for signature generation
  • Passphrase is set by you when creating the API key
  • If you forget the Passphrase, it cannot be retrieved and you must recreate the API key
  • DO NOT disclose SecretKey and Passphrase to anyone

Interface Types​

Public Interface​

The public interface can be used to obtain configuration information and market data. Public requests can be used without authentication.

Private Interface​

The private interface can be used for order management and account management. Every private request must be signed using API credentials.