> For the complete documentation index, see [llms.txt](https://docs.gobtcpay.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gobtcpay.com/api-reference.md).

# API Reference

The GoBTC Pay HTTP API is split into three surfaces, each for a different kind of integrator. All of them share the same base URL and the always-current, interactive reference:

* **Base URL:** `https://api.gobtcpay.com/public/api/v1.1`
* **OpenAPI reference:** <https://api.gobtcpay.com/api-docs>

Pick the surface that matches what you are building:

| Surface                                        | Who it's for                                                  | Authentication                            |
| ---------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------- |
| [Wallet API](/api-reference/wallet-api.md)     | Non-custodial web3 wallets accepting and paying for purchases | Bearer JWT from a key-signature challenge |
| [Merchant API](/api-reference/merchant-api.md) | The merchant dashboard / back office                          | Bearer JWT from dashboard login           |
| [POS API](/api-reference/pos-api.md)           | A point-of-sale terminal taking payments                      | Per-terminal HMAC request signature       |


---

# 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.gobtcpay.com/api-reference.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.