API

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

PreviousNew Chains NextAudits

Last updated 1 month ago

Get intents

get

Retrieves a paginated list of intents based on query parameters

Query parameters

cursorstringOptional

prevCursorstringOptional

limitintegerOptional

statusesstring[]Optional

originsstring[]Optional

destinationsstring[]Optional

allDestinationsstring[]Optional

txHashstringOptional

userAddressstringOptional

startDatestringOptional

endDatestringOptional

assetstringOptional

Responses

application/json

objectOptional

application/json

get

GET /intents HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

{
  "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",
      "destinations": [
        "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
    }
  ],
  "nextCursor": "text",
  "prevCursor": "text",
  "maxCount": 1
}

Get intent details

get

Fetches detailed information for a specified intent by its ID

Path parameters

intentIdstringRequired

The unique identifier for the intent

Responses

application/json

objectOptional

application/json

get

GET /intents/{intentId} HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

{
  "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",
    "destinations": [
      "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
  }
}

Return unsupported intent

post

The request object for returnUnsupportedIntent on hub domain

Path parameters

intentIdstringRequired

The unique identifier for the intent

Responses

application/json

objectOptional

application/json

post

POST /intents/{intentId}/return-unsupported HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

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

Get invoices

get

Retrieves a paginated list of invoices in FIFO queue order

Query parameters

cursorstringOptional

prevCursorstringOptional

limitintegerOptional

tickerHashstringOptional

originsstring[]Optional

destinationsstring[]Optional

sortOrderByDiscountstringOptional

Responses

application/json

objectOptional

application/json

get

GET /invoices HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

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

Return invoice details

get

Fetches detailed information for a specified invoice by its intentID

Path parameters

intentIdstringRequired

The unique identifier for the intent

Responses

application/json

objectOptional

application/json

get

GET /invoices/{intentId} HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

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

Calculate minimum amounts needed to settle invoice

get

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

Path parameters

intentIdstringRequired

The unique identifier for the invoice intent

Responses

application/json

objectOptional

application/json

get

GET /invoices/{intentId}/min-amounts HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

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

Get liquidity flow metrics

get

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

Query parameters

start_datestring · dateOptional

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

end_datestring · dateOptional

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

tickerHashstringOptional

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

originintegerOptional

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

destinationintegerOptional

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

Responses

application/json

objectOptional

application/json

get

GET /metrics/liquidity-flow HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

{
  "data": [
    {
      "asset_symbol": "text",
      "liquidity_flows": [
        {
          "day": "2025-04-18T19:06:22.865Z",
          "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
        }
      ]
    }
  ]
}

Get clearing volume metrics

get

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

Query parameters

start_datestring · dateOptional

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

end_datestring · dateOptional

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

originintegerOptional

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

destinationintegerOptional

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

tickerHashstringOptional

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

objectOptional

application/json

get

GET /metrics/clearing-volume HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

{
  "data": {
    "start_date": "2025-04-18",
    "end_date": "2025-04-18",
    "assets": [
      {
        "asset_symbol": "text",
        "total_clearing_volume": 1,
        "total_rebalancing_fees": 1,
        "total_num_intents": 1,
        "details": [
          {
            "day": "2025-04-18T19:06:22.865Z",
            "clearing_volume": 1,
            "rebalancing_fees": 1,
            "num_intents": 1,
            "from_chain_id": 1,
            "to_chain_id": 1,
            "total_volume": 1
          }
        ]
      }
    ]
  }
}

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

get

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.

Path parameters

chainstringRequired

The blockchain network identifier.

tickerHashstringRequired

The asset ticker on the specified chain.

Responses

application/json

objectOptional

get

GET /economy/{chain}/{tickerHash} HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

{
  "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"
        ]
      }
    ]
  }
}

Get history of intent processing

get

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

Path parameters

intentIdstringRequired

Unique identifier for the intent.

Responses

application/json

objectOptional

get

GET /history/{intentId} HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

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

Get history of invoice processing

get

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

Path parameters

intentIdstringRequired

Unique identifier for the intent.

Query parameters

cursorstringOptional

limitnumberOptional

Responses

application/json

objectOptional

get

GET /history/{intentId}/invoice-processing HTTP/1.1
Host: api.testnet.everclear.org
Accept: */*

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

Create new intent

post

Endpoint to generate a TransactionRequest for a newIntent

Body

originstringRequired

destinationsstring[]Required

tostringRequired

inputAssetstringRequired

amountstring · bigintRequired

callDatastringRequired

maxFeestring · bigintRequired

permit2ParamsobjectOptional

Responses

application/json

objectOptional

application/json

post

POST /intents HTTP/1.1
Host: api.testnet.everclear.org
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "origin": "text",
  "destinations": [
    "text"
  ],
  "to": "text",
  "inputAsset": "text",
  "amount": "text",
  "callData": "text",
  "maxFee": "text",
  "permit2Params": {
    "nonce": "text",
    "deadline": "text",
    "signature": "text"
  }
}

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

Update max fee

post

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

Path parameters

intentIdstringRequired

The unique identifier for the intent

Body

feeAssetInNativeboolean | nullableOptional

maxFeestring · bigintRequired

Responses

application/json

objectOptional

application/json

post

POST /intents/{intentId} HTTP/1.1
Host: api.testnet.everclear.org
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "feeAssetInNative": true,
  "maxFee": "text"
}

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

Execute calldata

post

The request object for executeIntentCalldata, used for self-execution

Path parameters

intentIdstringRequired

The unique identifier for the intent

Body

domainstringRequired

The domain for the request

Responses

application/json

objectOptional

application/json

post

POST /intents/{intentId}/execute HTTP/1.1
Host: api.testnet.everclear.org
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "domain": "text"
}

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

Withdraw balance

post

The request object to withdraw from the protocol

Body

assetstringRequired

domainstringRequired

amountstring · bigintRequired

Responses

application/json

objectOptional

application/json

post

POST /withdraw HTTP/1.1
Host: api.testnet.everclear.org
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "asset": "text",
  "domain": "text",
  "amount": "text"
}

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