Swagger

This endpoint provides estimates for all integrated dexes based on profit

This endpoint retrieves a list of decentralized exchanges (dexes) where the selected pair can be swapped. The list is sorted by profit, so we recommend choosing the first dex in the list.

GET/api/v1/swap/estimate-all

Authorization

Query parameters

Response

Body

successfulEstimationsList*array of EstimatedTradeDto (object)

Request

const response = await fetch('/api/v1/swap/estimate-all', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "successfulEstimationsList": [
    {
      "swapName": "text",
      "delegatedDex": "text",
      "fromToken": "text",
      "fromTokenPrice": "text",
      "toToken": "text",
      "toTokenPrice": "text",
      "amountIn": "text",
      "amountOut": "text",
      "minAmountOut": "text",
      "route": "text",
      "reserves": [
        "text"
      ],
      "priceImpact": "text",
      "poolInfo": "text",
      "swapFee": "text",
      "networkFee": "text",
      "gasPrice": "text",
      "currentDexFeePercentage": "text",
      "crowdswapFeePercentage": "text",
      "swapFeeInUSDT": "text",
      "networkFeeInUSDT": "text",
      "crowdswapFeeInUSDT": "text",
      "totalFeeInUSDT": "text",
      "pricePerToken": "number",
      "cost": "number",
      "totalPaidInUSDT": "text",
      "totalIncomeInUSDT": "text",
      "amountOutInUSDT": "text",
      "amountInInUSDT": "text",
      "amountOutPerAmountInRatio": "text",
      "amountInPerAmountOutRatio": "text",
      "approveAddress": "text",
      "tradeType": "number",
      "trade": {}
    }
  ]
}

This endpoint returns the data for a swap transaction

This endpoint returns from, to, data, value, and gasLimit, all of which needed for executing a swap transaction

A dex name must be added to the url. The dex name can be found in estimation e.g CrowdSwapV2, Quickswap

GET/api/v1/swap/{dex}

Authorization

Path parameters

dex*string

The dex name which will be used for the swap transaction. This value is available in the estimation result as swapName

Query parameters

Response

Body

from*string

User address who submits input tokens for a swap

to*string

swap Contract address

data*string

populated transaction

value*string

transaction value

gasLimit*string

transaction gas limit

Request

const response = await fetch('/api/v1/swap/{dex}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "from": "text",
  "to": "text",
  "data": "text",
  "value": "text",
  "gasLimit": "text"
}

This endpoint returns the estimation of a cross-chain swap

This endpoint finds a route with the potentially best possible outcome for the requested cross-chain pair and returns an estimation.

GET/api/v1/crossChainSwap/estimate-all

Authorization

Query parameters

Response

Body

crossChainName*string

tokenIn*object

tokenOut*object

amountIn*string

amountOut*string

minAmountOut*string

approveAddress*string

status*object

msg*string

swapTxobject

feesobject

includedInOutputFeesobject

swapSpecDataobject

Request

const response = await fetch('/api/v1/crossChainSwap/estimate-all', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "crossChainName": "text",
  "tokenIn": {
    "address": "string",
    "chainId": "number",
    "decimals": "number",
    "name": "string",
    "symbol": "string"
  },
  "tokenOut": {
    "address": "string",
    "chainId": "number",
    "decimals": "number",
    "name": "string",
    "symbol": "string"
  },
  "amountIn": "text",
  "amountOut": "text",
  "minAmountOut": "text",
  "approveAddress": "text",
  "status": "number",
  "msg": "text",
  "swapTx": {
    "to": "string",
    "data": "number",
    "value": "number",
    "gasLimit": "string"
  },
  "fees": {
    "token": {
      "address": "string",
      "chainId": "number",
      "decimals": "number",
      "name": "string",
      "symbol": "string"
    },
    "amount": "string",
    "type": "number"
  },
  "includedInOutputFees": {
    "token": {
      "address": "string",
      "chainId": "number",
      "decimals": "number",
      "name": "string",
      "symbol": "string"
    },
    "amount": "string",
    "type": "number"
  }
}

