Swagger

https://api.fibrous.finance/starknet

Health Check

get

/healthCheck

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/healthCheck'

200

200

No body

Find best route via Fibrous Finance

get

/route

Query parameters

amountstringrequired

Example: 0xde0b6b3a7640000 || 1000000000000000000

tokenInAddressstringrequired

Example: 0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7

tokenOutAddressstringrequired

Example: 0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8

excludeProtocolsstring[]

The protocol IDs you want to exclude from liquidity sources

reverseboolean · default: false

its not supported yet

directboolean · default: false

if its true direct route

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/route?amount=text&tokenInAddress=text&tokenOutAddress=text'

200

200

{
  "success": true,
  "inputToken": {},
  "inputAmount": "text",
  "outputToken": {},
  "outputAmount": "text",
  "estimatedGasUsed": "text",
  "route": [
    "text"
  ],
  "time": 1,
  "bestQuotesByProtocols": [
    "text"
  ]
}

route api response

Find best route with multiple input token to single output token via Fibrous Finance

get

/routeBatch

Query parameters

amountsarray stringrequired

Example: [1000000000000000000,2000000000]

tokenInAddressesarray stringrequired

Example: [0x049d...,0x0da1...]

tokenOutAddressesarray stringrequired

Example: [0x053c...]

reverseboolean · default: false

its not supported yet

directboolean · default: false

if its true direct route

excludeProtocolsstring[]

The protocol IDs you want to exclude from liquidity sources

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/routeBatch?amounts=null&tokenInAddresses=null&tokenOutAddresses=null'

200

200

[
  {
    "success": true,
    "inputToken": {},
    "inputAmount": "text",
    "outputToken": {},
    "outputAmount": "text",
    "estimatedGasUsed": "text",
    "route": [
      "text"
    ],
    "time": 1,
    "bestQuotesByProtocols": [
      "text"
    ]
  }
]

Route batch api response

Generate data for calling the Fibrous Finance router contract for swap

get

/execute

Query parameters

amountstringrequired

Example: 0xde0b6b3a7640000 || 1000000000000000000

tokenInAddressstringrequired

Example: 0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7

tokenOutAddressstringrequired

Example: 0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8

slippagenumberrequired

slippage: Min. 0; max:49 (0.49)

Example: 0.005

destinationstringrequired

The receiver address for the output token

reverseboolean · default: false

its not supported yet

directboolean · default: false

its not supported yet

excludeProtocolsstring[]

The protocol IDs you want to exclude from liquidity sources.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/execute?amount=text&tokenInAddress=text&tokenOutAddress=text&slippage=1&destination=text'

200

200

No body