📘

Find additional links to the full Superform documentation and to the Superform Help forum.

Fundamentals

Q: How much does it cost to use the API?

A: There are no fees associated with calling the API. During the Superform API Early Access period, access is free for both data and execution.

Q: How does monetization work within the Superform API?

A: The API is transitioning to a model that charges a percentage of yield earned, moving away from deposit or withdrawal fees. This aligns incentives and ensures monetization scales with user success​​.

Q: How much does it cost to use the Superform Protocol?

A: The Superform Protocol does not charge fees either. However, users of Superform will need to pay the following costs associated with their transactions including Gas Fees, Swap Fees, Bridge Fees, and Vault Fees.

Q: How are APYs calculated?

A: See How are APYs Calculated in the Superform Help Docs.

Q: Which vaults are supported?

A: See Which Vaults are Supported in the Superform Help Docs.

Q: Which networks are supported?

A: See Which Networks are Supported in the Superform Help Docs.

Q: What’s the difference between a vault through Superform and the vault native to a protocol?

A: Let’s say you’re attempting to deposit into the savings USDS on Yearn. There’s no difference between depositing on Superform or the native vault via Yearn from a yield perspective. However, the Superform API lets you swap, bridge, claim rewards, migrate positons, and access multiple AMBs in a single transaction.

Q: Who creates the vaults? Can any user create the vaults?

A: Superform is a marketplace enabling universal access and management to protocols like Yearn, Aave, Morpho, etc. to simplify earning interest onchain. It also allows for anyone to permissionlessly list any ERC-4626 vault, making it instantly accessible from any chain Superform is deployed on. For example, both Harvest and Seamless have listed vaults and added metadata.

Additionally, Superform also offers its flagship earn product, SuperVaults.

API Access

Q: What stage is the Superform API in?

A: The Superform API is in early access.

Q: How do I get an API Key?

A: Fill out this form, and a member of the Superform team will grant it to you shortly. There is no self-serve management app yet.

Q: What are the current and future API use limits?

A: The current rate limit is 3 requests per second. There are no other limits at this point.

Q: Is there a testnet?

A: We have 3 Superform environments - production, staging and dev.

• Prod is the live v1 contracts.
• Staging has a separate set of contracts deployed and a small set of vaults listed on those contracts.
• Dev is a clone of prod that uses the same prod contracts but has its own db

So testing is a matter of using a different url. Right now, API users access api.superform.xyz. Using staging or dev is a matter of accessing a different subdomain. All we need to do is just need to whitelist your API key in that env to give you access. Depending on what you want to do, we can provide you with conditional access to one or both of those environments.

Execution

Q: How does the API handle call data for transactions?

A: The Superform API generates the entire call data. The /calculate/start endpoint returns the call data. Users can query this API endpoint for pre-constructed transaction data, which can then be signed and executed.

Superform's API is designed to simplify cross-chain and multi-vault operations by translating user-defined actions (e.g., deposits, withdrawals) into transaction data that the protocol can read. This eliminates the need for integrators to craft call data manually.

Q: Does Superform offer gas abstraction or support relayed transactions?

A: Currently, Superform does not support these. The next version of the Superform protocol will soon support gas abstraction. Superform does not have a relayer network.

Q: Does Superform pay for the gas fees involved in these operations?

A: Superform does not inherently cover gas fees on behalf of users or integrations. The initiating entity generally bears gas costs, although the protocol optimizes transactions to minimize these costs where possible. This approach aligns with Superform's modular and permissionless nature. If exploring this integration, you must account for gas costs in your infrastructure unless a specific partnership or relay model is negotiated.

Q: Does Superform require crafting call data manually, or does the API handle it by generating call data that can be executed via a relay or service?

A: The Superform API creates the call data and any approval data if it’s a withdrawal. The caller needs to execute it. Alternatively, the integrator can call the contracts directly with their call data, which requires manually crafting the call data and is more complex.

Q: In cross-chain deposits and withdrawals, does Superform support account abstraction via entry-point contracts?

A: Entry point contracts are central to account abstraction, allowing actions like moving funds or executing transactions without direct user interaction. They do this by leveraging programmable logic and signatures. Superform does not use "entry point contracts" in its current documentation. However, the Superform protocol is permissionless, modular, and compatible with ERC-4626 vault standards, and supports complex actions like intent-based, cross-chain transactions.

Q: Do you handle wrapping multiple transactions?

A: Superform offers multi-vault deposits/withdrawals. A future version of Superform will add support for rebalancing a single transaction vault to vault and additionally rebalancing cross-chain.

Q: What integration options are available for depositing funds into Superform accounts?

A: Superform supports both simple and advanced integration approaches. Users can directly deposit into a Superform vault from any chain using a single transaction for a simple integration. This involves minimal setup and is ideal for seamless onboarding. For more advanced integrations, the Superform API supports crafting and executing complex cross-chain transactions. This includes actions like cross-chain deposits, withdrawals, and transfers into specific vaults. The system utilizes cross-chain messaging (via LayerZero, Hyperlane, and Wormhole) and liquidity aggregation (via providers like Socket and Li.Fi) for maximum flexibility.

Features

Q: Are the vaults from api.superform.xyz/vaults all erc4626 tokens?

A: Yes, they are.

Q: Are your vaults all yield-bearing tokens?

A: Not necessarily, the vaults might not be currently earning yield and perhaps might only be offering points. For integrators, it’s important to know that yield may not influence the token price; rather the supply of circulating tokens will. For this reason, filtering by PPS percentage changes can be as valuable as filtering by APY percentage changes.

Q: How does Superform curate its vaults?

A: Superform simulates vault deposits to ensure they are operational. Superform delves purely into lending markets, while avoiding derivative ones. The team relied upon Exponential.fi and Defi Safety scores—using A & B scores, while excluding C category scores. Superform filters for 4626 vaults, with well-known teams that are authenticated that have audits and crucial relationships, as well as setting a lower bound limit for TVL.

Q: What happens to vaults that no longer perform or experienced exploits? There’s a survivorship bias to the remaining vaults, no?

A: You can see the status of a vault by seeing if its authenticated and visible using the API. You can also access listed, but hidden vaults. Superform might hide them due to hacks or depreciation. API integrators are responsible for not exposing these vaults to users. You can access historical data on all of these vaults still.

Q: Does the API offer Auto-Compounding Functionality?

A: The v1 Superform API does not currently support auto-compounding. We recognize that integrators’ end users might prefer auto-compounded rewards since they may not want to zero in on platform reward tokens they’re earning. We plan on integrating it into the v2 API.

Legal

Q: Does the Superform include geofencing? How do I ensure compliance?

A: There is not a filter or flag in the API that filters for users across various legal jurisdictions. It's the responsibility of our integrators to adjust what they present users based on what they know about their customers. For reference, see the Superform Terms of Service Section 9, which lays this out further.