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

x-api-key

Query parameters

Response

200400401404

OK

Body

application/json

successfulEstimationsList*array of EstimatedTradeDto (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "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 investing in an opportunity by a 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}/investByTokenAOrTokenB

Path parameters

opportunity*string

Query parameters

Header parameters

Response

default

Body

application/json

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

JavaScriptCurlPython

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

Response

default

{
  "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

default

Body

application/json

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

JavaScriptCurlPython

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

Response

default

{
  "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

default

Body

application/json

tvl*string

opportunity's TVL

apy*string

opportunity's APY

dailyInterest*string

opportunity's daily interest

Request

JavaScriptCurlPython

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

Response

default

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