Off-Chain Interface
Last updated
Last updated
The Airlift API provides programmatic access to available routes for bridging assets across chains, fee quotes for transfers, and transaction status. It supports fetching transaction metadata, querying available routes, and estimating costs for operations like bridging.
Base URL:
Endpoints require authentication, pass your API key in the request header:
Endpoint: GET /routes
Security: API key
Query Parameters:
isEnabled
(boolean, optional): Filter by enabled routes.
limit
(integer, optional): Number of results per page. Default is 100.
offset
(integer, optional): Pagination offset. Default is 0.
Response:
Returns a list of supported routes with fields such as:
fromChainName
, toChainName
standard
(bridge protocol)
estimatedGas
, estimatedDuration
minTransferSize
, maxTransferSize
Token info (tokenName
, tokenId
)
Example: List Routes
The request above responds with:
Pagination
For /routes
endpoint, pagination metadata is included in the paging
object:
prev
: URI for previous page
next
: URI for next page
self
: URI for current page
Endpoint: POST /quote
Security: API key
Query Parameters:
fromChain
(string, required): Chain ID of source chain (e.g. 10).
toChain
(string, required): Chain ID of destination chain (e.g. 42161).
fromToken
(string, required): Source token address (e.g. 0x...).
fromAmount
(string, required): Amount to transfer (e.g. 100000000000000000).
Response:
Returns an object with the following fields:
toAmount
: Net amount after fees.
estimatedGas
: Estimated gas usage.
estimatedDuration
: Duration in seconds.
feeCosts
: Breakdown of bridgeFee and airliftFee (both nativeFee and tokenFee).
Example: Get a Quote
The request above responds with:
Endpoint: GET /transactions/{txHash}
Security: API key
Path Parameters:
txHash
(string, required): The transaction hash (must match the pattern
^0x[0-9a-fA-F]{64}$
).
Response: Returns the transaction status, which can be one of:
PENDING
DONE
FAILED
NOT_FOUND
Each status has specific substatus values.
Example: Fetch Transaction Status
The request above responds with:
🧾 Transaction Status Reference
Status: PENDING
Substatus values:
WAIT_SOURCE_CONFIRMATIONS
WAIT_DESTINATION_TRANSACTION
BRIDGE_NOT_AVAILABLE
CHAIN_NOT_AVAILABLE
REFUND_IN_PROGRESS
UNKNOWN_ERROR
Status: DONE
Substatus values:
COMPLETED
PARTIAL
REFUNDED
Status: FAILED
Substatus values:
NOT_PROCESSABLE_REFUND_NEEDED
OUT_OF_GAS
SLIPPAGE_EXCEEDED
INSUFFICIENT_ALLOWANCE
INSUFFICIENT_BALANCE
UNKNOWN_ERROR
EXPIRED
400
Bad Request
404
Not Found
500
Internal Server Error
503
Server Unavailable
Error format:
The standard field in routes refers to one of:
CCT
LayerZero V1 and V2 OFTs
NTT