REST API
The Synapse REST API is a read-only API that allows you to integrate the Synapse liquidity network into your application.
Through HTTP requests, developers can integrate Synapse cross-chain tokens and liquidity transfers dynamically into their applications. Developers can retrieve quotes, as well as generate the relevant call data for Synapse Bridges and Swaps. Example requests can be found below in the API-docs section.
The Synapse REST API is built on top of the Synapse Bridge SDK.
The API is available at https://api.synapseprotocol.com/.
API-docs
api.synapseprotocol.com/api-docs
Note: The OpenAPI 3.0 specification is available at https://api.synapseprotocol.com/openapi.json for client generation.
Previous versions
| Date | Description |
|---|---|
| 2024‑10‑01 | https://synapse-rest-api-v2.herokuapp.com/ is no longer maintained and has been fully deprecated as of October 2024. |
| 2024‑11‑19 | https://api.synapseprotocol.com/ the /bridgeTxInfo endpoint has been consolidated into the /bridge endpoint, which now returns call data |
| 2024‑12‑12 | https://api.synapseprotocol.com/ the /bridge endpoint now requires both originUserAddress and destAddress to generate call data. |
Support
Please read the documentation and examples carefully before reaching out on Discord for questions.