API

Source Code

The API is designed to be run serverlessly (without storing state) and is a wrapper on top of the SDK. See full implementation here.

Caching & Liveness

Users of the Across API are requested to cache results for no longer than 300 seconds.

The Across API serves data that is derived from the on-chain state of the Across contracts and relayer bots. The on-chain state is subject to change each block, and cached data can quickly become invalid as a result.

API Endpoints

Retrieve suggested fee quote for a deposit.

Returns suggested fees based on the token, destination chain ID, and amount.

GEThttps://app.across.to/api/suggested-fees

Query parameters

Response

200400500

Suggested fees for the transaction

Body

*/*application/json

feesobject

Fee object for Across v3.

capitalFeePctstring

The percentage of the transfer amount that should go the relayer as a fee to cover relayer capital costs.

capitalFeeTotalstring

The amount that should go to the relayer as a fee to cover relayer capital costs.

relayerGasFeePctstring

The percentage of the transfer amount that should go the relayer as a fee to cover relayer gas costs.

relayerGasFeeTotalstring

The amount that should go to the relayer as a fee to cover relayer gas costs.

relayFeePctstring

The percentage of the transfer amount that should go to the relayer as a fee in total. The value is inclusive of LpFeePct. This is the strongly recommended minimum value to ensure a relayer will perform the transfer under the current network conditions. The value returned in this field is guaranteed to be at least 0.03% in order to meet minimum relayer fee requirements. Note: 1% is represented as 1e16, 100% is 1e18, 50% is 5e17, etc. These values are in the same format that the contract understands.

relayFeeTotalstring

The amount of the transfer that should go to the relayer a fee in total. This value is inclusive of LpFeeTotal.

lpFeePctstring

The percent of the amount that will go to the LPs as a fee for borrowing their funds. The formatting of the percentage is the same as relayFeePct.

timestampstring

The quote timestamp that was used to compute the lpFeePct. To pay the quoted LP fee, the user would need to pass this quote timestamp to the protocol when sending their bridge transaction.

isAmountTooLowboolean

Is the input amount below the minimum transfer amount.

quoteBlockstring

The block used associated with this quote, used to compute lpFeePct.

spokePoolAddressstring

The contract address of the origin SpokePool.

Request

JavaScriptCurl

const response = await fetch('https://app.across.to/api/suggested-fees', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve current transfer limits of the system

Returns transfer limits for specified token and destination chain ID.

GEThttps://app.across.to/api/limits

Query parameters

Response

200400500

Transfer limits

Body

*/*application/json

minDepositstring

The minimum deposit size in the tokens' units. Note: USDC has 6 decimals, so this value would be the number of USDC multiplied by 1e6. For WETH, that would be 1e18.

maxDepositstring

The maximum deposit size in the tokens' units. Note: The formatting of this number is the same as minDeposit.

maxDepositInstantstring

The max deposit size that can be relayed "instantly" on the destination chain. Instantly means that there is relayer capital readily available and that a relayer is expected to relay within 1-4 minutes of the deposit.

maxDepositShortDelaystring

The max deposit size that can be relayed with a "short delay" on the destination chain. This means that there is relayer capital available on mainnet and that a relayer will immediately begin moving that capital over the canonical bridge to relay the deposit. Depending on the chain, the time for this can vary. Polygon is the worst case where it can take between 20 and 35 minutes for the relayer to receive the funds and relay. Arbitrum is much faster, with a range between 5 and 15 minutes. Note: if the transfer size is greater than this, the estimate should be between 2-4 hours for a slow relay to be processed from the mainnet pool.

Request

JavaScriptCurl

const response = await fetch('https://app.across.to/api/limits', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve available routes for transfers

Returns available routes based on specified parameters.

GEThttps://app.across.to/api/available-routes

Query parameters

Response

200400500

List of available routes

Body

*/*application/json

originChainIdstring

Chain ID of the originating chain.

destinationChainIdstring

Chain ID of the destination chain.

originTokenstring

Origin chain ddress of token contract to transfer.

destinationTokenstring

Destination chain ddress of token contract to receive.

Request

JavaScriptCurl

const response = await fetch('https://app.across.to/api/available-routes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();