> For the complete documentation index, see [llms.txt](https://docs.unisat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.unisat.io/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap.md).

# BRC20-Swap

The API for brc20-swap requires the corresponding permissions to be granted before access is allowed. If you are interested in brc20-swap, please contact us to apply for access.

\
\
Currently, this set of APIs is consistent with the interface used by <https://unisat.io/swap>. If you are unsure about how it works, you can refer to the login website and experience it.

{% content-ref url="/pages/lCcvfip4ZrMla8BT7npT" %}
[Get Global Config](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-global-config.md)
{% endcontent-ref %}

{% content-ref url="/pages/TZgjKQBdFLb3yIGXKGK1" %}
[Get Address Balance](/developer-support/open-api-documentation/api-for-bitcoin/general/addresses/get-address-balance.md)
{% endcontent-ref %}

{% content-ref url="/pages/R2Y4rWktDCZR56ALILXA" %}
[Get Deposit Info](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-deposit-info.md)
{% endcontent-ref %}

{% content-ref url="/pages/JXHp5OAmEt9pmtDka8ih" %}
[Get Address All Ticker](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-address-all-ticker.md)
{% endcontent-ref %}

{% content-ref url="/pages/r0mhxccMU3DwLhzyfOdO" %}
[Deploy Pool](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/deploy-pool.md)
{% endcontent-ref %}

{% content-ref url="/pages/lCHWTqPSo54ZAgWJ9UQJ" %}
[Add Liq](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/add-liq.md)
{% endcontent-ref %}

{% content-ref url="/pages/ucGdMVMg7rr2jMXNnqcr" %}
[Remove Liq](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/remove-liq.md)
{% endcontent-ref %}

{% content-ref url="/pages/9HLCgIEUkhgKWM4ZxtfT" %}
[Swap](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/swap.md)
{% endcontent-ref %}

{% content-ref url="/pages/bQQSQYVaaPiFW9yvJJad" %}
[Get All Pool List](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-all-pool-list.md)
{% endcontent-ref %}

{% content-ref url="/pages/4Z2BQl56HbqtcVjBsKLs" %}
[Get My Pool List](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-my-pool-list.md)
{% endcontent-ref %}

{% content-ref url="/pages/lk1K6ZKaEdqdHjIlC95G" %}
[Get Overview](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-overview.md)
{% endcontent-ref %}

{% content-ref url="/pages/8zWcPh4QGlzq6uowWiKQ" %}
[Get Gas History](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-gas-history.md)
{% endcontent-ref %}

{% content-ref url="/pages/wd4fCU5kNITIDzMkji2s" %}
[Get Liq History](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-liq-history.md)
{% endcontent-ref %}

{% content-ref url="/pages/CZ5ostK7drGW1jyIltwY" %}
[Get Swap History](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-swap-history.md)
{% endcontent-ref %}

{% content-ref url="/pages/VPPCN9ElMDafwfElXbWH" %}
[Get Rollup History](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-rollup-history.md)
{% endcontent-ref %}

{% content-ref url="/pages/gXskM0EXCHXrkxYxdMAl" %}
[Get Deposit List](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-deposit-list.md)
{% endcontent-ref %}

{% content-ref url="/pages/LSspHrZLoAuKua5vTKt8" %}
[Deposit](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/deposit.md)
{% endcontent-ref %}

{% content-ref url="/pages/RbnTsSCKJTVp4ePJsa0T" %}
[Withdraw](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/withdraw.md)
{% endcontent-ref %}

{% content-ref url="/pages/mCrVaNevuCkQK30B8Ont" %}
[Cancel Withdraw](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/cancel-withdraw.md)
{% endcontent-ref %}

{% content-ref url="/pages/HdXAnwLtKMeBSpoxhGJq" %}
[Get Withdraw Process](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-withdraw-process.md)
{% endcontent-ref %}

{% content-ref url="/pages/8fBPNIPFlGeaM84LdGMy" %}
[Get Withdraw History](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-withdraw-history.md)
{% endcontent-ref %}

{% content-ref url="/pages/Iocy6pbUA1cIMWVPCoFD" %}
[Get System Status](/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap/get-system-status.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.unisat.io/developer-support/open-api-documentation/api-for-bitcoin/brc20-swap.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.