API

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

circle-check

Create new intent(s)

post
/intents

Endpoint to generate a TransactionRequest for one or multiple intents. For multiple intents, the transaction will target a fee adapter contract with appropriately formatted calldata.

Body
or
Responses
chevron-right
200

Successful response with a TransactionRequest object

application/json
post
/intents

Get intents

get
/batched-intents

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
tickerHashstringOptional
isFastPathbooleanOptional

Filter for fast path intents (intents with TTL > 0)

Responses
chevron-right
200

Successful retrieval of intents

application/json
get
/batched-intents

Get batched intents

get
/batched-intents/{batchId}

Retrieves a list of intents for a given batch ID

Path parameters
batchIdstringRequired
Responses
chevron-right
200

Successful retrieval of intents

application/json
get
/batched-intents/{batchId}

Create a new intent on Solana

post
/solana/intents

Submits a new intent transaction to the Solana blockchain using the specified parameters and configuration.

Body
originstringRequired
destinationsstring[]Required
tostringRequired
fromstringOptional

intent creator address

inputAssetstringRequired
amountstring · bigintRequired

Token amount, denominated in the asset's decimal units on the origin chain

callDatastringRequired
maxFeestring · bigintRequired

Maximum fee amount, denominated in the asset's decimal units on the origin chain

userstringRequired
userTokenAccountPublicKeystringOptional
programVaultAccountPublicKeystringOptional
order_idstringOptional

Order ID for newOrder requests

Responses
chevron-right
200

Successfully created intent transaction

application/json
post
/solana/intents

To create lookup tables for new account + asset

post
/solana/create-lookup-table

Creating lookup tables for new users to save account space on chain

Body
inputAssetstringRequired
userstringRequired
userTokenAccountPublicKeystringRequired
programVaultAccountPublicKeystringRequired
Responses
chevron-right
200

Succesfull serialise data fetch transaction data

application/json
post
/solana/create-lookup-table

Create a new intent on Tron

post
/tron/intents

Submits a new intent transaction to the Tron blockchain using the specified parameters and configuration.

Body
originstringRequired
destinationsstring[]Required
tostringRequired
fromstringOptional

intent creator address

inputAssetstringRequired
outputAssetstringOptional
amountstring · bigintRequired

Input asset amount, denominated in the asset's decimal units on the origin chain

callDatastringRequired
ttlintegerOptional

Time-to-live in seconds for fast-path execution (optional)

max_feestringOptional

Max Fees used in intent system (depricated after swaps)

order_idstringOptional

Order ID for newOrder requests

isFastPathbooleanOptional

Boolean for sending intent through fast path

Responses
chevron-right
200

Successfully created intent transaction

application/json
post
/tron/intents

Get intent details

get
/intents/{intentId}

Fetches detailed information for a specified intent by its ID

Path parameters
intentIdstringRequired

The unique identifier for the intent

Responses
chevron-right
200

Successful retrieval of intent details

application/json
get
/intents/{intentId}

Execute calldata

post
/intents/{intentId}/execute

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
chevron-right
200

Successful response with a TransactionRequest object

application/json
post
/intents/{intentId}/execute

Return unsupported intent

post
/intents/{intentId}/return-unsupported

The request object for returnUnsupportedIntent on hub domain

Path parameters
intentIdstringRequired

The unique identifier for the intent

Responses
chevron-right
200

Successful response with a TransactionRequest object

application/json
post
/intents/{intentId}/return-unsupported

Get invoices

get
/invoices

Retrieves a paginated list of invoices in FIFO queue order

Query parameters
cursorstringOptional
prevCursorstringOptional
limitintegerOptional
tickerHashstringOptional
originsstring[]Optional
destinationsstring[]Optional
sortOrderByDiscountstringOptional
Responses
chevron-right
200

Successful retrieval of invoices

application/json
get
/invoices

Return invoice details

get
/invoices/{intentId}

Fetches detailed information for a specified invoice by its intentID

Path parameters
intentIdstringRequired

The unique identifier for the intent

Responses
chevron-right
200

Successful retrieval of invoice details

application/json
get
/invoices/{intentId}

Calculate minimum amounts needed to settle invoice

get
/invoices/{intentId}/min-amounts

Calculates the minimum amounts per destination domain to settle a specified invoice. This returns a map of destination domain to minimum amount required in standardized 1e18 decimals.

Path parameters
intentIdstringRequired

The unique identifier for the invoice intent

Responses
chevron-right
200

Successful calculation of minimum amounts

application/json
get
/invoices/{intentId}/min-amounts

Get supported assets

get
/configs/assets

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

Query parameters
pageintegerRequired
limitintegerRequired
typestring · enumOptionalPossible values:
Responses
chevron-right
200

Successful retrieval of assets

application/json
get
/configs/assets

Get quote for a route, including fees and limits

post
/routes/quotes
Body
originstringRequired
destinationsstring[]Required
inputAssetstringRequired
outputAssetstringOptional
amountstringRequired

Token amount, denominated in the asset's decimal units on the origin chain

tostringOptional
fromstringOptional

intent creator address

order_idstringOptional

Order ID for newOrder requests

Responses
chevron-right
200

Successfully retrieved quote.

application/json
post
/routes/quotes

Get current limits for a route

post
/routes/limits
Body
originstringRequired
destinationsstring[]Required
inputAssetstringRequired
Responses
chevron-right
200

Successfully retrieved limits.

application/json
post
/routes/limits

Get intents

get
/intents

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
tickerHashstringOptional
isFastPathbooleanOptional

Filter for fast path intents (intents with TTL > 0)

Responses
chevron-right
200

Successful retrieval of intents

application/json
get
/intents

Get history of invoice processing

get
/history/{intentId}/invoice-processing

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
chevron-right
200

Successful response with history of invoice processing

application/json
get
/history/{intentId}/invoice-processing

Last updated