API

The Everclear API contains endpoints to create new intents, track intent statuses, and more.

Testnet API: https://api.testnet.everclear.org

Mainnet API: https://api.everclear.org

Get intents

Retrieves a paginated list of intents based on query parameters

GEThttps://api.testnet.everclear.org/intents

Query parameters

Response

200400500

Successful retrieval of intents

Body

application/json

intents*array of Intent (object)

nextCursor*nullable string

prevCursor*nullable string

maxCount*number

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/intents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "intents": [
    {
      "intent_id": "text",
      "message_id": "text",
      "status": "NONE",
      "receiver": "text",
      "input_asset": "text",
      "output_asset": "text",
      "origin_amount": "text",
      "destination_amount": "text",
      "origin": "text",
      "destinations": [
        "text"
      ],
      "transaction_hash": "text",
      "receive_tx_hash": "text",
      "tx_origin": "text",
      "max_fee": "text",
      "call_data": "text",
      "filled": false,
      "initiator": "text",
      "origin_gas_fees": "text",
      "destination_gas_fees": "text",
      "hub_settlement_domain": "text",
      "ttl": 0
    }
  ],
  "nextCursor": "text",
  "prevCursor": "text",
  "maxCount": 0
}

Create new intent

Endpoint to generate a TransactionRequest for a newIntent

POSThttps://api.testnet.everclear.org/intents

Body

application/json

origin*string

destinations*array of string

to*string

inputAsset*string

amount*string (bigint)

callData*string

maxFee*string (bigint)

permit2Paramsobject

Response

200400404500

Successful response with a TransactionRequest object

Body

application/json

to*nullable string

fromnullable string

noncestring (bigint)

gasLimitstring (bigint)

gasPricestring (bigint)

data*string (byte)

valuestring (bigint)

chainId*integer

typenullable integer

accessListnullable array of object

maxPriorityFeePerGasnullable string (bigint)

maxFeePerGasnullable string (bigint)

customDatanullable object

ccipReadEnablednullable boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/intents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "origin": "text",
      "destinations": [
        "text"
      ],
      "to": "text",
      "inputAsset": "text",
      "amount": "text",
      "callData": "text",
      "maxFee": "text"
    }),
});
const data = await response.json();

Response

200400404500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "Ynl0ZXM=",
  "value": "text",
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ],
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "ccipReadEnabled": false
}

Get intent details

Fetches detailed information for a specified intent by its ID

GEThttps://api.testnet.everclear.org/intents/{intentId}

Path parameters

intentId*string

The unique identifier for the intent

Response

200400500

Successful retrieval of intent details

Body

application/json

intentIntent (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/intents/{intentId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "intent": {
    "intent_id": "text",
    "message_id": "text",
    "status": "NONE",
    "receiver": "text",
    "input_asset": "text",
    "output_asset": "text",
    "origin_amount": "text",
    "destination_amount": "text",
    "origin": "text",
    "destinations": [
      "text"
    ],
    "transaction_hash": "text",
    "receive_tx_hash": "text",
    "tx_origin": "text",
    "max_fee": "text",
    "call_data": "text",
    "filled": false,
    "initiator": "text",
    "origin_gas_fees": "text",
    "destination_gas_fees": "text",
    "hub_settlement_domain": "text",
    "ttl": 0
  }
}

Update max fee

Updates the max fee for a specified intent and returns a TransactionRequest object

POSThttps://api.testnet.everclear.org/intents/{intentId}

Path parameters

intentId*string

The unique identifier for the intent

Body

application/json

feeAssetInNativenullable boolean

maxFee*string (bigint)

Response

200400500

Successful response with a TransactionRequest object

Body

application/json

to*nullable string

fromnullable string

noncestring (bigint)

gasLimitstring (bigint)

gasPricestring (bigint)

data*string (byte)

valuestring (bigint)

chainId*integer

typenullable integer

accessListnullable array of object

maxPriorityFeePerGasnullable string (bigint)

maxFeePerGasnullable string (bigint)

customDatanullable object

ccipReadEnablednullable boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/intents/{intentId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "maxFee": "text"
    }),
});
const data = await response.json();

