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. Lookup addresses of tokens you want to swap, for example ‘0xxx’ , ‘0xxxx’ for USDC -> METIS

2. Check for allowance and if necessary give approval for HeraAggregatorV2 contract to spend token (/allowance)

3. Monitor the best exchange route using (/quote)

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

Check for allowance and if necessary give approval for Hera Aggregator contract to spend token.

GEThttps://pathfindersdk.hera.finance/allowance

Query parameters

Response

200400

Transaction body to allow the swap with the Hera Aggregator router

Body

application/json

status*boolean

allowance*integer

Allowance amount or zero, if amount is 0 need to give approve to contract

txobject

Request

JavaScriptCurlPython

const response = await fetch('https://pathfindersdk.hera.finance/allowance?account=text&amount=text&tokenInAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "status": false,
  "tx": {
    "to": "text",
    "data": "text"
  }
}

// Example Query:

GET https://pathfindersdk.hera.finance/allowance?account=0x0000000000000000000000000000000000000000&amount=1000000&tokenInAddress=0xEA32A96608495e54156Ae48931A7c20f0dcc1a21

Quote (Pathfinder)

Find the best quote to swap via Hera Aggregator router

GEThttps://pathfindersdk.hera.finance/quote

Query parameters

Response

200400

Quote

Body

application/json

blockNumber*integer

maxReturnResult*object

directResult*object

fromTokenAddress*string

fromTokenAmount*string

toTokenAddress*string

toTokenAmount*string

Request

JavaScriptCurlPython

const response = await fetch('https://pathfindersdk.hera.finance/quote?account=text&tokenInAddress=text&tokenOutAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "maxReturnResult": {
    "fromTokenAmount": "text",
    "fromTokenAmountNumber": 0,
    "toTokenAmount": "text",
    "toTokenAmountNumber": 0,
    "toTokenNativeAmount": "text",
    "gasUnitsConsumed": "text",
    "routes": [
      {
        "amount": "text",
        "amountOut": "text",
        "subRoutes": [
          {
            "amount": "text",
            "amountOut": "text",
            "paths": [
              {
                "fromTokenAddress": "text",
                "toTokenAddress": "text",
                "meta": {
                  "fromTokenAddress": "text",
                  "toTokenAddress": "text",
                  "pairAddress": "text",
                  "routerAddress": "text",
                  "fromAmount": "text",
                  "toTokenAmount": "text"
                },
                "market": {
                  "id": "text",
                  "name": "text"
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "directResult": {
    "amm": "text",
    "route": [
      "0xEA32A96608495e54156Ae48931A7c20f0dcc1a21"
    ]
  },
  "fromTokenAddress": "text",
  "fromTokenAmount": "text",
  "toTokenAddress": "text",
  "toTokenAmount": "text"
}

// Example Query:

GET https://pathfindersdk.hera.finance/quote?account=0x0000000000000000000000000000000000000000&tokenInAddress=0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000&tokenInChainId=1088&tokenOutAddress=0xEA32A96608495e54156Ae48931A7c20f0dcc1a21&tokenOutChainId=1088&amount=100000000000000000000&type=exactIn

Swap

When you ready use to perform swap

GEThttps://pathfindersdk.hera.finance/swap

Query parameters

Response

200400

Swap

Body

application/json

blockNumber*integer

fromTokenAddress*string

fromTokenAmount*string

fromTokenAmountNumbernumber

toTokenAddress*string

toTokenAmount*string

toTokenAmountNumbernumber

tx*object

Request

JavaScriptCurlPython

const response = await fetch('https://pathfindersdk.hera.finance/swap?account=text&tokenInAddress=text&tokenOutAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "fromTokenAddress": "text",
  "fromTokenAmount": "text",
  "fromTokenAmountNumber": 0,
  "toTokenAddress": "text",
  "toTokenAmount": "text",
  "toTokenAmountNumber": 0,
  "tx": {
    "data": "text",
    "gasPrice": "text",
    "gas": "text",
    "value": "text",
    "to": "text"
  }
}

// Example Query:

GET https://pathfindersdk.hera.finance/swap?account=0x0000000000000000000000000000000000000000&tokenInAddress=0xDeadDeAddeAddEAddeadDEaDDEAdDeaDDeAD0000&tokenInChainId=1088&tokenOutAddress=0xEA32A96608495e54156Ae48931A7c20f0dcc1a21&tokenOutChainId=1088&amount=100000000000000000000