Get quote

Authorizations

x-api-key

string

header

required

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

application/json

from

object

required

Origin information for the quote

Show child attributes

from.account

Role-based Account · object

required

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

Show child attributes

from.account.type

enum<string>

required

Account type identifier for role-based accounts

Available options:

role-based

Example:

"role-based"

from.account.sessionAddress

string

required

Address associated with user's ECDSA signing key used for session-based operations

Example:

"0x1cBFbFd62a276BF6D79d504eA4CA75a7baDcf5b1"

from.account.adminAddress

string

required

Address selected by the user as backup admin. Can perform rage quit and key rotation. Must be different from sessionAddress.

Example:

"0xc162a3cE45ad151eeCd0a5532D6E489D034aB3B8"

from.account.accountAddress

string

required

Address of user's smart contract wallet (counterfactual if not yet deployed)

Example:

"0xa8305CAD3ECEA0E4B4a02CE45E240e8687B4C2E0"

from.asset

object

required

Asset to quote from. Choose between:

Aggregated assets: Let OneBalance optimize across chains (e.g., "ob:eth")
Chain-specific assets: Spend from exact tokens on specific chains (e.g., "eip155:1/erc20:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48")

Option 1
Option 2

Show child attributes

from.asset.assetId

string

required

The aggregated asset ID (e.g., ob:usd, ob:eth)

Example:

"ob:eth"

Example:

{ "assetId": "ob:eth" }

from.amount

string

Amount to quote (used for exact_input)

Example:

"1000000000000000000"

object

required

Target information for the quote

Show child attributes

to.asset

object

required

Asset to quote to. Choose between:

Aggregated assets: Let OneBalance find optimal destination (e.g., "ob:usdc")
Chain-specific assets: Target exact tokens on specific chains (e.g., "eip155:42161/erc20:0xaf88d065e77c8cC2239327C5EDb3A432268e5831")

Option 1
Option 2

Show child attributes

to.asset.assetId

string

required

The aggregated asset ID (e.g., ob:usd, ob:eth)

Example:

"ob:eth"

Example:

{ "assetId": "ob:usdc" }

to.account

string

CAIP account ID for the recipient (if transferring to another account)

Example:

"eip155:1:0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

to.amount

string

Amount to receive (used for exact_output)

Example:

"1000000"

slippageTolerance

integer

Slippage tolerance in basis points (1/100th of a percent). For example, 50 = 0.5%, 100 = 1%, 1000 = 10%.

Required range: x >= 1

Example:

50

Response

Quote

string

required

Unique identifier for the quote

Example:

"0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"

account

Role-based Account · object

required

Account details. Required to check the signature before sending on-chain

Role-based Account
Basic Account
EIP-7702 Account

Show child attributes

account.type

enum<string>

required

Account type identifier for role-based accounts

Available options:

role-based

Example:

"role-based"

account.sessionAddress

string

required

Address associated with user's ECDSA signing key used for session-based operations

Example:

"0x1cBFbFd62a276BF6D79d504eA4CA75a7baDcf5b1"

account.adminAddress

string

required

Address selected by the user as backup admin. Can perform rage quit and key rotation. Must be different from sessionAddress.

Example:

"0xc162a3cE45ad151eeCd0a5532D6E489D034aB3B8"

account.accountAddress

string

required

Address of user's smart contract wallet (counterfactual if not yet deployed)

Example:

"0xa8305CAD3ECEA0E4B4a02CE45E240e8687B4C2E0"

originChainsOperations

object[]

required

Information about the origin of the quote

Show child attributes

originChainsOperations.userOp

object

required

User Operation data (serialized).

Show child attributes

originChainsOperations.userOp.sender

string

required

The address of the sender (EOA or Smart Contract).

Example:

"0xb8e4b017f4a8870e3eb4eb15c5e180d2a34d877b"

originChainsOperations.userOp.nonce

string

required

Nonce for the UserOp, ensures uniqueness. Incremented for each operation.

