Skip to main content

API Key Usage

All API requests must include your API key in the Authorization header as a Bearer token.

Required Header

Replace YOUR_API_KEY with the key generated from your OpenXSwitch Console.

API Key Setup

  1. Navigate to Account → API Management in the OpenXSwitch Console
  2. Click Create API Key
  3. Select required permissions (e.g. wallet, withdrawal, trading, read access)
  4. (Optional but recommended) Enable IP Restrictions
    • Add up to 5 trusted IP addresses
    • Requests from other IPs will be rejected
  5. Click Generate API Key
⚠️ API Management is restricted to Owner and Admin roles only.

Example Requests

  1. Create a User
    Create a new user using an authenticated API request.
Request
📘 For further details on API permission, refer to the API permissions documentation

Security Best Practices

  • Keep Your API Key Secret: Never share your API key in public code or repositories.
  • Use IP Restrictions: Limit API access to specific trusted IPs.
  • Grant Minimum Necessary Permissions: Select only the required access rights for your API key (e.g., withdrawal, trade, wallet management) to minimize security risks.
  • Rotate API Keys Regularly: To reduce the risk of compromised credentials.
  • Monitor API Usage: Regularly review API logs and activity to detect any unauthorized access or unusual behavior.