Skip to main content
POST
/
rate
cURL
curl --request POST \
  --url https://api.bestflow.xyz/rate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "BTC",
  "to": "ETH",
  "fromNetwork": "BTC",
  "toNetwork": "ETH",
  "amount": 0.5
}
'
{
  "from": "<string>",
  "to": "<string>",
  "fromNetwork": "<string>",
  "toNetwork": "<string>",
  "amount": 123,
  "rates": [
    {
      "exchange": "swapter",
      "estReceive": 123,
      "eta": "<string>",
      "minAmount": 123,
      "maxAmount": 123
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.bestflow.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Optional Bearer authentication using an API key provided as a Bearer token. Required for unlimited requests and revenue sharing.

Body

application/json

Rate estimation request details

​
from
string
required

Source currency ticker

Example:

"BTC"

​
to
string
required

Destination currency ticker

Example:

"ETH"

​
fromNetwork
string
required

Source network identifier

Example:

"BTC"

​
toNetwork
string
required

Destination network identifier

Example:

"ETH"

​
amount
number
required

Amount to swap

Example:

0.5

Response

Rate estimation from supported exchanges

​
from
string
required
​
to
string
required
​
fromNetwork
string
required
​
toNetwork
string
required
​
amount
number
required
​
rates
object[]
required

Rate estimates per exchange, sorted descending by estReceive (best rate first). Exchanges with unavailable rates appear last.