Example:

"1120126849530..."

originChainsOperations.userOp.callData

string

required

Hex-encoded data representing the actual call to be made.

Example:

"0xe9ae5c530100000000000000000000000000..."

originChainsOperations.userOp.callGasLimit

string

required

Gas limit for executing the callData portion.

Example:

"737280"

originChainsOperations.userOp.verificationGasLimit

string

required

Gas limit for the verification step (signature checks, etc.).

Example:

"3076170"

originChainsOperations.userOp.preVerificationGas

string

required

Gas used for overhead, e.g., hashing, EVM overhead, etc.

Example:

"0"

originChainsOperations.userOp.maxFeePerGas

string

required

Maximum fee (in wei) per gas unit.

Example:

"0"

originChainsOperations.userOp.maxPriorityFeePerGas

string

required

Priority fee (tip) per gas unit.

Example:

"0"

originChainsOperations.userOp.paymaster

string

required

Address of the paymaster that will sponsor or pay for gas.

Example:

"0xa784e6482bd5edbfe5991b18cbd545ebd46e1cc4"

originChainsOperations.userOp.paymasterVerificationGasLimit

string

required

Gas limit for the paymaster verification step.

Example:

"19219"

originChainsOperations.userOp.paymasterPostOpGasLimit

string

required

Additional gas limit for the paymaster post-operation.

Example:

"0"

originChainsOperations.userOp.paymasterData

string

required

Additional data used by the paymaster, if any.

Example:

"0x"

originChainsOperations.userOp.signature

string

required

Signature for the entire user operation.

Example:

"0x8cbd9df26744e2a02cde9fb8832d2b5f..."

originChainsOperations.userOp.factory

string

The address of the factory that may be used to create an account contract (optional for deployed accounts).

Example:

"0xd703aae79538628d27099b8c4f621be4ccd142d5"

originChainsOperations.userOp.factoryData

string

Hex-encoded data for the factory (optional, if needed to deploy or initialize an account).

Example:

"0xc5265d5d000000000000000000000000..."

originChainsOperations.typedDataToSign

object

required

Typed data to sign (EIP-712).

Show child attributes

originChainsOperations.typedDataToSign.domain

object

required

EIP-712 domain separator data (e.g. name, version, chainId, verifyingContract).

Example:

{
  "name": "RoleBasedECDSAValidator",
  "version": "1.4.3",
  "chainId": 10,
  "verifyingContract": "0xA24bD06230f3F54e5bf266AE7A41750eE3b789FA"
}

originChainsOperations.typedDataToSign.types

object

required

EIP-712 type definitions for the message. Must include at least the primary type.

Example:

{
  "Approve": [
    {
      "name": "callDataAndNonceHash",
      "type": "bytes32"
    }
  ]
}

originChainsOperations.typedDataToSign.primaryType

string

required

Primary type string from the types object.

Example:

"Approve"

originChainsOperations.typedDataToSign.message

object

required

Data to be signed (structured according to the types).

Example:

{
  "callDataAndNonceHash": "0xaab2ddac63e4a7e25b7d339cacdff2f9..."
}

originChainsOperations.assetType

string

required

CAIP-19/CAIP-20 asset type, or e.g. "eth", "erc20:0x..." etc.

Example:

"eip155:10/erc20:0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85"

originChainsOperations.amount

string

required

Amount in the smallest unit (wei for ETH, or token decimals).

Example:

"8000000"

originChainsOperations.delegation

object

EIP-7702 delegation object (present only if account needs delegation on this chain).

Must be signed using wallet's signAuthorization method before submission.

Show child attributes

originChainsOperations.delegation.contractAddress

string

required

Address of the Kernel v3.3 smart account contract to delegate to

Example:

"0xd6CEDDe84be40893d153Be9d467CD6aD37875b28"

originChainsOperations.delegation.nonce

integer

required

Delegation nonce for preventing replay attacks. Must match the current nonce for the account on the target chain.

