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

# REST API Reference

**Preferred base URL (mainnet):**

```
https://bridgeapi.onyx.org/api/v1
```

**Legacy dual-serve alias (same API, no redirect):**

```
https://bridge.goliath.net/api/v1
```

| Method and path                                | Purpose                                                             |
| ---------------------------------------------- | ------------------------------------------------------------------- |
| `GET /health`                                  | Operational state and chain connectivity                            |
| `GET /bridge/limits`                           | Current fee basis points, minimum amounts, and minimum fees         |
| `GET /bridge/fee-quote`                        | Quote the current output and fee for a direction, token, and amount |
| `GET /bridge/status`                           | Track an operation by origin transaction hash or bridge identifier  |
| `GET /bridge/history`                          | Retrieve wallet bridge history                                      |
| `POST /bridge/xcn-withdraw-intent`             | Register a signed native-XCN withdrawal intent                      |
| `POST /bridge/xcn-withdraw-intent/bind-origin` | Bind an intent to its Onyx execution transaction                    |

The exact request and response schemas are deployed behavior. Inspect responses in a non-production client and handle unknown fields or statuses defensively.

## Live discovery example

```bash
curl -sS https://bridgeapi.onyx.org/api/v1/bridge/limits | jq .
curl -sS https://bridgeapi.onyx.org/api/v1/health | jq '{status,operational,database}'
```

Never copy the returned fee or minimum into a long-lived build. Fetch again before a user confirms a transfer.

## Status handling

Continue polling while the operation is non-terminal. Display the API's maintenance, confirmation, hold, retry, failure, and completion state without manufacturing a destination hash. A completed operation should include the destination proof expected by your integration before you credit or reconcile it.

The native-XCN intent response contains the current transfer destination. It is an operator-controlled value and must not appear as a constant in application code or documentation.


---

# 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.onyx.org/developer-guide/bridge/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.