Swagger

Last updated 1 year ago

Was this helpful?

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

Authorizations

Query parameters

fromTokenobjectrequired

Source token. (Supported values for chainId are 1, 56, 137, 43114, 42161 and 324)

Example:

{"fromToken[address]":"0x0000000000000000000000000000000000001010","fromToken[chainId]":137,"fromToken[decimals]":18,"fromToken[name]":"Matic Token","fromToken[symbol]":"MATIC"}

toTokenobjectrequired

Destination token. (Supported values for chainId are 1, 56, 137, 43114, 42161 and 324)

Example:

{"toToken[address]":"0x483dd3425278C1f79F377f1034d9d2CaE55648B6","toToken[chainId]":137,"toToken[decimals]":18,"toToken[name]":"Crowd Token","toToken[symbol]":"CROWD"}

amountstringrequired

An amount of fromToken to be swapped (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

networkCoinPricestring

The price of the selected network's coin based on USD. Example: price of BNB = 245.82

slippagestring · default: 0.5

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

gasPricestring

Gas Price based on selected network (The unit is gwei)

filteredDexNamesstring[]

filters dexes to be searched for an estimation, providing results only from these selected dexes.

Example: CrowdswapAggregator,CrowdSwapV2,Quickswap

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/swap/estimate-all?fromToken=%5Bobject+Object%5D&toToken=%5Bobject+Object%5D&amount=text' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

401

404

{
  "successfulEstimationsList": [
    {
      "swapName": "text",
      "delegatedDex": "text",
      "fromToken": "text",
      "fromTokenPrice": "text",
      "toToken": "text",
      "toTokenPrice": "text",
      "amountIn": "text",
      "amountOut": "text",
      "minAmountOut": "text",
      "route": "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": {},
      "reserves": [
        "text"
      ]
    }
  ]
}

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}

Authorizations

Path parameters

dexstringrequired

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

Query parameters

fromTokenobjectrequired

Source token. (Supported values for chainId are 1, 56, 137, 43114, 42161 and 324)

Example:

{"fromToken[address]":"0x0000000000000000000000000000000000001010","fromToken[chainId]":137,"fromToken[decimals]":18,"fromToken[name]":"Matic Token","fromToken[symbol]":"MATIC"}

toTokenobjectrequired

Destination token. (Supported values for chainId are 1, 56, 137, 43114, 42161 and 324)

Example:

{"toToken[address]":"0x483dd3425278C1f79F377f1034d9d2CaE55648B6","toToken[chainId]":137,"toToken[decimals]":18,"toToken[name]":"Crowd Token","toToken[symbol]":"CROWD"}

amountstringrequired