Required range: x >= 0

Example:

0

originChainsOperations.delegation.signature

object

Delegation signature (populated after signing with wallet's signAuthorization method)

Show child attributes

originChainsOperations.delegation.signature.chainId

integer

required

Chain ID where delegation occurs

Required range: x >= 1

Example:

10

originChainsOperations.delegation.signature.contractAddress

string

required

Contract address being delegated to (must match delegation contractAddress)

Example:

"0xd6CEDDe84be40893d153Be9d467CD6aD37875b28"

originChainsOperations.delegation.signature.nonce

integer

required

Delegation nonce (must match delegation nonce)

Required range: x >= 0

Example:

0

originChainsOperations.delegation.signature.r

string

required

ECDSA signature r value

Example:

"0x129b258b9d85f91dab87e488dea08e2803e88a96bb6a967d16fe158a09d95d0d"

originChainsOperations.delegation.signature.s

string

required

ECDSA signature s value

Example:

"0x52adbaca42ea5b316df5ac0a6ae5f544f5eb450d94c76164e27252101e22d3c3"

originChainsOperations.delegation.signature.v

string

required

ECDSA signature v value (recovery ID)

Example:

"0x1b"

originChainsOperations.delegation.signature.yParity

enum<integer>

required

Y parity of the signature point (0 or 1)

Available options:

0,

1

Example:

0

originChainsOperations.delegation.signature.type

enum<string>

required

Signature type identifier indicating the signature has been completed

Available options:

Signed

Example:

"Signed"

Example:

[
  {
    "userOp": {
      "sender": "0xb8e4b017f4a8870e3eb4eb15c5e180d2a34d877b",
      "nonce": "1120126849530300722547379539971600052481264750391572034956634531672621056",
      "callData": "0xe9ae5c53010000000000000000000000000000000000000000000000000000000000000000",
      "callGasLimit": "737280",
      "verificationGasLimit": "3076170",
      "preVerificationGas": "0",
      "maxFeePerGas": "0",
      "maxPriorityFeePerGas": "0",
      "paymaster": "0xa784e6482bd5edbfe5991b18cbd545ebd46e1cc4",
      "paymasterVerificationGasLimit": "19219",
      "paymasterPostOpGasLimit": "0",
      "paymasterData": "0x",
      "signature": "0x8cbd9df26744e2a02cde9fb8832d2b5f"
    },
    "typedDataToSign": {
      "domain": {
        "name": "RoleBasedECDSAValidator",
        "version": "1.4.3",
        "chainId": 10,
        "verifyingContract": "0xA24bD06230f3F54e5bf266AE7A41750eE3b789FA"
      },
      "types": {
        "Approve": [
          {
            "name": "callDataAndNonceHash",
            "type": "bytes32"
          }
        ]
      },
      "primaryType": "Approve",
      "message": {
        "callDataAndNonceHash": "0xaab2ddac63e4a7e25b7d339cacdff2f9280025cef27699ffe5f5e9e9625b15eb"
      }
    },
    "assetType": "eip155:10/erc20:0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
    "amount": "8000000"
  }
]

originToken

object

required

Source tokens

Show child attributes

originToken.aggregatedAssetId

string

required

The aggregated asset ID (e.g., ob:usd)

Example:

"ob:eth"

originToken.amount

string

required

The amount of the token

Example:

"1000000000000000000"

originToken.assetType

string[]

required

The type of the individual assets (e.g., eip155:1/erc20:... or eip155:1/slip44:...)

Example:

[
  "eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7",
  "eip155:1/slip44:60"
]

originToken.fiatValue

object[]

required

The fiat values of the individual asset types

Show child attributes

originToken.fiatValue.assetType

string

required

The CAIP-19 asset type identifier (e.g., eip155:1/erc20:... or eip155:1/slip44:...).

Example:

"eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7"

originToken.fiatValue.fiatValue

string

required

The fiat value of the individual asset in USD

Example:

"100"

Example:

[
  {
    "assetType": "eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7",
    "fiatValue": "1800.00"
  },
  {
    "assetType": "eip155:1/slip44:60",
    "fiatValue": "1800.00"
  }
]

destinationToken

object

required

Destination token

Show child attributes

destinationToken.aggregatedAssetId

string

required

The aggregated asset ID (e.g., ob:usd)

Example:

"ob:usdc"

destinationToken.amount

string

required

The amount of the token

Example:

"100000000"

destinationToken.assetType

string

required

The type of the individual asset (e.g., eip155:1/erc20:... or eip155:1/slip44:...)

Example:

"eip155:1/erc20:0xdac17f958d2ee523a2206206994597c13d831ec7"

destinationToken.fiatValue

string

required

The fiat value of the individual asset in USD

Example:

"100"

destinationToken.minimumAmount

string

The minimum amount of the token

Example:

"100"

destinationToken.minimumFiatValue

string

The minimum fiat value of the token

Example:

"100"

destinationToken.symbol

string

The token symbol (e.g., USDC, ETH)

Example:

"USDC"

destinationToken.name

string

The human-readable name of the token

Example:

"USDC"

destinationToken.decimals

integer

The number of decimal places for the token

Example:

18

destinationToken.recipientAccount

string

The recipient account address with chain identifier where the destination tokens will be received

Example:

"eip155:42161:0x895Cf62399bF1F8b88195E741b64278b41EB7F09"

expirationTimestamp

string

required

UNIX timestamp of when the quote gets stale

Example:

"1686239400"

tamperProofSignature

string

required

Signature to ensure the quote hasn't been tampered with

Example:

"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"

destinationChainOperation

object

The operation that will be executed on the destination chain if an arbitrary execution is requested

Show child attributes

destinationChainOperation.userOp

object

required

User Operation data (serialized).

Show child attributes

destinationChainOperation.userOp.sender

string

required

The address of the sender (EOA or Smart Contract).

Example:

"0xb8e4b017f4a8870e3eb4eb15c5e180d2a34d877b"

destinationChainOperation.userOp.nonce

string

required

Nonce for the UserOp, ensures uniqueness. Incremented for each operation.

Example:

"1120126849530..."

destinationChainOperation.userOp.callData

string

required

Hex-encoded data representing the actual call to be made.

Example:

"0xe9ae5c530100000000000000000000000000..."

destinationChainOperation.userOp.callGasLimit

string

required

Gas limit for executing the callData portion.

Example:

"737280"

destinationChainOperation.userOp.verificationGasLimit

string

required

Gas limit for the verification step (signature checks, etc.).

Example:

"3076170"

destinationChainOperation.userOp.preVerificationGas

string

required

Gas used for overhead, e.g., hashing, EVM overhead, etc.

Example:

"0"

destinationChainOperation.userOp.maxFeePerGas

string

required

Maximum fee (in wei) per gas unit.

Example:

"0"

destinationChainOperation.userOp.maxPriorityFeePerGas

string

required

Priority fee (tip) per gas unit.

Example:

"0"

destinationChainOperation.userOp.paymaster

string

required

Address of the paymaster that will sponsor or pay for gas.

Example:

"0xa784e6482bd5edbfe5991b18cbd545ebd46e1cc4"

destinationChainOperation.userOp.paymasterVerificationGasLimit

string

required

Gas limit for the paymaster verification step.

Example:

"19219"

destinationChainOperation.userOp.paymasterPostOpGasLimit

string

required

Additional gas limit for the paymaster post-operation.

Example:

"0"

destinationChainOperation.userOp.paymasterData

string

required

Additional data used by the paymaster, if any.

Example:

"0x"

destinationChainOperation.userOp.signature

string

required

Signature for the entire user operation.

Example:

"0x8cbd9df26744e2a02cde9fb8832d2b5f..."

destinationChainOperation.userOp.factory

string

The address of the factory that may be used to create an account contract (optional for deployed accounts).

Example:

"0xd703aae79538628d27099b8c4f621be4ccd142d5"

destinationChainOperation.userOp.factoryData

string

Hex-encoded data for the factory (optional, if needed to deploy or initialize an account).

Example:

"0xc5265d5d000000000000000000000000..."

destinationChainOperation.typedDataToSign

object

required

Typed data to sign (EIP-712).

Show child attributes

destinationChainOperation.typedDataToSign.domain

object

required

EIP-712 domain separator data (e.g. name, version, chainId, verifyingContract).

Example:

{
  "name": "RoleBasedECDSAValidator",
  "version": "1.4.3",
  "chainId": 10,
  "verifyingContract": "0xA24bD06230f3F54e5bf266AE7A41750eE3b789FA"
}

destinationChainOperation.typedDataToSign.types

object

required

EIP-712 type definitions for the message. Must include at least the primary type.

Example:

{
  "Approve": [
    {
      "name": "callDataAndNonceHash",
      "type": "bytes32"
    }
  ]
}

destinationChainOperation.typedDataToSign.primaryType

string

required

Primary type string from the types object.

Example:

"Approve"

destinationChainOperation.typedDataToSign.message

object

required

Data to be signed (structured according to the types).

Example:

{
  "callDataAndNonceHash": "0xaab2ddac63e4a7e25b7d339cacdff2f9..."
}

destinationChainOperation.assetType

string

required

CAIP-19/CAIP-20 asset type, or e.g. "eth", "erc20:0x..." etc.

Example:

"eip155:10/erc20:0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85"

destinationChainOperation.amount

string

required

Amount in the smallest unit (wei for ETH, or token decimals).

Example:

"8000000"

destinationChainOperation.delegation

object

EIP-7702 delegation object (present only if account needs delegation on this chain).

Must be signed using wallet's signAuthorization method before submission.

Show child attributes

destinationChainOperation.delegation.contractAddress

string

required

Address of the Kernel v3.3 smart account contract to delegate to

Example:

"0xd6CEDDe84be40893d153Be9d467CD6aD37875b28"

destinationChainOperation.delegation.nonce

integer

required

Delegation nonce for preventing replay attacks. Must match the current nonce for the account on the target chain.

Required range: x >= 0

Example:

0

destinationChainOperation.delegation.signature

object

Delegation signature (populated after signing with wallet's signAuthorization method)

Show child attributes

destinationChainOperation.delegation.signature.chainId

integer

required

Chain ID where delegation occurs

Required range: x >= 1

Example:

10

destinationChainOperation.delegation.signature.contractAddress

string

required

Contract address being delegated to (must match delegation contractAddress)

Example:

"0xd6CEDDe84be40893d153Be9d467CD6aD37875b28"

destinationChainOperation.delegation.signature.nonce

integer

required

Delegation nonce (must match delegation nonce)

Required range: x >= 0

Example:

0

destinationChainOperation.delegation.signature.r

string

required

ECDSA signature r value

Example:

"0x129b258b9d85f91dab87e488dea08e2803e88a96bb6a967d16fe158a09d95d0d"

destinationChainOperation.delegation.signature.s

string

required

ECDSA signature s value

Example:

"0x52adbaca42ea5b316df5ac0a6ae5f544f5eb450d94c76164e27252101e22d3c3"

destinationChainOperation.delegation.signature.v

string

required

ECDSA signature v value (recovery ID)

Example:

"0x1b"

destinationChainOperation.delegation.signature.yParity

enum<integer>

required

Y parity of the signature point (0 or 1)

Available options:

0,

1

Example:

0

destinationChainOperation.delegation.signature.type

enum<string>

required

Signature type identifier indicating the signature has been completed

Available options:

Signed

Example:

"Signed"

API Reference

EVM Operations

Multi-Chain Operations

Platform Data

Authorizations

Body

Response