API

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

PreviousNew Chains NextAudits

Last updated 14 days ago

Get intents

Retrieves a paginated list of intents based on query parameters

get

/intents

Query parameters

cursorstring

prevCursorstring

limitinteger

statusesstring[]

originsstring[]

destinationsstring[]

allDestinationsstring[]

txHashstring

userAddressstring

startDatestring

endDatestring

assetstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/intents'

200

400

500

{
  "nextCursor": "text",
  "prevCursor": "text",
  "maxCount": 1,
  "intents": [
    {
      "intent_id": "text",
      "queue_idx": 1,
      "message_id": "text",
      "status": "NONE",
      "receiver": "text",
      "input_asset": "text",
      "output_asset": "text",
      "origin_amount": "text",
      "destination_amount": "text",
      "origin": "text",
      "nonce": 1,
      "transaction_hash": "text",
      "receive_tx_hash": "text",
      "intent_created_timestamp": 1,
      "settlement_timestamp": 1,
      "intent_created_block_number": 1,
      "receive_blocknumber": 1,
      "tx_origin": "text",
      "tx_nonce": 1,
      "auto_id": 1,
      "max_fee": "text",
      "call_data": "text",
      "filled": true,
      "initiator": "text",
      "origin_gas_fees": "text",
      "destination_gas_fees": "text",
      "hub_settlement_domain": "text",
      "ttl": 1,
      "destinations": [
        "text"
      ]
    }
  ]
}

Successful retrieval of intents

Create new intent

Endpoint to generate a TransactionRequest for a newIntent

post

/intents

Body

originstringrequired

tostringrequired

inputAssetstringrequired

amountstring · bigintrequired

callDatastringrequired

maxFeestring · bigintrequired

destinationsstring[]required

permit2Paramsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.testnet.everclear.org/intents' \
  --header 'Content-Type: application/json' \
  --data '{"origin":"text","to":"text","inputAsset":"text","amount":"text","callData":"text","maxFee":"text","destinations":[null],"permit2Params":{"nonce":"text","deadline":"text","signature":"text"}}'

200

400

404

500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "text",
  "value": "text",
  "chainId": 1,
  "type": 1,
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ccipReadEnabled": true,
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ]
}

Successful response with a TransactionRequest object

Get intent details

Fetches detailed information for a specified intent by its ID

get

/intents/{intentId}

Path parameters

intentIdstringrequired

The unique identifier for the intent

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/intents/{intentId}'

200

400

500

{
  "intent": {
    "intent_id": "text",
    "queue_idx": 1,
    "message_id": "text",
    "status": "NONE",
    "receiver": "text",
    "input_asset": "text",
    "output_asset": "text",
    "origin_amount": "text",
    "destination_amount": "text",
    "origin": "text",
    "nonce": 1,
    "transaction_hash": "text",
    "receive_tx_hash": "text",
    "intent_created_timestamp": 1,
    "settlement_timestamp": 1,
    "intent_created_block_number": 1,
    "receive_blocknumber": 1,
    "tx_origin": "text",
    "tx_nonce": 1,
    "auto_id": 1,
    "max_fee": "text",
    "call_data": "text",
    "filled": true,
    "initiator": "text",
    "origin_gas_fees": "text",
    "destination_gas_fees": "text",
    "hub_settlement_domain": "text",
    "ttl": 1,
    "destinations": [
      "text"
    ]
  }
}

Successful retrieval of intent details

Update max fee

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

post

/intents/{intentId}

Path parameters

intentIdstringrequired

The unique identifier for the intent

Body

feeAssetInNativeboolean | nullable

maxFeestring · bigintrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.testnet.everclear.org/intents/{intentId}' \
  --header 'Content-Type: application/json' \
  --data '{"maxFee":"text"}'

200

400

500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "text",
  "value": "text",
  "chainId": 1,
  "type": 1,
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ccipReadEnabled": true,
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ]
}

Successful response with a TransactionRequest object

Execute calldata

The request object for executeIntentCalldata, used for self-execution

post

/intents/{intentId}/execute

Path parameters

intentIdstringrequired

The unique identifier for the intent

Body

domainstringrequired

The domain for the request

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.testnet.everclear.org/intents/{intentId}/execute' \
  --header 'Content-Type: application/json' \
  --data '{"domain":"text"}'

