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.
Body
Details of the account, calls, and token requirements.
Account details (smart account / EOA and related addresses). Account information that supports both role-based and basic account types. OneBalance supports a modular architecture designed to accommodate various account types with different validators, versions, and deployment methods.
Learn more about account types and their capabilities at OneBalance Account Models.
Role-based account using RoleBasedValidator with Kernel 3.1. Always has Resource Lock enabled.
Allows a user_admin
role (think user cold wallet) next to the signer role to rotate keys and execute trustless rage quit in emergency cases.
Secure in emergency cases related to WaaS/TEE but consumes slightly more gas.
- Role-based Account
- Basic Account
- EIP-7702 Account
Target chain in CAIP-2 notation (e.g. "eip155:10" for Optimism).
"eip155:10"
Array of calls to be executed.
Array of approvals required for the call. Approvals need to be explicitly defined. Any approval pased as call would result into a failing request.
Array of tokens needed for these calls.
Optional state overrides (e.g., fake balances for simulation).
Permit valid after value in block timestamp.
Permit valid until value in block timestamp.
Slippage tolerance in basis points (1/100th of a percent). For example, 50 = 0.5%, 100 = 1%, 1000 = 10%.
x >= 1
50
Response
Call quote prepared successfully
Response from prepare-call-quote containing all necessary data to execute contract calls on the target chain
Account configuration for the operation Account information that supports both role-based and basic account types. OneBalance supports a modular architecture designed to accommodate various account types with different validators, versions, and deployment methods.
Learn more about account types and their capabilities at OneBalance Account Models.
Role-based account using RoleBasedValidator with Kernel 3.1. Always has Resource Lock enabled.
Allows a user_admin
role (think user cold wallet) next to the signer role to rotate keys and execute trustless rage quit in emergency cases.
Secure in emergency cases related to WaaS/TEE but consumes slightly more gas.
- Role-based Account
- Basic Account
- EIP-7702 Account
Operation (including userOp and typed data) to be executed on-chain Chain operation containing user operation data, typed data to sign, and optional EIP-7702 delegation.
When EIP-7702 delegation is required, the delegation field will be present and must be signed before submission.
Tamper-proof signature for the entire call request
"0x0e1f9f56bb4072894a24ebc6fe6e41e15f8b9c8ce7bc1d9d88e9a46b85353d55238f0e7a75fbeb71249292e2206887adc894849488d8d8c23a5a17542d5ab2511b"
Type of operation indicating the routing strategy Type of call operation indicating the routing strategy:
same_chain_exclude_solver
: Operation on the same chain without solver involvementcross_chain_with_solver
: Cross-chain operation requiring solver assistancesame_chain_with_solver
: Same-chain operation with solver involvementcross_chain_with_solver_and_swaps
: Complex cross-chain operation with multiple swaps
same_chain_exclude_solver
, cross_chain_with_solver
, same_chain_with_solver
, cross_chain_with_solver_and_swaps
"cross_chain_with_solver"
Available balances for source assets that could be used for this operation