Quickstart

const response = await fetch('https://transfer.layerzero-api.com/v1/chains');

const {chains} = await response.json();
console.log(chains);

import requests

response = requests.get("https://transfer.layerzero-api.com/v1/chains")
chains = response.json()["chains"]

print(chains)

// Get tokens transferrable from Base ETH
const response = await fetch(
  'https://transfer.layerzero-api.com/v1/tokens?' +
    new URLSearchParams({
      transferrableFromChainKey: 'base',
      transferrableFromTokenAddress: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE',
    }),
);
const {tokens} = await response.json();

console.log(tokens);

import requests

# Get tokens transferrable from Base ETH
response = requests.get(
  "https://transfer.layerzero-api.com/v1/tokens",
  params={
    "transferrableFromChainKey": "base",
    "transferrableFromTokenAddress": "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
  },
)
tokens = response.json()["tokens"]

print(tokens)

const response = await fetch('https://transfer.layerzero-api.com/v1/quotes', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    srcChainKey: 'base',
    dstChainKey: 'optimism',
    srcTokenAddress: '<0xTOKEN_ADDRESS>',
    dstTokenAddress: '<0xTOKEN_ADDRESS>',
    srcWalletAddress: '<0xYOUR_WALLET>',
    dstWalletAddress: '<0xYOUR_WALLET>',
    amount: '<AMOUNT_IN_LOCAL_DECIMALS>', // 0.0001 ETH in wei
    options: {
      amountType: 'EXACT_SRC_AMOUNT',
      feeTolerance: {type: 'PERCENT', amount: 2},
    },
  }),
});

const {quotes} = await response.json();
const quote = quotes[0];

console.log('Quote ID:', quote.id);
console.log('Fee:', quote.feeUsd, 'USD');

import requests

response = requests.post(
  "https://transfer.layerzero-api.com/v1/quotes",
  headers={
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  json={
    "srcChainKey": "base",
    "dstChainKey": "optimism",
    "srcTokenAddress": "<0xTOKEN_ADDRESS>",
    "dstTokenAddress": "<0xTOKEN_ADDRESS>",
    "srcWalletAddress": "<0xYOUR_WALLET>",
    "dstWalletAddress": "<0xYOUR_WALLET>",
    "amount": "<AMOUNT_IN_LOCAL_DECIMALS>",  # 0.0001 ETH in wei
    "options": {
      "amountType": "EXACT_SRC_AMOUNT",
      "feeTolerance": {"type": "PERCENT", "amount": 2},
    },
  },
)

quote = response.json()["quotes"][0]

print(f"Quote ID: {quote['id']}")
print(f"Fee: {quote.get('feeUsd', 'N/A')} USD")

const response = await fetch('https://transfer.layerzero-api.com/v1/build-user-steps', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({quoteId: 'QUOTE_ID'}),
});

const {userSteps} = await response.json();

console.log('User steps:', userSteps);

import requests

response = requests.post(
  "https://transfer.layerzero-api.com/v1/build-user-steps",
  headers={
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  json={"quoteId": "QUOTE_ID"},
)

user_steps = response.json()["userSteps"]

print("User steps:", user_steps)

from web3 import Web3

w3 = Web3(Web3.HTTPProvider("https://mainnet.base.org"))
account = w3.eth.account.from_key("YOUR_PRIVATE_KEY")

tx_hash = None

for step in user_steps:
    if step["type"] != "TRANSACTION":
        continue

    tx = step["transaction"]["encoded"]
    signed = account.sign_transaction(
        {
            "to": tx["to"],
            "data": tx["data"],
            "value": int(tx.get("value", 0)),
            "gas": 200000,
            "gasPrice": w3.eth.gas_price,
            "nonce": w3.eth.get_transaction_count(account.address),
            "chainId": tx["chainId"],
        }
    )

    tx_hash = w3.eth.send_raw_transaction(signed.rawTransaction)
    w3.eth.wait_for_transaction_receipt(tx_hash)
    print(f"{step['description']} tx confirmed: {tx_hash.hex()}")

from eth_account.messages import encode_typed_data

# Sign the typed data from userStep["signature"]["typedData"]
typed = user_step["signature"]["typedData"]
signable = encode_typed_data(full_message=typed)
signed = account.sign_message(signable)

# Submit to API
requests.post(
  "https://transfer.layerzero-api.com/v1/submit-signature",
  headers={
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  json={
    "quoteId": quote["id"],
    "signatures": [signed.signature.hex()],
  },
)

async function pollStatus(quoteId: string, txHash?: string): Promise<string> {
  const query = txHash ? `?txHash=${txHash}` : '';

  while (true) {
    const response = await fetch(
      `https://transfer.layerzero-api.com/v1/status/${encodeURIComponent(quoteId)}${query}`,
      {headers: {'x-api-key': 'YOUR_API_KEY'}},
    );

    const {status, explorerUrl} = await response.json();
    console.log('Status:', status);

    if (status === 'SUCCEEDED' || status === 'FAILED' || status === 'UNKNOWN') {
      console.log('Explorer:', explorerUrl);
      return status;
    }

    await new Promise((resolve) => setTimeout(resolve, 4000));
  }
}

import time
from urllib.parse import quote as url_quote

import requests


def poll_status(quote_id: str, tx_hash: str | None = None) -> str:
  query = f"?txHash={tx_hash}" if tx_hash else ""

  while True:
    response = requests.get(
      f"https://transfer.layerzero-api.com/v1/status/{url_quote(quote_id, safe='')}{query}",
      headers={"x-api-key": "YOUR_API_KEY"},
    )

    data = response.json()
    print(f"Status: {data['status']}")

    if data["status"] in ("SUCCEEDED", "FAILED", "UNKNOWN"):
      print(f"Explorer: {data.get('explorerUrl')}")
      return data["status"]

    time.sleep(4)