🛠
Symbiosis API
Symbiosis API | Symbiosis Finance | Swagger

Functionalities

We are happy to introduce the Symbiosis API that facilitates the integration of your application/protocol with the Symbiosis Protocol.
Enable decentralized cross-chain swaps and cross-chain liquidity managing for your users quickly and effectively by integrating the Symbiosis API right here and right now.
The Symbiosis API allows you to perform functionalities as follows:

Supported blockchains and tokens

Using the Symbiosis API you can exchange any token existed on the blockchains supported by the Symbiosis Protocol. We do not have any restrictions on the tokens to exchange. You may consider composing your own list of supported tokens if you need it.
Values such as chain IDs for the supported blockchains are listed in the following configurations for the Symbiosis JS SDK:

Endpoints

Endpoint
Description
/health-check
It returns the health of the API: 200 if everything is up and running.
/v1/revert
The reverting transaction should be sent from the address that was specified as the address eligible for the reverting operation (revertableAddress) in the origin (stuck) transaction. Explanation of emergencies
/v1/stucked/{address}
It returns a list of stuck cross-chain operations (swapping, bridging, zapping, interchain communicating) for the specified address from all blockchains supported by the Symbiosis protocol. Explanation of emergencies
/v1/tx/{chainId}/{transactionHash}
It returns the status of the origin transaction specified by the blockchain ID and transaction hash. The origin transaction means the transaction sent to the origin blockchain. The possible statuses: - Not found, - Pending, - Success (in this case, the answer contains as well the destination chain ID and the hash of the transaction on the destination chain), - Stucked, - Reverted
/v1/swapping/exact_in
It returns a calldata to perform a cross-chain swap. Explanation of cross-chain swapping
/v1/bridging/exact_in
It returns a calldata to perform a bridging operation. Explanation of bridging
/v1/zapping/exact_in
It returns a calldata to perform a cross-chain Zap. A cross-chain Zap consists of a cross-chain swap and a consequent addition of the destination token to a liquidity pool owned by Symbiosis. Explanation of cross-chain zapping
/v1/zapping/aave/exact_in
It returns a calldata to perform an interchain communicating operation to the AAVE protocol. An interchain communicating operation to the AAVE protocol consists of a cross-chain swap and a consequent addition of the destination token to the AAVE protocol. Explanation of interchain communicating
/v1/zapping/cream/exact_in
It returns a calldata to perform an interchain communicating operation to the C.R.E.A.M. protocol. An interchain communicating operation to the C.R.E.A.M. protocol consists of a cross-chain swap and a consequent addition of the destination token to the C.R.E.A.M. protocol. Explanation of interchain communicating
/v1/zapping/benqi/exact_in
It returns a calldata to perform an interchain communicating operation to the BENQI protocol. An interchain communicating operation to the BENQI protocol consists of a cross-chain swap and a consequent addition of the destination token to the BENQI protocol. Explanation of interchain communicating
/v1/zapping/beefy/exact_in
It returns a calldata to perform an interchain communicating operation to the Beefy protocol. An interchain communicating operation to the Beefy protocol consists of a cross-chain swap and a consequent addition of the destination token to the Beefy protocol. Explanation of interchain communicating

Swagger

Examples

The swagger of the Symbiosis API contains examples of using every endpoint. Just scroll down to the endpoint you are interested in, enter the needed data or select it from the preset data and run an example.
For example, there are preset token pairs for cross-chain swapping: