@keyframes jump {
  0%, 100% { transform: translateY(0); }
  50% { transform: translateY(-20px); }
}
.jump-loop {
  animation: jump 0.5s ease infinite;
}

#code-group {
  background-color: #EFEFEF33;
  /*border-width: 1.5px;*/
  box-shadow: 0 4px 12px rgba(0, 0, 0, 0.08);
}

#code-group:hover {
  box-shadow: 0 6px 18px rgba(0, 0, 0, 0.1);
  /*transform: translateY(-2px);*/
  /*transition: all 0.2s ease;*/
}

#content-area > div.flex.flex-col.gap-8 > div.mt-6.flex.w-full.flex-col.space-y-4 > div {
  background-color: #EFEFEF33;
}


#content-area > div.flex.flex-col.gap-8 > div.mt-6.flex.w-full.flex-col.space-y-4 > div {
  box-shadow: 0 4px 12px rgba(0, 0, 0, 0.08);
}
#content-area > div.flex.flex-col.gap-8 > div.mt-6.flex.w-full.flex-col.space-y-4 > div:hover {
  box-shadow: 0 6px 18px rgba(0, 0, 0, 0.1);
}


// Trigger update: Sun May 18 08:33:57 UTC 2025


// Finds "Compass API" header logo and changes the href to Compass home page
const links = document.getElementsByTagName("a");

for (let link of links) {
  if (link.getAttribute("href") === "/") {
    link.addEventListener("click", (event) => {
      event.preventDefault();

      window.open("https://www.compasslabs.ai/", "_blank");
    });
    break;
  }
}


document.querySelectorAll("a").forEach((anchor) => {
  if (anchor.textContent.trim() === "Powered by Mintlify") {
    anchor.remove();
  }
});


// const ctaButton = document.getElementById("topbar-cta-button");
// if (ctaButton) {
//   const link = ctaButton.querySelector("a");
//   console.log("LINK", link);
//   if (link) {
//     link.addEventListener("click", function (event) {
//       event.preventDefault();

//       // Create modal container
//       const modal = document.createElement("div");
//       modal.style.position = "fixed";
//       modal.style.top = "0";
//       modal.style.left = "0";
//       modal.style.width = "100%";
//       modal.style.height = "100%";
//       modal.style.backgroundColor = "rgba(0, 0, 0, 0.5)";
//       modal.style.display = "flex";
//       modal.style.justifyContent = "center";
//       modal.style.alignItems = "center";
//       modal.style.zIndex = "1000";

//       // Create modal content
//       const modalContent = document.createElement("div");
//       modalContent.style.backgroundColor = "white";
//       modalContent.style.padding = "20px";
//       modalContent.style.borderRadius = "8px";
//       modalContent.style.width = "80%";
//       modalContent.style.maxWidth = "800px";
//       modalContent.style.position = "relative";

//       // Create iframe
//       const iframe = document.createElement("iframe");
//       //   iframe.src = link.href;
//       iframe.src = "https://api.compasslabs.ai/auth/login";
//       iframe.style.width = "100%";
//       iframe.style.height = "500px";
//       iframe.style.border = "none";

//       // Create close button
//       const closeButton = document.createElement("button");
//       closeButton.textContent = "Close";
//       closeButton.style.position = "absolute";
//       closeButton.style.top = "10px";
//       closeButton.style.right = "10px";
//       closeButton.style.padding = "5px 10px";
//       closeButton.style.cursor = "pointer";

//       // Close modal on button click
//       closeButton.addEventListener("click", function () {
//         modal.remove();
//       });

//       // Close modal on click outside
//       modal.addEventListener("click", function (event) {
//         if (event.target === modal) {
//           modal.remove();
//         }
//       });

//       // Append elements
//       modalContent.appendChild(closeButton);
//       modalContent.appendChild(iframe);
//       modal.appendChild(modalContent);
//       document.body.appendChild(modal);
//     });
//   }
// }


Wallet Support

Compass API Docs

Build on‑chain finance fast & pain‑free

Overview

Launch your first on‑chain call in three quick steps

Get Started

All-in-one infrastructure for building on-chain finance

Why Integrate With Us 

Compass API is designed to power the next generation of on-chain applications. We're actively partnering with teams including wallets, crypto platforms, AI companies, protocols and other builders in the DeFi ecosystem.

Partnerships

See how businesses across fintech, crypto, and AI are using Compass API to unlock new capabilities, reduce development time, and deliver exceptional value to their users. From simple swaps to complex automated strategies, one API powers it all.

Use Cases 

Turn natural‑language prompts into executable, non‑custodial blockchain transactions, and monitor balances, positions, and risk.

Compass AI

What's Next?

Terms & Conditions

Returns the standard deviation of Interest Rates for Aave Reserves over time:

Standard deviation of interest rates

Returns time averaged Interest Rates for Aave Reserves:

Average interest rates

Returns key metrics for Aave Reserves:
- Total Supplied (TVL) in USD
- Total Borrowed in USD
- Utilization Ratio

See below for more info:

Reserve overview

Returns the latest APY and APR rates for a specified token on Aave, for both
deposits and loans.

**Annual percentage yield (APY)** is the yearly return/cost after continuous
compounding of the per-second rate stored on-chain. This value is the same value as
seen the on [app.aave.com](
https://app.aave.com/)
but more up-to-date as it is taken directly from the
blockchain every time this endpoint is called.

**Annual percentage rate (APR)** is the yearly simple interest rate (no
compounding).

For APY/APR on loans Aave offers both stable and fixed rates on certain tokens.

Interest rates

This endpoint retrieves the current price of a specified token in USD as
determined by the Aave protocol.

It utilizes the Aave V3 Oracle to fetch the token price, ensuring accurate and up-
to-date information. The request requires the token identifier and the blockchain
network (chain) on which the token resides. The response provides the token price in
a standardized format, converted from Wei to the base currency decimals defined by
Aave.

Token prices

This endpoint retrieves the change in the reserve liquidity index between two
provided blocks.

This is then converted to a percentage change. The liquidity index represents the
change in debt and interest accrual over each block. Aave does not store individual
user balances directly. Instead, it keeps a scaled balance and uses the liquidity
index to compute real balances dynamically. If a user was to have deposited tokens
at the start block, a positive liquidity index change will represent accrued
interest and a profit. If tokens were borrowed at the start block, this debt will
increase, compound on itself and represent large debt. The reverse in both cases is
true if the liquidity index is negative.

Liquidity index

This endpoint retrieves a comprehensive summary of a user's position on the AAVE
platform.

It provides key financial metrics including the total collateral deposited, total
debt accrued, available borrowing capacity, liquidation threshold, maximum loan-to-
value ratio, and the health factor of the user's account. These metrics are
calculated by aggregating data across all open positions held by the user, offering
a holistic view of their financial standing within the AAVE ecosystem.

Positions - total

This endpoint retrieves the user's position for a specific token on the AAVE
platform.

It provides key financial metrics including the current aToken balance, current
stable debt, current variable debt, principal stable debt, principal variable debt,
stable borrow rate, stable borrow rate for new loans, variable borrow rate, and
liquidity rate. These metrics are calculated by aggregating data across all open
positions held by the user for the specified token, offering a detailed view of
their financial standing within the AAVE ecosystem.

Positions - per token

This endpoint retrieves historical transactions for a user on the AAVE platform.

It returns a list of transactions including deposits, withdrawals, borrows, and
repayments. Each transaction includes details such as the token, amount, timestamp,
and transaction type. This provides a comprehensive view of the user's historical
activity within the AAVE protocol.

Historical transactions

By supplying assets, users can earn interest on their deposits.

The supplied collateral can be used as a basis for borrowing other assets, allowing
users to leverage their positions. In combination with a trading protocol, this can
create leverage.

Overall, this endpoint is a critical component for users looking to maximize their
asset utility within the AAVEv3 ecosystem, providing both earning potential and
borrowing flexibility.

Supply/Lend

You will pay interest for your borrows.

Price changes in the assets may lead to some or all of your collateral being
liquidated, if the borrow position becomes unhealthy.

Borrow

This endpoint allows users to repay a portion or the entirety of their borrowed
tokens on the Aave platform.

By repaying borrowed amounts, users can improve their health factor, which is a
measure of the safety of their loan position. A higher health factor reduces the
risk of liquidation, ensuring a more secure borrowing experience. The endpoint
requires specifying the chain and the details of the repayment transaction,
including the amount and the asset to be repaid.

Repay loans

This endpoint facilitates the withdrawal of collateral from the Aave protocol.

Users can withdraw a portion or all of their collateral, which may increase the risk
of liquidation if there are outstanding borrows. The withdrawal process also
includes the collection of any interest earned on the collateral. It is important
for users to carefully consider their outstanding debts and the potential impact on
their liquidation threshold before proceeding with a withdrawal. This endpoint is
designed to provide a seamless and efficient way to manage your collateral within
the Aave ecosystem.

Unstake

Retrieve the total number of Liquidity Provider (LP) positions associated with a
specific sender.

This endpoint allows users to query and obtain detailed information about their LP
positions, including the number of active positions they hold. The response model,
AerodromeLPPositionsInfo, provides a structured representation of the LP positions
data, ensuring clarity and ease of use. This functionality is essential for users
managing their liquidity provision activities, enabling them to make informed
decisions based on their current positions.

List LP positions

This endpoint retrieves the current price of a pool, indicating how many token0
you can purchase for 1 token1.

Note that this is an instantaneous price and may change during any trade. For a more
accurate representation of the trade ratios between the two assets, consider using
the quote endpoint.

Pool price

This endpoint allows users to trade a specific amount of one token into another
token using the Aerodrome Slipstream protocol.

The transaction is executed by specifying the exact amount of the input token to be
sold, and the system calculates the amount of the output token that will be
received. The operation ensures that the trade is conducted within the constraints
of the current market conditions, taking into account the liquidity and price
impact. This endpoint is suitable for users who want to sell a precise quantity of a
token and are willing to accept the resulting amount of the other token.

Swap - from specified amount

This endpoint facilitates the trading of tokens by allowing users to specify the
exact amount of the output token they wish to receive.

Utilizing the Aerodrome Slipstream protocol, the system calculates the necessary
amount of the input token required to achieve the desired output. This operation is
particularly useful for users who have a specific target amount of the output token
in mind and are willing to provide the corresponding input token amount. The
transaction is executed with consideration of current market conditions, including
liquidity and price impact, ensuring that the trade is completed efficiently and
effectively.

Swap - into specified amount

Initiate a new Liquidity Provider (LP) position by minting tokens.

This endpoint allows users to open a new LP position, enabling them to participate
in liquidity provision. The minting process involves creating a new position with
specified parameters, such as token amounts and pool details. The response will
confirm the successful creation of the LP position, providing users with the
necessary information to manage their newly minted position. This functionality is
crucial for users looking to expand their liquidity provision activities, offering
them the opportunity to engage in decentralized finance (DeFi) markets effectively.

Open a new LP position

Increase the liquidity of an existing Liquidity Provider (LP) position.

This endpoint allows users to add more tokens to their current LP position,
enhancing their participation in liquidity provision. By increasing liquidity, users
can potentially earn more rewards and improve their position in the pool. The
process involves specifying additional token amounts and updating the pool details.
The response will confirm the successful increase of the LP position, providing
users with updated information about their enhanced position. This functionality is
vital for users aiming to optimize their liquidity provision strategy, enabling them
to adapt to market conditions and maximize their returns in decentralized finance
(DeFi) markets.

Increase an LP position

Withdraw an existing Liquidity Provider (LP) position.

This endpoint allows users to remove their tokens from an LP position, effectively
closing their participation in the liquidity pool. The withdrawal process involves
specifying the LP position to be closed, and the response will confirm the
successful removal of liquidity, providing users with details about the withdrawn
tokens and any remaining balances. This functionality is essential for users who
wish to exit their liquidity provision activities, enabling them to reclaim their
assets and potentially reallocate them to other investment opportunities. The
endpoint ensures a smooth and secure withdrawal process, facilitating users'
strategic management of their decentralized finance (DeFi) portfolios.

Withdraw an LP position

Query a list of vaults you can deposit into.

Each vault has one unique token that can be deposited. In exchange for depositing
tokens into a vault you receive shares. You earn yield on these shares by their
exchange value increasing over time.

Get Vaults

Check how many shares you own and the equivalent token amount of a given
vault.

Check Vault Position

Query a list of markets you can borrow from.

Each market has one unique token that can be borrowed against one unique token that
can be used as collateral.

Get Markets

Check how many shares you've borrowed and the equivalent token amount of a given
market.

Check Market Position

Set an allowance for a Morpho vault. You must set this for at least the amount you wish to deposit - before depositing.

Each vault has only one associated token that can be deposited.

Use the 'Get Vaults' endpoint to query a list of vaults you can deposit into.

Set Allowance for Vault

Deposit tokens into a Morpho Vault to earn passive yield from interest paid by
borrowers.

Each vault accepts one unique token that can be deposited.

A Morpho Vault has one loan asset and can allocate deposits to multiple Morpho
markets. Users can deposit into a vault to start earning passive yield from interest
paid by borrowers. Vaults feature automated risk management, actively curating risk
exposure for all deposited assets so users don't need to make these decisions
themselves. Users maintain full control over their assets, can monitor the vault's
state at any time, and withdraw their liquidity at their discretion.

Deposit to Vault

Withdraw deposited tokens from a Morpho Vault.

The passive yield earned on token deposits is represented by the increased value of
the shares received upon depositing tokens.

A Morpho Vault has one loan asset and can allocate deposits to multiple Morpho
markets. Users can deposit into a vault to start earning passive yield from interest
paid by borrowers. Vaults feature automated risk management, actively curating risk
exposure for all deposited assets so users don't need to make these decisions
themselves. Users maintain full control over their assets, can monitor the vault's
state at any time, and withdraw their liquidity at their discretion.

Withdraw from Vault

Supply collateral to a Morpho Market in order to borrow against it.

A Morpho Market is a primitive lending pool that pairs one collateral asset with one
loan asset. Each market is isolated (meaning risks are contained within each
individual market), immutable (cannot be changed after deployment), and will persist
as long as the blockchain it is deployed on is live.

Supply Collateral to Market

Withdraw collateral that has been supplied to a Morpho Market.

A Morpho Market is a primitive lending pool that pairs one collateral asset with one
loan asset. Each market is isolated (meaning risks are contained within each
individual market), immutable (cannot be changed after deployment), and will persist
as long as the blockchain it is deployed on is live.

Withdraw Collateral from Market

Borrow tokens from a Morpho Market against supplied collateral.

The position could be liquidated when a borrower's Loan-To-Value (LTV) exceeds the
Liquidation Loan-To-Value (LLTV) threshold of the market.

A Morpho Market is a primitive lending pool that pairs one collateral asset with one
loan asset. Each market is isolated (meaning risks are contained within each
individual market), immutable (cannot be changed after deployment), and will persist
as long as the blockchain it is deployed on is live.

Borrow from Market

Repay borrowed tokens to a market in order to reduce or eliminate debt.

A Morpho Market is a primitive lending pool that pairs one collateral asset with one
loan asset. Each market is isolated (meaning risks are contained within each
individual market), immutable (cannot be changed after deployment), and will persist
as long as the blockchain it is deployed on is live.

Repay to Market

Check USDS Position

Buy USDS with DAI or USDC on a 1:1 basis. There are no fees.

If buying with DAI, user will need to set an allowance on the DAI contract for the
'SkyDaiUsdsConverter' contract beforehand.

If buying with USDC, user will need to set an allowance on the USDC contract for the
'SkyDaiUsdsConverter' contract beforehand.

Buy USDS

Sell USDS for DAI or USDC on a 1:1 basis. There are no fees.

If swapping to DAI, user will need to set an allowance on the USDS contract for the
'SkyDaiUsdsConverter' contract beforehand.

If swapping to USDC, user will need to set an allowance on the USDS contract for the
'SkyUsdcUsdsConverter' contract beforehand.

Sell USDS

Deposit USDS for sUSDS to earn yield.

There are no fees.

Deposit USDS

Withdraw USDS for sUSDS to stop earning yield.

There are no fees.

Withdraw USDS

This endpoint retrieves the address for a token supported by us.

Token Address

Retrieves the price of a token in USD using Chainlink's on-chain price feeds.

Chainlink is a decentralized oracle that aggregates price data from off-chain
sources. This ensures the price is tamper-resistant but the price might be stale
with the update frequency of the oracle.

Token Price

Returns the balance of a specific ERC20 token for a given user address.

Token Balance

Sends native ETH or ERC20 tokens from the sender's address to another address.

Transfer ETH or ERC20 Tokens

This endpoint calculates the amount of input tokens required to purchase a
specified amount of output tokens from a Uniswap pool.

It also provides the resulting price after the transaction. The calculation takes
into account the current pool state and the specified fee tier.

Get quote - to specified amount

Get quote - from specified amount

This endpoint calculates the price of a token in a Uniswap pool.

The price is calculated based on the current pool state and the specified fee tier.

This endpoint allows users to check whether a specific liquidity provider ()
position is within the active tick range on the uniswap platform.

by providing the token id associated with the position, users can verify if the
position is currently within the tick range where trading occurs. this information
is essential for users to monitor the status of their lp positions and ensure that
they are actively participating in the trading activities within the liquidity pool
and earning trading fees.

Check if LP is active.

This endpoint retrieves the number of Liquidity Provider (LP) positions
associated with a specific sender address on the Uniswap platform.

Users can query this endpoint to obtain detailed information about their LP
positions, including the total number of positions and relevant metadata. This
information is crucial for users to manage and analyze their liquidity provision
activities effectively.

List LP

This endpoint allows users to trade a variable amount of one token to receive an
exact amount of another token using the Uniswap protocol.

The transaction is executed on the specified blockchain network, and the user must
provide the necessary transaction details, including the token to buy, the token to
pay with, and the exact amount to receive. If the token being paid with is WETH and
needs to be wrapped, the appropriate amount will be wrapped automatically.

Buy exact amount

This endpoint allows users to trade a specific amount of one token into another
token using the Uniswap protocol.

The transaction is executed on the specified blockchain network, and the user must
provide the necessary transaction details, including the token to sell, the token to
receive, and the amount to sell. If the token being sold is WETH and needs to be
wrapped, the appropriate amount will be wrapped automatically.

Sell exact amount

This endpoint allows users to increase their existing Liquidity Provider (LP)
positions on the Uniswap platform.

By providing the necessary parameters, users can add more liquidity to their current
positions, thereby increasing their stake in the liquidity pool. This operation is
beneficial for users who wish to enhance their potential earnings from trading fees
within the pool. The endpoint requires details such as the token pair, additional
amount to be added, and any other parameters necessary for the liquidity increase
process.

This endpoint allows users to open a new Liquidity Provider (LP) position on the
Uniswap platform.

By providing the necessary parameters, users can initiate a minting process to
create a new LP token, which represents their stake in a specific liquidity pool.
This operation is essential for users looking to participate in liquidity provision,
enabling them to earn fees from trades that occur within the pool. The endpoint
requires details such as the token pair, amount, and any additional parameters
needed for the minting process.

This endpoint allows users to withdraw their Liquidity Provider (LP) positions
from the Uniswap platform.

By specifying the necessary parameters, users can initiate the withdrawal process to
remove their stake from a specific liquidity pool. This operation is crucial for
users who wish to reclaim their assets or reallocate their liquidity to different
pools or investments. The endpoint requires details such as the token pair, the
amount to be withdrawn, and any additional parameters needed for the withdrawal
process. Users should ensure they meet any protocol requirements or conditions
before initiating a withdrawal to avoid potential issues or penalties.

Fetch the detailed portfolio of a specific wallet address on a given blockchain.

This includes the total value of the portfolio in USD and a breakdown of token
balances, including their respective values and quantities.

List user portfolio

Generate a visual representation of the token portfolio for a wallet address.

The response is an SVG image of a pie chart depicting the relative distribution of
tokens held, colored and labeled with token symbols, percentages and token values in
USD.

Visualize user portfolio

Get the list of supported tokens on a chain by the Compass API.

List supported tokens

In decentralized finance (DeFi) protocols such as Uniswap or AAVE, users must set
a token allowance to authorize the protocol to spend a specified amount of their
tokens on their behalf.

This is a crucial step before engaging in any transactions or operations within
these protocols, ensuring that the protocol has the necessary permissions to manage
the user's tokens securely and efficiently.

Get allowance - Protocol

An ENS name is a string ending in `.eth`.

E.g. `vitalik.eth`. This endpoint can be used to
query the actual ethereum wallet address behind the ENS name.

Resolve ENS

Wrapping ETH creates an ERC-20 compliant form of ETH that is typically needed for
it to be traded on DeFi protocols.

Wrap ETH

Unwrapping WETH converts the ERC-20 compliant form of ETH back to native ETH that
can be used for gas and other native purposes.

Unwrap WETH

This endpoint allows users to modify the token allowance for a specific protocol.

In decentralized finance (DeFi), setting an allowance is a necessary step to
authorize a protocol to spend a specified amount of tokens on behalf of the user.
This operation is crucial for ensuring that the protocol can manage the user's
tokens securely and efficiently, enabling seamless transactions and operations
within the DeFi ecosystem.

Set Allowance - Protocol

Get authorization data for EIP-7702 batching operations.

This authorization is required to prevent replay attacks and ensure transaction
ordering when batching multiple actions into a single transaction. The authorization
includes a nonce and chain ID to guarantee transaction uniqueness and proper network
targeting.

Get EIP-7702 Authorization

Execute a batch of transactions in a single multicall using EIP-7702.

This endpoint allows bundling multiple contract calls into a single atomic
transaction, reducing gas costs and ensuring all operations succeed or fail
together. The transaction must be authorized using the /authorization endpoint to
prevent replay attacks.

Execute Tx Batching

Execute an Aave looping strategy that involves repeated supply and borrow
operations.

This endpoint creates a multicall transaction that performs a series of operations:
1. Approves and supplies initial token
2. For each loop:
    - Borrows another token
    - Swaps borrowed token back to supply token
    - Supplies the swapped tokens

The transaction must be authorized using the /authorization endpoint to prevent replay attacks.

Documentation