An amount of fromToken to be swapped (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

networkCoinPricestring

The price of the selected network's coin based on USD. Example: price of BNB = 245.82

slippagestring · default: 0.5

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

userAddressstringrequired

Address of the user who initiates the swap transaction

receiverAddressstring

Address of the recipient

amountOutMinstringrequired

The minimum amount out expected from a swap (This amount is available in the estimation result. Also the decimal of token must be considered in the amount)

deadlinestring · default: 30required

Swap estimation will be expired after this deadline (The unit of deadline is based on minutes)

Example: {"value":"15"}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/swap/{dex}?fromToken=%5Bobject+Object%5D&toToken=%5Bobject+Object%5D&amount=text&userAddress=text&amountOutMin=text&deadline=30' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

401

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

Authorizations

Query parameters

fromTokenobjectrequired

Source token. (Supported values for chainId are 1, 56, 137, 43114, 42161 and 324)

Example:

{"fromToken[address]":"0x0000000000000000000000000000000000001010","fromToken[chainId]":137,"fromToken[decimals]":18,"fromToken[name]":"Matic Token","fromToken[symbol]":"MATIC"}

amountInstringrequired

An amount of fromToken to be swapped (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

slippagestring · default: 3

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

toTokenobjectrequired

Destination token. (Supported values for chainId are 1, 56, 137, 43114, 42161 and 324)

Example:

{"toToken[address]":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE","toToken[chainId]":56,"toToken[decimals]":18,"toToken[name]":"Binance Coin","toToken[symbol]":"BNB"}

userAddressstring

Address of the user who initiates the cross-chain swap transaction

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/crossChainSwap/estimate-all?fromToken=%5Bobject+Object%5D&amountIn=text&toToken=%5Bobject+Object%5D' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

401

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

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

opportunitystringrequired

Query parameters

userAddressstringrequired

User address who submits input tokens for an investment

tokenobjectrequired

The token that user choose to invest with. (In investByTokenATokenB, we choose the token that user enter its amount first)

Example:

{"token[address]":"0x0000000000000000000000000000000000001010","token[chainId]":137,"token[decimals]":18,"token[name]":"Matic Token","token[symbol]":"MATIC","token[price]":0.94036}

amountstringrequired

An amount of input tokens to invest (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

networkCoinPricestringrequired

The price of selected network's coin based on USD. Example: price of BNB = 279.22

slippagestring · default: 0.5required

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

deadlinenumber · default: 30required

swap estimation will be expired after this deadline (the unit of deadline is based on minutes)

Example: {"value":"15"}

Header parameters

x-correlation-idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/opportunity/{opportunity}/investByToken?userAddress=text&token=%5Bobject+Object%5D&amount=text&networkCoinPrice=text&slippage=0.5&deadline=30' \
  --header 'x-correlation-id: text'

default

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

opportunitystringrequired

Query parameters

userAddressstringrequired

User address who submits input tokens for an investment

tokenobjectrequired

The token that user choose to invest with. (In investByTokenATokenB, we choose the token that user enter its amount first)

Example:

{"token[address]":"0x0000000000000000000000000000000000001010","token[chainId]":137,"token[decimals]":18,"token[name]":"Matic Token","token[symbol]":"MATIC","token[price]":0.94036}

amountstringrequired

An amount of input tokens to invest (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

networkCoinPricestringrequired

The price of selected network's coin based on USD. Example: price of BNB = 279.22

slippagestring · default: 0.5required

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

deadlinenumber · default: 30required

swap estimation will be expired after this deadline (the unit of deadline is based on minutes)

Example: {"value":"15"}

Header parameters

x-correlation-idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/opportunity/{opportunity}/investByTokenAAndTokenB?userAddress=text&token=%5Bobject+Object%5D&amount=text&networkCoinPrice=text&slippage=0.5&deadline=30' \
  --header 'x-correlation-id: text'

default

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

opportunitystringrequired

Query parameters

userAddressstringrequired

User address who submits input tokens for an investment

tokenobjectrequired

The token that user choose to invest with. (In investByTokenATokenB, we choose the token that user enter its amount first)

Example:

{"token[address]":"0x0000000000000000000000000000000000001010","token[chainId]":137,"token[decimals]":18,"token[name]":"Matic Token","token[symbol]":"MATIC","token[price]":0.94036}

amountstringrequired

An amount of input tokens to invest (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

networkCoinPricestringrequired

The price of selected network's coin based on USD. Example: price of BNB = 279.22

slippagestring · default: 0.5required

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

deadlinenumber · default: 30required

swap estimation will be expired after this deadline (the unit of deadline is based on minutes)

Example: {"value":"15"}

Header parameters

x-correlation-idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/opportunity/{opportunity}/investByTokenAOrTokenB?userAddress=text&token=%5Bobject+Object%5D&amount=text&networkCoinPrice=text&slippage=0.5&deadline=30' \
  --header 'x-correlation-id: text'

default

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

opportunitystringrequired

Query parameters

userAddressstringrequired

User address who submits input tokens for an investment

tokenobjectrequired

The token that user choose to invest with. (In investByTokenATokenB, we choose the token that user enter its amount first)

Example:

{"token[address]":"0x0000000000000000000000000000000000001010","token[chainId]":137,"token[decimals]":18,"token[name]":"Matic Token","token[symbol]":"MATIC","token[price]":0.94036}

amountstringrequired

An amount of input tokens to invest (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

networkCoinPricestringrequired

The price of selected network's coin based on USD. Example: price of BNB = 279.22

slippagestring · default: 0.5required

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

deadlinenumber · default: 30required

swap estimation will be expired after this deadline (the unit of deadline is based on minutes)

Example: {"value":"15"}

Header parameters

x-correlation-idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/opportunity/{opportunity}/investByLP?userAddress=text&token=%5Bobject+Object%5D&amount=text&networkCoinPrice=text&slippage=0.5&deadline=30' \
  --header 'x-correlation-id: text'

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

opportunitystringrequired

Query parameters

userAddressstringrequired

User address who submits input tokens for an investment

tokenobjectrequired

The token that user choose to invest with. (In investByTokenATokenB, we choose the token that user enter its amount first)

Example:

{"token[address]":"0x0000000000000000000000000000000000001010","token[chainId]":137,"token[decimals]":18,"token[name]":"Matic Token","token[symbol]":"MATIC","token[price]":0.94036}

amountstringrequired

An amount of input tokens to invest (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

networkCoinPricestringrequired

The price of selected network's coin based on USD. Example: price of BNB = 279.22

slippagestring · default: 0.5required

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

deadlinenumber · default: 30required

swap estimation will be expired after this deadline (the unit of deadline is based on minutes)

Example: {"value":"15"}

Header parameters

x-correlation-idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/opportunity/{opportunity}/leaveByLP?userAddress=text&token=%5Bobject+Object%5D&amount=text&networkCoinPrice=text&slippage=0.5&deadline=30' \
  --header 'x-correlation-id: text'

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

opportunitystringrequired

Query parameters

tokenAobjectrequired

tokenA

Example:

{"fromToken[address]":"0x0000000000000000000000000000000000001010","fromToken[chainId]":137,"fromToken[decimals]":18,"fromToken[name]":"Matic Token","fromToken[symbol]":"MATIC","fromToken[price]":0.94036}

tokenBobjectrequired

tokenB

Example:

{"fromToken[address]":"0x0000000000000000000000000000000000001010","fromToken[chainId]":137,"fromToken[decimals]":18,"fromToken[name]":"Matic Token","fromToken[symbol]":"MATIC","fromToken[price]":0.94036}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/opportunity/getDetails/{opportunity}?tokenA=%5Bobject+Object%5D&tokenB=%5Bobject+Object%5D'

default

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

opportunitystringrequired

Query parameters

srcChainIdnumber · default: 1required

Source Chain Id

Example: {"value":"1"}

srcChainTokenInAddressstring · default: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeErequired

Source Chain Token Address

Example: {"value":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"}

srcChainTokenInAmountstringrequired

An amount of input tokens to cross-chain swap (The decimal of token must be considered in the amount)

Example: {"value":"1000000000000000000"}

slippagestring · default: 3required

A slippage constraint (in %) is a safeguard during swaps. It is used to calculate the minimum possible outcome during estimation.

dstChainIdnumber · default: 56required

Destination Chain Id

Example: {"value":"1"}

dstChainTokenOutAddressstring · default: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeErequired

Destination Chain Token Address

Example: {"value":"0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"}

userAddressstringrequired

User address who submits input tokens for a cross-chain swap

Header parameters

x-correlation-idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v1/opportunity/{opportunity}/crossChainEstimation?srcChainId=1&srcChainTokenInAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&srcChainTokenInAmount=text&slippage=3&dstChainId=56&dstChainTokenOutAddress=0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE&userAddress=text' \
  --header 'x-correlation-id: text'

default

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