Swagger

https://api.fibrous.finance/starknet

Health Check

PreviousStarknet NextRoute Params

Last updated 6 months ago

Find best route via Fibrous Finance

get

Query parameters

amountstringRequiredExample: 0xde0b6b3a7640000 || 1000000000000000000

tokenInAddressstringRequiredExample: 0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7

tokenOutAddressstringRequiredExample: 0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8

excludeProtocolsstring[]Optional

The protocol IDs you want to exclude from liquidity sources

reversebooleanOptional

its not supported yet

Default: false

directbooleanOptional

if its true direct route

Default: false

Responses

application/json

objectOptional

get

GET /route?amount=text&tokenInAddress=text&tokenOutAddress=text HTTP/1.1
Host: 
Accept: */*

200

route api response

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

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

get

Query parameters

amountsarray stringRequiredExample: [1000000000000000000,2000000000]

tokenInAddressesarray stringRequiredExample: [0x049d...,0x0da1...]

tokenOutAddressesarray stringRequiredExample: [0x053c...]

reversebooleanOptional

its not supported yet

Default: false

directbooleanOptional

if its true direct route

Default: false

excludeProtocolsstring[]Optional

The protocol IDs you want to exclude from liquidity sources

Responses

application/json

object[]Optional

get

GET /routeBatch?amounts=null&tokenInAddresses=null&tokenOutAddresses=null HTTP/1.1
Host: 
Accept: */*

200

Route batch api response

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

Generate data for calling the Fibrous Finance router contract for swap

get

Query parameters

amountstringRequiredExample: 0xde0b6b3a7640000 || 1000000000000000000

tokenInAddressstringRequiredExample: 0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7

tokenOutAddressstringRequiredExample: 0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8

slippagenumberRequired

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

Example: 0.005

destinationstringRequired

The receiver address for the output token

reversebooleanOptional

its not supported yet

Default: false

directbooleanOptional

its not supported yet

Default: false

excludeProtocolsstring[]Optional

The protocol IDs you want to exclude from liquidity sources.

Responses

get

GET /execute?amount=text&tokenInAddress=text&tokenOutAddress=text&slippage=1&destination=text HTTP/1.1
Host: 
Accept: */*

200Success

No content