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
Account details for the request. 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.
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.
"0x0e1f9f56bb4072894a24ebc6fe6e41e15..."
Aggregated asset id for the token to transfer
"ob:eth"
Response
Call quote
Unique identifier for the quote
"0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
Account details. Required to check the signature before sending on-chain 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.
Information about the origin of the quote
Source tokens
Destination token
UNIX timestamp of when the quote gets stale
"1686239400"
Signature to ensure the quote hasn't been tampered with
"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
The operation that will be executed on the destination chain if an arbitrary execution is requested 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.