Links

Swagger API

EmporiaSDK Swagger API - v1.1
Datasets providing access to the SDK have not been updated for a long time. Please note that the SDK may not function properly until the completion of the V3 upgrade!

Hera Dex Aggregator - Swap Protocol API

Metis Mainnet Release

Using Hera Aggregation protocol API, you can find the best route to exchange assets and make the exchange. Progressing:
  1. 1.
    Lookup addresses of tokens you want to swap, for example ‘0xxx’ , ‘0xxxx’ for USDC -> METIS
  2. 2.
    Check for allowance and if necessary give approval for HeraAggregatorV2 contract to spend token (/allowance)
  3. 3.
    Monitor the best exchange route using (/quote)
  4. 4.
    When you ready use to perform swap (/swap)
EmporiaSDK is now available on Metis Mainnet. Other chains are coming soon!
Built with OpenAPI & Swagger!
Design, describe, and document your API on the first open source editor supporting multiple API specifications and serialization formats. The Swagger Editor offers an easy way to get started with the OpenAPI Specification (formerly known as Swagger) as well as the AsyncAPI specification, with support for Swagger 2.0, OpenAPI 3.0, and AsyncAPI 2.* versions.

Swagger Paths:

Allowance

get
https://pathfindersdk.hera.finance
/allowance
Check for allowance and if necessary give approval for Hera Aggregator contract to spend token.
Parameters
Query
account*
string
Your wallet address
amount*
string
The number of tokens that the Hera Aggregator router is allowed to spend. If not specified, it will be allowed to spend an infinite amount of tokens.
tokenInAddress*
string
Token address you want to swap
Responses
200: OK
Transaction body to allow the swap with the Hera Aggregator router
400: Bad Request
Error details
// Example Query:
GET https://pathfindersdk.hera.finance/allowance?account=0x0000000000000000000000000000000000000000&amount=1000000&tokenInAddress=0xEA32A96608495e54156Ae48931A7c20f0dcc1a21

Quote (Pathfinder)

get
https://pathfindersdk.hera.finance
/quote
Find the best quote to swap via Hera Aggregator router
Parameters
Query
account*
string
Your wallet address
amount*
integer
tokenInAddress*
string
from token
tokenInChainId*
integer
tokenOutAddress*
string
to token
tokenOutChainId
integer
Responses
200: OK
Quote
400: Bad Request
One of the following errors: "Insufficient liquidity", "Cannot estimate", "You may not have enough METIS balance for gas fee", "tokenInAddress cannot be equals to tokenOutAddress", "Cannot estimate. Don't forget about miner fee. Try to leave the buffer of METIS for gas", "Not enough balance", "Not enough allowance"
// Example Query:
GET https://pathfindersdk.hera.finance/quote?account=0x0000000000000000000000000000000000000000&tokenInAddress=0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000&tokenInChainId=1088&tokenOutAddress=0xEA32A96608495e54156Ae48931A7c20f0dcc1a21&tokenOutChainId=1088&amount=100000000000000000000&type=exactIn

Swap

get
https://pathfindersdk.hera.finance
/swap
When you ready use to perform swap
Parameters
Query
account*
string
Your wallet address
dstAccount
string
Recipient address ( if dstAccount is left blank, dstAccount = account )
amount*
integer
tokenInAddress*
string
from token
tokenOutAddress*
string
to token
slippage
number
While HeraGuard is active, the slippage rate is set to 0% and will protect you from front-running. However, if this feature is active, your transaction may fail due to price fluctuations during processing. Min: 0% and Max: 50% - !! Default slippage: 0% !!
deadline
integer
Default deadline: ~20min
Responses
200: OK
Swap
400: Bad Request
One of the following errors: "Insufficient liquidity", "Cannot estimate", "You may not have enough METIS balance for gas fee", "tokenInAddress cannot be equals to tokenOutAddress", "Cannot estimate. Don't forget about miner fee. Try to leave the buffer of METIS for gas", "Not enough balance", "Not enough allowance"
// Example Query:
GET https://pathfindersdk.hera.finance/swap?account=0x0000000000000000000000000000000000000000&tokenInAddress=0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000&tokenInChainId=1088&tokenOutAddress=0xEA32A96608495e54156Ae48931A7c20f0dcc1a21&tokenOutChainId=1088&amount=100000000000000000000