API Reference
Start typing to search…

Developer Quickstart

OpenXSwitch - A step-by-step guide to help you generate an API key, set up webhooks, fetch supported coins and chains, test in sandbox, and go live with OpenXSwitch.

Follow these steps to begin your integration with OpenXSwitch:


1. Obtain Your API Key

  • Log in to your Dashboard
  • Go to API Keys
  • Create and copy your API key — this is required for all requests

⚠️ Important:

  • You need to create separate API keys for sandbox and live environments.
  • Sandbox API keys will only work with sandbox endpoints.

2. Set Up Webhooks

Webhooks let you receive real-time updates on deposits, withdrawals, and trades.

  • In your Dashboard, navigate to Webhooks
  • Add your webhook URL
  • Test it with sandbox events

👉 See Webhook Setup for more details.

3. Fetch Rechargeable Currencies

The first step in working with our API is to fetch the list of supported rechargeable currencies

  • Each currency (coin) has a chains array.
  • Coin = Asset (e.g., USDT)
  • Chain = Network the coin runs on (e.g., ERC20, TRC20, BEP20)

✅ You’ll use this coin + chain information in other endpoints such as deposits, withdrawals, and instant-swap.

4. Sandbox Environment

Use the sandbox for all testing:

https://api.openxswitch.com/v1/sandbox/...

Here you can simulate deposits, withdrawals, instant-swap, and transfers.

⚠️ Important Note on Trial/Sandbox Dashboard Access

When using the dashboard in trial mode (sandbox access):

  • You cannot generate real deposit addresses, make transfers, or deposit funds through the dashboard.
  • You can only perform sandbox testing via the API.
  • All other dashboard services remain available, except Wallet-as-a-Service (WaaS) features.

5. Instant Swap/Trading Access

If you plan to use Instant Swap/Trading APIs, you’ll first need to activate a wallet for trading. 👉 See Trading Wallet Activation

6. Go Live 🚀

When ready for production:

  • Generate a Live API key in your dashboard (sandbox keys will not work in live).

  • Simply remove /sandbox/ from the URL

  • Example:

    • Sandbox → https://api.openxswitch.com/v1/sandbox/...
    • Live → https://api.openxswitch.com/v1/...

7. Asset Icons (CDN)

Use our CDN service to display asset icons or SVGs in your app

https://cdn.openxswitch.com/public/logos/svg/{coin}.svg

Example:

https://cdn.openxswitch.com/public/logos/svg/usdc.svg

Next Step

If you haven’t onboarded yet: