REST API Reference

Public bridge REST endpoints and dynamic discovery rules.

Base URL (mainnet):

https://bridgeapi.onyx.org/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

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.