🎑Overview

Integrate our API directly into your dApp. With our Orbiter REST API, you can easily find the best routes for cross-chain and on-chain swapping and bridging.

API Endpoints

Production environment APIs:

https://api.orbiter.finance  /  https://openapi.orbiter.finance

POST /quote

Get a quote for cross-chain token transactions.

Request Parameters:

• sourceChainId: Source blockchain network ID

• destChainId: Destination blockchain network ID

• sourceToken: Source token contract address

• destToken: Destination token contract address

• amount: Transaction amount in string format

• userAddress: User wallet address

• targetRecipient: Final transaction recipient address

• slippage: Acceptable price fluctuation percentage

• feeConfig: Fee configuration object

Example Request:

{
  "sourceChainId": "42161",
  "destChainId": "10",
  "sourceToken": "0x0000000000000000000000000000000000000000",
  "destToken": "0x0000000000000000000000000000000000000000",
  "amount": "300000000000000",
  "userAddress": "0xefc6089224068b20197156a91d50132b2a47b908",
  "targetRecipient": "0xefc6089224068b20197156a91d50132b2a47b908",
  "slippage": 0.02,
  "feeConfig": {
    "feeRecipient": "0xefc6089224068b20197156a91d50132b2a47b908",
    "feePercent": "0.1"
  }
}

GET /chains

Get available blockchain networks.

Headers:

• x-api-key: API key for authentication

GET /transaction/status/{hash}

Query transaction status by hash.

Path Parameters:

• hash: Transaction hash to query

Headers:

• x-api-key: API key for authentication (optional)

Notes for Developers

• All token amounts are represented as strings to preserve precision

• Cross-chain transactions may involve multiple steps shown in the response

• Always check the response status and message fields for success/error information

• Except for the EVM network, the same-chain swap network does not support query transactions