Response

200400500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "Ynl0ZXM=",
  "value": "text",
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ],
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "ccipReadEnabled": false
}

Execute calldata

The request object for executeIntentCalldata, used for self-execution

POSThttps://api.testnet.everclear.org/intents/{intentId}/execute

Path parameters

intentId*string

The unique identifier for the intent

Body

application/json

domain*string

The domain for the request

Response

200400500

Successful response with a TransactionRequest object

Body

application/json

to*nullable string

fromnullable string

noncestring (bigint)

gasLimitstring (bigint)

gasPricestring (bigint)

data*string (byte)

valuestring (bigint)

chainId*integer

typenullable integer

accessListnullable array of object

maxPriorityFeePerGasnullable string (bigint)

maxFeePerGasnullable string (bigint)

customDatanullable object

ccipReadEnablednullable boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/intents/{intentId}/execute', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "domain": "text"
    }),
});
const data = await response.json();

Response

200400500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "Ynl0ZXM=",
  "value": "text",
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ],
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "ccipReadEnabled": false
}

Return unsupported intent

The request object for returnUnsupportedIntent on hub domain

POSThttps://api.testnet.everclear.org/intents/{intentId}/return-unsupported

Path parameters

intentId*string

The unique identifier for the intent

Response

200400500

Successful response with a TransactionRequest object

Body

application/json

to*nullable string

fromnullable string

noncestring (bigint)

gasLimitstring (bigint)

gasPricestring (bigint)

data*string (byte)

valuestring (bigint)

chainId*integer

typenullable integer

accessListnullable array of object

maxPriorityFeePerGasnullable string (bigint)

maxFeePerGasnullable string (bigint)

customDatanullable object

ccipReadEnablednullable boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/intents/{intentId}/return-unsupported', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "Ynl0ZXM=",
  "value": "text",
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ],
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "ccipReadEnabled": false
}

Get invoices

Retrieves a paginated list of invoices in FIFO queue order

GEThttps://api.testnet.everclear.org/invoices

Query parameters

Response

200400500

Successful retrieval of invoices

Body

application/json

invoices*array of Invoice (object)

nextCursor*nullable string

prevCursor*nullable string

maxCount*number

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/invoices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "invoices": [
    {
      "intent_id": "text",
      "owner": "text",
      "amount": "text",
      "origin": "text",
      "destinations": [
        "text"
      ],
      "hub_status": "NONE",
      "ticker_hash": "text",
      "hub_invoice_enqueued_timestamp": "text"
    }
  ],
  "nextCursor": "text",
  "prevCursor": "text",
  "maxCount": 0
}

Return invoice details

Fetches detailed information for a specified invoice by its intentID

GEThttps://api.testnet.everclear.org/invoices/{intentId}

Path parameters

intentId*string

The unique identifier for the intent

Response

200400500

Successful retrieval of invoice details

Body

application/json

invoiceInvoice (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/invoices/{intentId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "invoice": {
    "intent_id": "text",
    "owner": "text",
    "amount": "text",
    "origin": "text",
    "destinations": [
      "text"
    ],
    "hub_status": "NONE",
    "ticker_hash": "text",
    "hub_invoice_enqueued_timestamp": "text"
  }
}

Withdraw balance

The request object to withdraw from the protocol

POSThttps://api.testnet.everclear.org/withdraw

Body

application/json

asset*string

domain*string

amount*string (bigint)

Response

200400500

Successful response with a TransactionRequest object

Body

application/json

to*nullable string

fromnullable string

noncestring (bigint)

gasLimitstring (bigint)

gasPricestring (bigint)

data*string (byte)

valuestring (bigint)

chainId*integer

typenullable integer

accessListnullable array of object

maxPriorityFeePerGasnullable string (bigint)

maxFeePerGasnullable string (bigint)

customDatanullable object

ccipReadEnablednullable boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.testnet.everclear.org/withdraw', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "asset": "text",
      "amount": "text",
      "domain": "text"
    }),
});
const data = await response.json();

Response

200400500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "Ynl0ZXM=",
  "value": "text",
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ],
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "ccipReadEnabled": false
}