API Key Usage
All API requests must include your API key in theAuthorization header as a Bearer token.
Required Header
YOUR_API_KEY with the key generated from your OpenXSwitch Console.
API Key Setup
- Navigate to Account → API Management in the OpenXSwitch Console
- Click Create API Key
- Select required permissions (e.g. wallet, withdrawal, trading, read access)
- (Optional but recommended) Enable IP Restrictions
- Add up to 5 trusted IP addresses
- Requests from other IPs will be rejected
- Click Generate API Key
⚠️ API Management is restricted to Owner and Admin roles only.
Example Requests
- Create a User
Create a new user using an authenticated API 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.
.png?fit=max&auto=format&n=ML35RDblT1Ol-zJb&q=85&s=062e79ad9c4540929eec204aff020178)
.png?fit=max&auto=format&n=ML35RDblT1Ol-zJb&q=85&s=f6328956931c9664a2a070c2edb6e9b3)