Authorizations
The OneBalance API uses API keys to authenticate requests. All API requests require authentication using an API key passed in the x-api-key
header:
curl -X 'GET' \
'https://be.onebalance.io/api/path-to/endpoint' \
-H 'x-api-key: ${ONEBALANCE_API_KEY}' \
...
A public API key is available for testing purposes with limited usage: 42bb629272001ee1163ca0dbbbc07bcbb0ef57a57baf16c4b1d4672db4562c11
.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Learn how to generate API access tokens at OneBalance Docs.
Query Parameters
The ID of the quote to retrieve the status for
"0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
Response
Successfully retrieved the quote status
Quote ID of the execution
"0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
Execution status of the quote. The status progresses through different stages:
- PENDING: Operation has been submitted but processing has not yet begun
- IN_PROGRESS: Currently processing the execution steps of the operation
- EXECUTED: Transaction has been executed on the destination chain but origin chain operations may still be pending
- COMPLETED: All operations on both origin and destination chains have been completed successfully
- REFUNDED: Operation failed at some step, causing the whole operation to be refunded
- FAILED: All steps of the operation failed
PENDING
, IN_PROGRESS
, EXECUTED
, COMPLETED
, REFUNDED
, FAILED
"COMPLETED"
The address of the user that initiated the quote
"0x9b747cC14A5672a7166b4eccdc92d7F4003f8081"
The recipient account identifier (e.g., eip155:chainId/address).
"eip155:1/0x9b747cC14A5672a7166b4eccdc92d7F4003f8081"
The asset(s) that were sent from the source
[
{
"hash": "0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d",
"chainId": 1,
"chain": "eip155:1",
"explorerUrl": "https://etherscan.io/tx/0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
}
]
The asset(s) that were received to the final destination
[
{
"hash": "0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d",
"chainId": 1,
"chain": "eip155:1",
"explorerUrl": "https://etherscan.io/tx/0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
}
]
Reason for quote refund when status is REFUNDED.
For detailed explanations and troubleshooting steps, see: https://docs.onebalance.io/api-reference/error-codes
Possible values:
General Failure Reasons:
- UNKNOWN: Unknown failure reason
- SLIPPAGE: Price moved beyond the configured slippage tolerance
- AMOUNT_TOO_LOW_TO_REFUND: Amount is too low to process a refund
- DEPOSIT_ADDRESS_MISMATCH: Deposit address does not match expected address
- DEPOSIT_CHAIN_MISMATCH: Deposit chain does not match expected chain
- INCORRECT_DEPOSIT_CURRENCY: Deposited currency is incorrect
- DOUBLE_SPEND: Double spend detected
- SOLVER_CAPACITY_EXCEEDED: Solver capacity has been exceeded
- DEPOSITED_AMOUNT_TOO_LOW_TO_FILL: Deposited amount is too low to fill the order
- NEGATIVE_NEW_AMOUNT_AFTER_FEES: Negative amount after deducting fees
- NO_QUOTES: No quotes available
- MISSING_REVERT_DATA: Missing revert data from transaction
- REVERSE_SWAP_FAILED: Reverse swap operation failed
- GENERATE_SWAP_FAILED: Failed to generate swap
- TOO_LITTLE_RECEIVED: Received amount is too little
- EXECUTION_REVERTED: Execution was reverted
- NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE: New calldata includes higher rent fee
- TRANSACTION_REVERTED: Transaction was reverted
- ORIGIN_CURRENCY_MISMATCH: Origin currency mismatch
- NO_INTERNAL_SWAP_ROUTES_FOUND: No internal swap routes found
- SWAP_USES_TOO_MUCH_GAS: Swap uses too much gas
- INSUFFICIENT_FUNDS_FOR_RENT: Insufficient funds for rent (Solana-specific)
Execution Revert Specific Reasons:
- ORDER_EXPIRED: Order has expired
- ORDER_IS_CANCELLED: Order has been cancelled
- TRANSFER_FROM_FAILED: Transfer from operation failed
- TRANSFER_FAILED: Transfer operation failed
- SIGNATURE_EXPIRED: Signature has expired
- INVALID_SIGNATURE: Invalid signature provided
- INSUFFICIENT_NATIVE_TOKENS_SUPPLIED: Insufficient native tokens supplied
- TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE: Transfer amount exceeds allowance
- TRANSFER_AMOUNT_EXCEEDS_BALANCE: Transfer amount exceeds balance
- INVALID_SENDER: Invalid sender
- ACCOUNT_ABSTRACTION_INVALID_NONCE: Account abstraction invalid nonce
- ACCOUNT_ABSTRACTION_SIGNATURE_ERROR: Account abstraction signature error
- SEAPORT_INEXACT_FRACTION: Seaport inexact fraction
- TOKEN_NOT_TRANSFERABLE: Token is not transferable
- ZERO_SELL_AMOUNT: Zero sell amount
- MINT_NOT_ACTIVE: Mint is not active
- ERC_1155_TOO_MANY_REQUESTED: ERC-1155 too many requested
- INCORRECT_PAYMENT: Incorrect payment
- INVALID_GAS_PRICE: Invalid gas price
- FLUID_DEX_ERROR: Fluid DEX error
- ORDER_ALREADY_FILLED: Order already filled
- SEAPORT_INVALID_FULFILLER: Seaport invalid fulfiller
Jupiter Specific Failures:
- JUPITER_INVALID_TOKEN_ACCOUNT: Jupiter invalid token account (Solana)
UNKNOWN
, SLIPPAGE
, AMOUNT_TOO_LOW_TO_REFUND
, DEPOSIT_ADDRESS_MISMATCH
, DEPOSIT_CHAIN_MISMATCH
, INCORRECT_DEPOSIT_CURRENCY
, DOUBLE_SPEND
, SOLVER_CAPACITY_EXCEEDED
, DEPOSITED_AMOUNT_TOO_LOW_TO_FILL
, NEGATIVE_NEW_AMOUNT_AFTER_FEES
, NO_QUOTES
, MISSING_REVERT_DATA
, REVERSE_SWAP_FAILED
, GENERATE_SWAP_FAILED
, TOO_LITTLE_RECEIVED
, EXECUTION_REVERTED
, NEW_CALLDATA_INCLUDES_HIGHER_RENT_FEE
, TRANSACTION_REVERTED
, ORIGIN_CURRENCY_MISMATCH
, NO_INTERNAL_SWAP_ROUTES_FOUND
, SWAP_USES_TOO_MUCH_GAS
, INSUFFICIENT_FUNDS_FOR_RENT
, ORDER_EXPIRED
, ORDER_IS_CANCELLED
, TRANSFER_FROM_FAILED
, TRANSFER_FAILED
, SIGNATURE_EXPIRED
, INVALID_SIGNATURE
, INSUFFICIENT_NATIVE_TOKENS_SUPPLIED
, TRANSFER_AMOUNT_EXCEEDS_ALLOWANCE
, TRANSFER_AMOUNT_EXCEEDS_BALANCE
, INVALID_SENDER
, ACCOUNT_ABSTRACTION_INVALID_NONCE
, ACCOUNT_ABSTRACTION_SIGNATURE_ERROR
, SEAPORT_INEXACT_FRACTION
, TOKEN_NOT_TRANSFERABLE
, ZERO_SELL_AMOUNT
, MINT_NOT_ACTIVE
, ERC_1155_TOO_MANY_REQUESTED
, INCORRECT_PAYMENT
, INVALID_GAS_PRICE
, FLUID_DEX_ERROR
, ORDER_ALREADY_FILLED
, SEAPORT_INVALID_FULFILLER
, JUPITER_INVALID_TOKEN_ACCOUNT
"SLIPPAGE"