GET
/
v3
/
status
/
get-execution-status
Get quote status
curl --request GET \
  --url https://be.onebalance.io/api/v3/status/get-execution-status \
  --header 'x-api-key: <api-key>'
{
  "quoteId": "0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d",
  "status": "COMPLETED",
  "user": "0x9b747cC14A5672a7166b4eccdc92d7F4003f8081",
  "recipientAccountId": "eip155:1/0x9b747cC14A5672a7166b4eccdc92d7F4003f8081",
  "originChainOperations": [
    {
      "hash": "0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d",
      "chain": "eip155:1",
      "explorerUrl": "https://etherscan.io/tx/0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
    }
  ],
  "destinationChainOperations": [
    {
      "hash": "0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d",
      "chain": "eip155:1",
      "explorerUrl": "https://etherscan.io/tx/0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
    }
  ]
}

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.

Query Parameters

​
quoteId
string
required

The ID of the quote to retrieve the status for

Example:

"0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"

Response

Successfully retrieved the quote status

Status response for v3 endpoints with CAIP-2 chain identifiers

​
quoteId
string
required

Quote ID of the execution

Example:

"0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"

​
status
enum<string>
required

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
Available options:
PENDING,
IN_PROGRESS,
EXECUTED,
COMPLETED,
REFUNDED,
FAILED
Example:

"COMPLETED"

​
user
string
required

The address of the user that initiated the quote (EVM hex format or Solana base58 format)

Example:

"0x9b747cC14A5672a7166b4eccdc92d7F4003f8081"

​
recipientAccountId
string
required

The CAIP-10 address of the recipient

Example:

"eip155:1/0x9b747cC14A5672a7166b4eccdc92d7F4003f8081"

​
originChainOperations
object[]
required

The asset(s) that were sent from the source

Example:
[
  {
    "hash": "0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d",
    "chain": "eip155:1",
    "chainId": 1,
    "explorerUrl": "https://etherscan.io/tx/0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
  }
]
​
destinationChainOperations
object[]

Destination chain operations

Example:
[
  {
    "hash": "0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d",
    "chain": "eip155:42161",
    "chainId": 42161,
    "explorerUrl": "https://arbiscan.io/tx/0xfa6094cd9d65416c975e3498cc5c2ca17df6c4cfa37e16f84f2736296dd98b5d"
  }
]