Quickstart Guide

Welcome

Welcome to the DotSwap API documents, where you can find all the documentation you need. If the link you currently have does not work, you can always go to https://www.dotswap.app/ to get the latest documentation address.

Examples

Every module of this documentation will provide viable examples for DotSwap's current process flow. Example execution methods include:

  • curl, which you can copy to any place that can execute curl to see the results, like the terminal in Mac.

  • Test parameters, which you can directly copy into the provided apifox documentation for online debugging. (Clicking on any document's interface will take you to the current interface's apifox documentation.)

Global

Notes

  1. The documentation will provide TypeScript interfaces. If there is a discrepancy with the Apifox parameters, the TypeScript parameters in this document will prevail.

  2. The notes in each document should cover most of the problems you might encounter, please do not ignore them.

  3. On DotSwap, all interface BTC communication units are in satoshis (0.00000001 BTC). That is, the backend returns satoshis and also receives in satoshis.

  4. The value of fee_rate must be greater than or equal to the priority level in the BTC Mempool. Access Mempool's fee rate interface 👉 here

All examples provided in this document are for the test environment.

Last updated