200

400

500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "text",
  "value": "text",
  "chainId": 1,
  "type": 1,
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ccipReadEnabled": true,
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ]
}

Successful response with a TransactionRequest object

Return unsupported intent

The request object for returnUnsupportedIntent on hub domain

post

/intents/{intentId}/return-unsupported

Path parameters

intentIdstringrequired

The unique identifier for the intent

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.testnet.everclear.org/intents/{intentId}/return-unsupported'

200

400

500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "text",
  "value": "text",
  "chainId": 1,
  "type": 1,
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ccipReadEnabled": true,
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ]
}

Successful response with a TransactionRequest object

Get invoices

Retrieves a paginated list of invoices in FIFO queue order

get

/invoices

Query parameters

cursorstring

prevCursorstring

limitinteger

tickerHashstring

originsstring[]

destinationsstring[]

sortOrderByDiscountstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/invoices'

200

400

500

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

Successful retrieval of invoices

Return invoice details

Fetches detailed information for a specified invoice by its intentID

get

/invoices/{intentId}

Path parameters

intentIdstringrequired

The unique identifier for the intent

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/invoices/{intentId}'

200

400

500

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

Successful retrieval of invoice details

Calculate minimum amounts needed to settle invoice

Calculates the minimum amounts per destination domain to settle a specified invoice

get

/invoices/{intentId}/min-amounts

Path parameters

intentIdstringrequired

The unique identifier for the invoice intent

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/invoices/{intentId}/min-amounts'

200

400

500

{
  "invoiceAmount": "text",
  "discountBps": "text",
  "amountAfterDiscounts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "custodiedAmounts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "minAmounts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Successful calculation of minimum amounts

Withdraw balance

The request object to withdraw from the protocol

post

/withdraw

Body

assetstringrequired

domainstringrequired

amountstring · bigintrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.testnet.everclear.org/withdraw' \
  --header 'Content-Type: application/json' \
  --data '{"asset":"text","domain":"text","amount":"text"}'

200

400

500

{
  "to": "text",
  "from": "text",
  "nonce": "text",
  "gasLimit": "text",
  "gasPrice": "text",
  "data": "text",
  "value": "text",
  "chainId": 1,
  "type": 1,
  "maxPriorityFeePerGas": "text",
  "maxFeePerGas": "text",
  "customData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ccipReadEnabled": true,
  "accessList": [
    {
      "address": "text",
      "storageKeys": [
        "text"
      ]
    }
  ]
}

Successful response with a TransactionRequest object

Get supported assets

Lists assets supported by the protocol, with pagination and optional filtering by type

get

/configs/assets

Query parameters

pageintegerrequired

limitintegerrequired

typestring · enum

Options: xERC20, other

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/configs/assets?page=1&limit=1'

200

400

500

{
  "assets": [
    {
      "local": "text",
      "adopted": "text",
      "canonical_id": "text",
      "canonical_domain": "text",
      "domain": "text",
      "key": "text",
      "id": "text",
      "decimal": 1,
      "adopted_decimal": 1
    }
  ]
}

Successful retrieval of assets

Get liquidity flow metrics

Returns the liquidity flow for all chains, optionally filtered by asset, from_chain, and to_chain.

get

/metrics/liquidity-flow

Query parameters

start_datestring · date

The start date for the query (default to the protocol's start date).

end_datestring · date

The end date for the query (default to the current date).

tickerHashstring

The symbol of the asset for which you want to get liquidity flow (e.g., "WETH", "USDC"). If omitted, returns data for all assets.

origininteger

The originating chain ID. If omitted, returns data for all chains.

destinationinteger

The destination chain ID. If omitted, returns data for all chains.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/metrics/liquidity-flow'

200

400

500

{
  "data": [
    {
      "asset_symbol": "text",
      "liquidity_flows": [
        {
          "day": "2025-02-21T20:55:12.650Z",
          "from_chain_id": 1,
          "to_chain_id": 1,
          "total_volume": 1,
          "num_intents": 1,
          "avg_protocol_fee_bps": 1,
          "avg_settlement_time_seconds": 1,
          "avg_discount": 1
        }
      ]
    }
  ]
}

A list of liquidity flows for the specified query parameters.

Get clearing volume metrics

Returns the total clearing volume for all chains, optionally filtered by date, origin, destination, and ticker hash.

get

/metrics/clearing-volume

Query parameters

start_datestring · date

The start date for the query (defaults to the protocol's start date).

end_datestring · date

The end date for the query (defaults to the current day).

origininteger

The originating chain ID. If omitted, returns data for all chains.

destinationinteger

The destination chain ID. If omitted, returns data for all chains.

tickerHashstring

The ticker hash of the asset for which you want to get the clearing volume. If omitted, returns data for all assets.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/metrics/clearing-volume'

200

400

500

{
  "data": {
    "start_date": "2025-02-21",
    "end_date": "2025-02-21",
    "assets": [
      {
        "asset_symbol": "text",
        "total_clearing_volume": 1,
        "total_rebalancing_fees": 1,
        "total_num_intents": 1,
        "details": [
          {
            "day": "2025-02-21T20:55:12.650Z",
            "clearing_volume": 1,
            "rebalancing_fees": 1,
            "num_intents": 1,
            "from_chain_id": 1,
            "to_chain_id": 1,
            "total_volume": 1
          }
        ]
      }
    ]
  }
}

A list of clearing volumes for the specified query parameters.

Get supply and demand information for a specified asset on a chain

Retrieves information about pending demand and supply for a specified asset on a chain, using both contract and database data. Includes details from DepositQ, InvoiceQ, and incoming intents.

get

/economy/{chain}//{tickerHash}

Path parameters

chainstringrequired

The blockchain network identifier.

tickerHashstringrequired

The asset ticker on the specified chain.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/economy/{chain}/{tickerHash}'

200

400

500

{
  "currentEpoch": {
    "epoch": 1,
    "startBlock": 1,
    "endBlock": 1
  },
  "invoiceQueue": [
    {
      "intentId": "text",
      "amount": "text",
      "owner": "text",
      "entryEpoch": 1
    }
  ],
  "depositQueue": [
    {
      "intentId": "text",
      "origin": 1,
      "amount": "text",
      "epoch": 1
    }
  ],
  "incomingIntents": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "intentId": "text",
        "initiator": "text",
        "amount": "text",
        "destinations": [
          "text"
        ]
      }
    ]
  }
}

