Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openxswitch.com/llms.txt

Use this file to discover all available pages before exploring further.

​
How to get started:

  1. Navigate to: the Accounts > API Management on OpenXSwitch Console.
  2. Click on Create API Key
  3. Select the appropriate access rights and permissions based on the specific API calls you intend to make (e.g., withdrawal, trade, read , …).
  4. Enable IP Restrictions (Optional but Recommended)
  5. Enable IP restrictions and specify up to 5 trusted IPs. This limits API access to those IPs only, enhancing security.
  6. Click the Generate API key button to generate new key for your workspace.
🚧 API Management can only be accessed by: Owner and Admin role only.

​
How to authenticate using API Key

To interact with OpenXSwitch APIs securely, authentication is required using a Bearer Token. This token is your API Key, which must be included in the Authorization header of each request.

​
Authentication Format

Every request to OpenXSwitch APIs must include the following header: 
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Replace YOUR_API_KEY with the actual API key generated in API Management.

​
Example Requests

  1. Create Sub-wallet
    Create sub-wallet using an authenticated API request.
Request 
curl -X POST "https://api.openxswitch.com/v1/sub-wallet/create" \  
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "email": "admin@openxswitch.com",
  "name": "openxswitch"
}'

  1. Generate Wallet Address
    Generate or fetch wallet address using an authenticated API request.
curl -X POST "https://api.openxswitch.com/v1/sub-wallet/address" \  
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "subWalletId": "3224333.....",
  "coin": "ETH",
  "chain": "ETH"
}'

📘 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.