Swagger

https://api.fibrous.finance/starknet

Health Check

GET/healthCheck

Response

200

Request

JavaScriptCurlPython

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

Find best route via Fibrous Finance

GET/route

Query parameters

Response

200

route api response

Body

application/json

success*boolean

inputToken*object

inputAmount*string

outputToken*object

outputAmount*string

estimatedGasUsed*string

route*array of string

time*number

bestQuotesByProtocols*array of string

Request

JavaScriptCurlPython

const response = await fetch('/route?amount=text&tokenInAddress=text&tokenOutAddress=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "inputAmount": "text",
  "outputAmount": "text",
  "estimatedGasUsed": "text",
  "route": [
    "text"
  ],
  "time": 0,
  "bestQuotesByProtocols": [
    "text"
  ]
}

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

GET/routeBatch

Query parameters

Response

200

Route batch api response

Body

application/json

success*boolean

inputToken*object

inputAmount*string

outputToken*object

outputAmount*string

estimatedGasUsed*string

route*array of string

time*number

bestQuotesByProtocols*array of string

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "success": false,
    "inputAmount": "text",
    "outputAmount": "text",
    "estimatedGasUsed": "text",
    "route": [
      "text"
    ],
    "time": 0,
    "bestQuotesByProtocols": [
      "text"
    ]
  }
]

Generate data for calling the Fibrous Finance router contract for swap

GET/execute

Query parameters

Response

200

Request

JavaScriptCurlPython

const response = await fetch('/execute?amount=text&tokenInAddress=text&tokenOutAddress=text&slippage=0&destination=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();