This endpoint returns the data for investing in an opportunity by a token except TokenA or Token B

This endpoint returns from, to, data, value, and gasLimit, all of which needed for investing in an opportunity. Also it returns amountDesiredTokenA, amountDesiredTokenB, and amountLP to show to the investors.

An opportuniry name must be added to the url. e.g CROWD_USDT_LP_STAKE, mai-usdc-mimatic,and CAKE_WBNB_PANCAKE

GET/api/v1/opportunity/{opportunity}/investByToken

Path parameters

opportunity*string

Query parameters

Header parameters

Response

Body

from*string

User address who submits input tokens for a investment

to*string

opportunity Contract address

data*string

populated transaction

value*string

transaction value

gasLimit*string

transaction gas limit

amountDesiredTokenA*string

The amount of TokenA that we use for add liquidity

amountDesiredTokenB*string

The amount of TokenB that we use for add liquidity

amountLP*string

Amount of LP token after add liquidity

Request

const response = await fetch('/api/v1/opportunity/{opportunity}/investByToken', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "from": "text",
  "to": "text",
  "data": "text",
  "value": "text",
  "gasLimit": "text",
  "amountDesiredTokenA": "text",
  "amountDesiredTokenB": "text",
  "amountLP": "text"
}

This endpoint returns the data for investing in an opportunity by a tokenA and Token B

An opportuniry name must be added to the url. e.g CROWD_USDT_LP_STAKE, mai-usdc-mimatic,and CAKE_WBNB_PANCAKE

GET/api/v1/opportunity/{opportunity}/investByTokenAAndTokenB

Path parameters

opportunity*string

Query parameters

Header parameters

Response

Body

from*string

User address who submits input tokens for a investment

to*string

opportunity Contract address

data*string

populated transaction

value*string

transaction value

gasLimit*string

transaction gas limit

amountDesiredTokenA*string

The amount of TokenA that we use for add liquidity

amountDesiredTokenB*string

The amount of TokenB that we use for add liquidity

amountLP*string

Amount of LP token after add liquidity

Request

const response = await fetch('/api/v1/opportunity/{opportunity}/investByTokenAAndTokenB', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "from": "text",
  "to": "text",
  "data": "text",
  "value": "text",
  "gasLimit": "text",
  "amountDesiredTokenA": "text",
  "amountDesiredTokenB": "text",
  "amountLP": "text"
}

This endpoint returns the data for investing in an opportunity by a tokenA or Token B

An opportuniry name must be added to the url. e.g CROWD_USDT_LP_STAKE, mai-usdc-mimatic,and CAKE_WBNB_PANCAKE

GET/api/v1/opportunity/{opportunity}/investByTokenAOrTokenB

Path parameters

opportunity*string

Query parameters

Header parameters

Response

Body

from*string

User address who submits input tokens for a investment

to*string

opportunity Contract address

data*string

populated transaction

value*string

transaction value

gasLimit*string

transaction gas limit

amountDesiredTokenA*string

The amount of TokenA that we use for add liquidity

amountDesiredTokenB*string

The amount of TokenB that we use for add liquidity

amountLP*string

Amount of LP token after add liquidity

Request

const response = await fetch('/api/v1/opportunity/{opportunity}/investByTokenAOrTokenB', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "from": "text",
  "to": "text",
  "data": "text",
  "value": "text",
  "gasLimit": "text",
  "amountDesiredTokenA": "text",
  "amountDesiredTokenB": "text",
  "amountLP": "text"
}

This endpoint returns the data for investing in an opportunity by LP token of the opportunity

An opportuniry name must be added to the url. e.g CROWD_USDT_LP_STAKE, mai-usdc-mimatic,and CAKE_WBNB_PANCAKE

GET/api/v1/opportunity/{opportunity}/investByLP

Path parameters

opportunity*string

Query parameters

Header parameters

Response

