Skip to main content

Getting Started

This guide walks you through the full integration flow: from registering in the Partner Dashboard and generating an API key, to fetching currencies and pairs, validating limits, requesting estimates, creating an exchange, and tracking its progress.

1. Create a Partner Account and Get an API Key​

  1. Sign up as a partner and log in to the Partner Dashboard.
  2. Navigate to the API / Integrations section (the exact name may vary).
  3. Create a new API key in the Partner Dashboard. Store the key securely (treat it like a password).
  4. In the API key settings within the Partner Dashboard, you can also configure a partner commission. The partner commission is the percentage of each completed exchange that will be credited to the partner as a reward.

Keep your API key secure and do not share it publicly. If your key is compromised, regenerate it in the Partner Dashboard.

2. Base Concepts​

2.1. Currency Identifier​

Many API methods identify a currency using a composite key:

  • ticker — the currency symbol (e.g., btc, eth, usdt)
  • network — the network the currency belongs to (e.g., btc, bsc, sol)

A currency is uniquely identified by the combination of its ticker and network:

  • btc:btc
  • eth:bsc
  • usdt:sol

2.2. Fixed vs Floating rate​

Some endpoints accept a boolean parameter fixed:

  • true — fixed-rate flow
  • false — floating-rate flow

2.3. Reverse amount​

Some endpoints accept a boolean parameter reverse:

  • false — amount means send amount (input)
  • true — amount means receive amount (output)

This lets you request an estimate or create an exchange based on the amount the user wants to receive.

3. Typical Integration Flow Overview​

A common happy-path flow looks like this:

  1. Fetch supported currencies
  2. Fetch available pairs
  3. Check limits (ranges) for the chosen pair
  4. Request an estimate (optionally fixed-rate)
  5. Create an exchange
  6. Track exchange status until completion

4. Suggested Caching Strategy​

To reduce load and improve UI responsiveness:

  • Currencies: cache for minutes (refresh periodically)
  • All Pairs: cache for at least 1 minute (do not request more often)
  • Ranges: cache briefly; refresh if user changes pair or after some time
  • Estimate: do not cache long; refresh when amount/pair changes
  • Exchange status: poll with backoff until final state

5. Troubleshooting Tips​

Validate min/max limits before estimating or creating an exchange.
For fixed-rate flows, always use the rateId returned by the estimate endpoint.
If a fiat exchange returns redirectUrl, the user must be redirected to complete the payment flow.