Skip to main content

Quickstart

The whole process consists of:
1

Authentication

Get a JWT to authenticate your requests.
2

Fetching bridge configs

Retrieve supported chains and tokens.
3

Getting a bridge quote

Obtain transaction details, including fees.
4

Committing the quote

Confirm the transaction.
5

Executing the bridge transaction

Interact with the smart contract to complete the transfer.

1. Authentication

All non-public API endpoints are authenticated using a JSON Web Token. To authenticate your requests, include the token in the Authorization header. Learn about API authentication.

2. Fetch Bridge Configs

Retrieve available chains and supported tokens to ensure your transaction uses the correct parameters.
getBridgeConfigs.js
For the exact response format and more details, see the API Reference.

3. Get a Bridge Quote

Before executing a bridge transaction, you must generate a quote that provides transaction details, including fees and amounts.
getBridgeUserQuote.js
For the exact request / response format and more details, see the API Reference.

4. Commit the Quote

Once you have a quote, you must commit it to confirm the transaction before execution. The deadline to commit a quote is provided within the expiresAt param within the quote response.
commitBridgeUserQuote.js
For the exact request / response format and more details, see the API Reference.

5. Execute the Bridge Transaction

Now, you can execute the bridge transaction by interacting with the smart contract. See examples for interacting with the bridge smart contracts across different blockchain environments.

6. Full Example

Here’s the complete implementation combining all the steps above:
index.js
For a detailed breakdown of API endpoints and parameters, check the API Reference.

Next steps

For the smart contract integration see - contract examples To track your bridge transaction status, see Bridge Status & History.