Body

from*string

User address who submits input tokens for a investment

to*string

opportunity Contract address

data*string

populated transaction

value*string

transaction value

gasLimit*string

transaction gas limit

amountDesiredTokenA*string

The amount of TokenA that we use for add liquidity

amountDesiredTokenB*string

The amount of TokenB that we use for add liquidity

amountLP*string

Amount of LP token after add liquidity

Request

const response = await fetch('/api/v1/opportunity/{opportunity}/investByLP', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "from": "text",
  "to": "text",
  "data": "text",
  "value": "text",
  "gasLimit": "text",
  "amountDesiredTokenA": "text",
  "amountDesiredTokenB": "text",
  "amountLP": "text"
}

This endpoint returns the data for leave from an opportunity

This endpoint returns from, to, data, value, and gasLimit, all of which needed for leaving from an opportunity.

An opportuniry name must be added to the url. e.g CROWD_USDT_LP_STAKE, mai-usdc-mimatic,and CAKE_WBNB_PANCAKE

GET/api/v1/opportunity/{opportunity}/leaveByLP

Path parameters

opportunity*string

Query parameters

Header parameters

Response

Body

from*string

User address who submits input tokens for a investment

to*string

opportunity Contract address

data*string

populated transaction

value*string

transaction value

gasLimit*string

transaction gas limit

amountDesiredTokenA*string

The amount of TokenA that we use for add liquidity

amountDesiredTokenB*string

The amount of TokenB that we use for add liquidity

amountLP*string

Amount of LP token after add liquidity

Request

const response = await fetch('/api/v1/opportunity/{opportunity}/leaveByLP', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "from": "text",
  "to": "text",
  "data": "text",
  "value": "text",
  "gasLimit": "text",
  "amountDesiredTokenA": "text",
  "amountDesiredTokenB": "text",
  "amountLP": "text"
}

This endpoint returns the details of an opportunity

This endpoint returns tvl, apy, dailyInterest to inform users about how much the opportuniy profitable

An opportuniry name must be added to the url. e.g CROWD_USDT_LP_STAKE, mai-usdc-mimatic,and CAKE_WBNB_PANCAKE

GET/api/v1/opportunity/getDetails/{opportunity}

Path parameters

opportunity*string

Query parameters

Response

Body

tvl*string

opportunity's TVL

apy*string

opportunity's APY

dailyInterest*string

opportunity's daily interest

Request

const response = await fetch('/api/v1/opportunity/getDetails/{opportunity}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "tvl": "text",
  "apy": "text",
  "dailyInterest": "text"
}

This endpoint returns the data for investing in an opportunity by cross-chain

An opportuniry name must be added to the url. e.g CROWD_USDT_LP_STAKE, mai-usdc-mimatic,and CAKE_WBNB_PANCAKE

GET/api/v1/opportunity/{opportunity}/crossChainEstimation

Path parameters

opportunity*string

Query parameters

Header parameters

Response

Body

estimation*Estimation (object)

tx*Tx (object)

Request

const response = await fetch('/api/v1/opportunity/{opportunity}/crossChainEstimation', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "estimation": {
    "srcChainTokenIn": {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 0,
      "amount": "text"
    },
    "srcChainTokenOut": {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 0,
      "amount": "text",
      "minAmount": "text"
    },
    "dstChainTokenIn": {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 0,
      "amount": "text",
      "minAmount": "text"
    },
    "dstChainTokenOut": {
      "address": "text",
      "name": "text",
      "symbol": "text",
      "decimals": 0,
      "amount": "text",
      "minAmount": "text"
    },
    "executionFee": {
      "token": {
        "address": "text",
        "name": "text",
        "symbol": "text",
        "decimals": 0
      },
      "recommendedAmount": "text",
      "actualAmount": "text"
    }
  },
  "tx": {
    "to": "text",
    "data": "text",
    "value": "text"
  }
}

PreviousOverview NextSwap & Cross-Chain

Last updated 5 months ago