The current state of the queue and intents.

Get history of intent processing

Retrieves detailed history of a specific intent, including epochs and details of processing as deposit and invoice.

get

/history/{intentId}

Path parameters

intentIdstringrequired

Unique identifier for the intent.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/history/{intentId}'

200

400

404

500

{
  "hubProcessedEpoch": 100,
  "depositEnqueued": {
    "epoch": 100,
    "amount": 999
  },
  "invoiceEnqueued": {
    "epoch": 101,
    "amount": 399
  },
  "settlementEnqueued": {
    "epoch": 100,
    "amount": 999
  },
  "depositDetails": {
    "amountAfterFees": 1,
    "rewards": 1,
    "selectedDestination": 97,
    "isSettled": true
  },
  "matchedInvoices": [
    {
      "invoiceIntentId": "0x11",
      "invoiceRemainingAmount": "0",
      "depositRewards": "500"
    }
  ],
  "matchedDeposits": [
    {
      "depositIntentId": "text",
      "invoiceRemainingAmount": 1,
      "depositRewards": 1
    }
  ]
}

Successful response with queue and intent state information.

Get history of invoice processing

Retrieves detailed history of a specific invoice, including epochs and details of processing as deposit and invoice.

get

/history/{intentId}/invoice-processing

Path parameters

intentIdstringrequired

Unique identifier for the intent.

Query parameters

cursorstring

limitnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.testnet.everclear.org/history/{intentId}/invoice-processing'

200

400

500

{
  "nextCursor": "text",
  "invoiceProcessingHistory": [
    {
      "epoch": 1,
      "domain": 1,
      "custodiedAssets": 1,
      "amountToBeDiscounted": 1,
      "rewardsForDepositors": 1,
      "amountAfterDiscount": 1,
      "discountdbps": 1,
      "selectedDestinationDomain": 1,
      "selectedDestinationDomainLiquidity": 1,
      "timestamp": "text"
    }
  ]
}

Successful response with history of invoice processing