# components.schemas.AddVaultInputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.AddVaultInputBody.properties.chain.description
This is the chain that this vault belongs to.

# components.schemas.AddVaultInputBody.properties.contract_address.description
This comes from on-chain data, it is the address of the vault contract.

# components.schemas.AddVaultInputBody.properties.decimals.description
This comes from on-chain data, decimals of the vault.

# components.schemas.AddVaultInputBody.properties.deploy_date.description
The date the vault was deployed on-chain.

# components.schemas.AddVaultInputBody.properties.description.description
The description of the vault. Required when creating vault.

# components.schemas.AddVaultInputBody.properties.form_implementation_id.description
This is the formImplementationID of the vault

# components.schemas.AddVaultInputBody.properties.has_aerc_20_registered.description
Whether the vault has an AERC20 registered.

# components.schemas.AddVaultInputBody.properties.id.description
This is the unique identifier for this vault.

# components.schemas.AddVaultInputBody.properties.num_depositors.description
The number of Superform depositors in the vault.

# components.schemas.AddVaultInputBody.properties.protocol.description
Optional. This is the protocol that this vault belongs to.

# components.schemas.AddVaultInputBody.properties.protocol_id.description
Optional. This is the unique identifier for the protocol that this vault belongs to.

# components.schemas.AddVaultInputBody.properties.super_pools.description
Array of chainIDs on which there is a liquidity pool for this vault

# components.schemas.AddVaultInputBody.properties.superform_address.description
This comes from on-chain data, it is the address of the superform contract.

# components.schemas.AddVaultInputBody.properties.superform_id.description
This comes from on-chain data, it is the unique identifier for this superform.

# components.schemas.AddVaultInputBody.properties.symbol.description
This comes from on-chain data, symbol of the vault.

# components.schemas.AddVaultInputBody.properties.vault_lister.description
The address of the user who listed the vault.

# components.schemas.AddVaultInputBody.properties.vault_status_message.description
Optional. The status message of the vault.

# components.schemas.AddVaultInputBody.properties.yield_type.description
The yield type of the vault. Required when creating vault.

# components.schemas.AddVaultOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.ClaimTransaction.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.ClaimableReward.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.DepositResponse.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.DepositResponse.properties.discount_usd.description
Optional discount applied to some vaults during a promotion.

# components.schemas.DepositResponse.properties.method.description
Method to be called on the contract. This is for reference only, as method is encoded in the tx data below.

# components.schemas.DepositResponse.properties.to.description
Address to which the deposit should be made

# components.schemas.DepositResponse.properties.value_usd.description
Value to be sent in the transaction in USD

# components.schemas.EarningReward.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.ErrorDetail.properties.location.description
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.ErrorModel.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.ErrorModel.properties.detail.description
A human-readable explanation specific to this occurrence of the problem.

# components.schemas.ErrorModel.properties.detail.examples[]
Property foo is required but is missing.

# components.schemas.ErrorModel.properties.errors.description
Optional list of individual error details

# components.schemas.ErrorModel.properties.instance.description
A URI reference that identifies the specific occurrence of the problem.

# components.schemas.ErrorModel.properties.title.description
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

# components.schemas.ErrorModel.properties.type.description
A URI reference to human-readable documentation for the error.

# components.schemas.GetAddressTypeOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.GetDeploymentDetailsOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.GetSuperpositionBalancesOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.GetSuperpositionUSDPriceOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.GetSupportedOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.GetTokenBalancesOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.GetTokenDistributionOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.HealthCheckOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.HistoricalProtocolResponseBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.HistoricalVaultResponseBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.HistoricalVaultResponseBody.properties.vaults.description
Vault metrics data keyed by superform_id

# components.schemas.QuoteParams.properties.bridge_slippage.description
Slippage taken on bridge action in bps, between 0.5% and 50%

# components.schemas.QuoteParams.properties.exclude_ambs.description
List of AMB IDs to exclude from the route. See output of /supported for AMB IDs.

# components.schemas.QuoteParams.properties.exclude_bridges.description
List of bridge IDs to exclude from the route. See output of /supported for bridge IDs.

# components.schemas.QuoteParams.properties.exclude_dexes.description
List of dex IDs to exclude from the route. See output of /supported for dex IDs.

# components.schemas.QuoteParams.properties.exclude_liquidity_providers.description
List of liquidity provider IDs to exclude from the route. See output of /supported for liquidity provider IDs.

# components.schemas.QuoteParams.properties.filter_swap_routes.description
If true, any route that contains a destination swap will be filtered out. Reduces chances of a deposit failing due to route unavailability.

# components.schemas.QuoteParams.properties.is_part_of_multi_vault.description
Flag to indicate if the request is part of a multi-vault deposit or withdrawal

# components.schemas.QuoteParams.properties.positive_slippage.description
Swap surplus in bps, between 1% and 100%. See help.superform.xyz for more.

# components.schemas.QuoteParams.properties.refund_address.description
Address on the destination chain to which the refund should be made, if needed.

# components.schemas.QuoteParams.properties.retain_4626.description
Flag to indicate if the user wants to hold vault shares or not

# components.schemas.QuoteParams.properties.superform_id.description
Must provide either vault_id or superform_id

# components.schemas.QuoteParams.properties.superpositions_amount_in.description
Amount of the superposition to be withdrawn

# components.schemas.QuoteParams.properties.swap_slippage.description
Slippage taken on dex action in bps, between 0.5% and 50%

# components.schemas.QuoteParams.properties.vault_id.description
Must provide either vault_id or superform_id

# components.schemas.QuoteParamsDeposit.properties.bridge_slippage.description
Slippage taken on bridge action in bps, between 0.5% and 50%

# components.schemas.QuoteParamsDeposit.properties.exclude_ambs.description
List of AMB IDs to exclude from the route. See output of /supported for AMB IDs.

# components.schemas.QuoteParamsDeposit.properties.exclude_bridges.description
List of bridge IDs to exclude from the route. See output of /supported for bridge IDs.

# components.schemas.QuoteParamsDeposit.properties.exclude_dexes.description
List of dex IDs to exclude from the route. See output of /supported for dex IDs.

# components.schemas.QuoteParamsDeposit.properties.exclude_liquidity_providers.description
List of liquidity provider IDs to exclude from the route. See output of /supported for liquidity provider IDs.

# components.schemas.QuoteParamsDeposit.properties.filter_swap_routes.description
If true, any route that contains a destination swap will be filtered out. Reduces chances of a deposit failing due to route unavailability.

# components.schemas.QuoteParamsDeposit.properties.is_part_of_multi_vault.description
Flag to indicate if the request is part of a multi-vault deposit or withdrawal

# components.schemas.QuoteParamsDeposit.properties.positive_slippage.description
Swap surplus in bps, between 1% and 100%. See help.superform.xyz for more.

# components.schemas.QuoteParamsDeposit.properties.refund_address.description
Address on the destination chain to which the refund should be made, if needed.

# components.schemas.QuoteParamsDeposit.properties.superform_id.description
Must provide either vault_id or superform_id

# components.schemas.QuoteParamsDeposit.properties.swap_slippage.description
Slippage taken on dex action in bps, between 0.5% and 50%

# components.schemas.QuoteParamsDeposit.properties.vault_id.description
Must provide either vault_id or superform_id

# components.schemas.QuoteParamsWithdrawal.properties.bridge_slippage.description
Slippage taken on bridge action in bps, between 0.5% and 50%

# components.schemas.QuoteParamsWithdrawal.properties.exclude_ambs.description
List of AMB IDs to exclude from the route. See output of /supported for AMB IDs.

# components.schemas.QuoteParamsWithdrawal.properties.exclude_bridges.description
List of bridge IDs to exclude from the route. See output of /supported for bridge IDs.

# components.schemas.QuoteParamsWithdrawal.properties.exclude_dexes.description
List of dex IDs to exclude from the route. See output of /supported for dex IDs.

# components.schemas.QuoteParamsWithdrawal.properties.exclude_liquidity_providers.description
List of liquidity provider IDs to exclude from the route. See output of /supported for liquidity provider IDs.

# components.schemas.QuoteParamsWithdrawal.properties.filter_swap_routes.description
If true, any route that contains a destination swap will be filtered out. Reduces chances of a deposit failing due to route unavailability.

# components.schemas.QuoteParamsWithdrawal.properties.is_erc20.description
Is the superposition an aERC20 token instead of the traditional 1155S

# components.schemas.QuoteParamsWithdrawal.properties.is_part_of_multi_vault.description
Flag to indicate if the request is part of a multi-vault deposit or withdrawal

# components.schemas.QuoteParamsWithdrawal.properties.positive_slippage.description
Swap surplus in bps, between 1% and 100%. See help.superform.xyz for more.

# components.schemas.QuoteParamsWithdrawal.properties.refund_address.description
Address on the destination chain to which the refund should be made, if needed.

# components.schemas.QuoteParamsWithdrawal.properties.retain_4626.description
Flag to indicate if the user wants to hold vault shares or not

# components.schemas.QuoteParamsWithdrawal.properties.superform_id.description
Must provide either vault_id or superform_id

# components.schemas.QuoteParamsWithdrawal.properties.superpositions_amount_in.description
Amount of the superposition to be withdrawn

# components.schemas.QuoteParamsWithdrawal.properties.superpositions_chain_id.description
Chain ID that the superposition was minted to.

# components.schemas.QuoteParamsWithdrawal.properties.swap_slippage.description
Slippage taken on dex action in bps, between 0.5% and 50%

# components.schemas.QuoteParamsWithdrawal.properties.vault_id.description
Must provide either vault_id or superform_id

# components.schemas.SuperformHeaderStats.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.SuperrewardsClaim.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.UpdateVaultInputBody.properties.chain.description
This is the chain that this vault belongs to.

# components.schemas.UpdateVaultInputBody.properties.contract_address.description
This comes from on-chain data, it is the address of the vault contract.

# components.schemas.UpdateVaultInputBody.properties.decimals.description
This comes from on-chain data, decimals of the vault.

# components.schemas.UpdateVaultInputBody.properties.deploy_date.description
The date the vault was deployed on-chain.

# components.schemas.UpdateVaultInputBody.properties.description.description
The description of the vault. Required when creating vault.

# components.schemas.UpdateVaultInputBody.properties.form_implementation_id.description
This is the formImplementationID of the vault

# components.schemas.UpdateVaultInputBody.properties.has_aerc_20_registered.description
Whether the vault has an AERC20 registered.

# components.schemas.UpdateVaultInputBody.properties.id.description
This is the unique identifier for this vault.

# components.schemas.UpdateVaultInputBody.properties.num_depositors.description
The number of Superform depositors in the vault.

# components.schemas.UpdateVaultInputBody.properties.protocol.description
Optional. This is the protocol that this vault belongs to.

# components.schemas.UpdateVaultInputBody.properties.protocol_id.description
Optional. This is the unique identifier for the protocol that this vault belongs to.

# components.schemas.UpdateVaultInputBody.properties.super_pools.description
Array of chainIDs on which there is a liquidity pool for this vault

# components.schemas.UpdateVaultInputBody.properties.superform_address.description
This comes from on-chain data, it is the address of the superform contract.

# components.schemas.UpdateVaultInputBody.properties.superform_id.description
This comes from on-chain data, it is the unique identifier for this superform.

# components.schemas.UpdateVaultInputBody.properties.symbol.description
This comes from on-chain data, symbol of the vault.

# components.schemas.UpdateVaultInputBody.properties.vault_lister.description
The address of the user who listed the vault.

# components.schemas.UpdateVaultInputBody.properties.vault_status_message.description
Optional. The status message of the vault.

# components.schemas.UpdateVaultInputBody.properties.yield_type.description
The yield type of the vault. Required when creating vault.

# components.schemas.UserEligibleOutputBody.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.UserPortfolioBalance.properties.balance_btc.description
The user's balance across all of Superform at this point in time, in BTC

# components.schemas.UserPortfolioBalance.properties.balance_eth.description
The user's balance across all of Superform at this point in time, in ETH

# components.schemas.UserPortfolioBalance.properties.balance_usd.description
The user's balance across all of Superform at this point in time, in USD

# components.schemas.UserPortfolioBalance.properties.timestamp.description
Unix timestamp at which this user balance was calculated

# components.schemas.UserWiseSuperpositionWiseBalance.properties.balance.description
balance of the user in the vault share decimals

# components.schemas.UserWiseSuperpositionWiseBalance.properties.superform_address.description
address of the superform wrapper for the vault that mints the vault shares

# components.schemas.Vault.properties.$schema.description
A URL to the JSON Schema for this object.

# components.schemas.Vault.properties.chain.description
This is the chain that this vault belongs to.

# components.schemas.Vault.properties.contract_address.description
This comes from on-chain data, it is the address of the vault contract.

# components.schemas.Vault.properties.decimals.description
This comes from on-chain data, decimals of the vault.

# components.schemas.Vault.properties.deploy_date.description
The date the vault was deployed on-chain.

# components.schemas.Vault.properties.description.description
The description of the vault. Required when creating vault.

# components.schemas.Vault.properties.form_implementation_id.description
This is the formImplementationID of the vault

# components.schemas.Vault.properties.has_aerc_20_registered.description
Whether the vault has an AERC20 registered.

# components.schemas.Vault.properties.id.description
This is the unique identifier for this vault.

# components.schemas.Vault.properties.num_depositors.description
The number of Superform depositors in the vault.

# components.schemas.Vault.properties.protocol.description
Optional. This is the protocol that this vault belongs to.

# components.schemas.Vault.properties.protocol_id.description
Optional. This is the unique identifier for the protocol that this vault belongs to.

# components.schemas.Vault.properties.super_pools.description
Array of chainIDs on which there is a liquidity pool for this vault

# components.schemas.Vault.properties.superform_address.description
This comes from on-chain data, it is the address of the superform contract.

# components.schemas.Vault.properties.superform_id.description
This comes from on-chain data, it is the unique identifier for this superform.

# components.schemas.Vault.properties.symbol.description
This comes from on-chain data, symbol of the vault.

# components.schemas.Vault.properties.vault_lister.description
The address of the user who listed the vault.

# components.schemas.Vault.properties.vault_status_message.description
Optional. The status message of the vault.

# components.schemas.Vault.properties.yield_type.description
The yield type of the vault. Required when creating vault.

# components.schemas.VaultMetrics.properties.apy.description
APY at the given timestamp, including rewards APY

# components.schemas.VaultMetrics.properties.apy_base.description
APY at the given timestamp, excluding rewards APY

# components.schemas.VaultMetrics.properties.tvl.description
Total value locked in the vault at the given timestamp

# components.schemas.VaultStatistic.properties.apy_day.description
APY calculated over a 24 hour time frame and scaled to a year.

# components.schemas.VaultStatistic.properties.apy_month.description
APY calculated over a 30 day time frame and scaled to a year.

# components.schemas.VaultStatistic.properties.apy_week.description
APY calculated over a 7 day time frame and scaled to a year.

# components.schemas.VaultStatistic.properties.sharpe_day.description
Sharpe ratio calculated over a 24 hour time frame.

# components.schemas.VaultStatistic.properties.sharpe_month.description
Sharpe ratio calculated over a 30 day time frame.

# components.schemas.VaultStatistic.properties.tvl_day_change.description
TVL change over the past day, in percent.

# components.schemas.VaultStatistic.properties.tvl_month_change.description
TVL change over the past month, in percent.

# components.schemas.VaultStatistic.properties.tvl_week_change.description
TVL change over the past week, in percent.

# components.schemas.VaultType.properties.$schema.description
A URL to the JSON Schema for this object.

# paths./.get.description
Performs a basic health check of the API.

# paths./checks/address/vault.get.description
Get the vault type of a contract address (ERC4626, ERC5115, ERC7540)

# paths./deployment.get.description
Get contract addresses for each chain Superform is deployed on.

# paths./deposit/calculate.post.description
This is the first of two steps for a deposit flow. After providing relevant options as input, this endpoint will return a number of possible routes. The selected route should be used as input for the `/deposit/start` endpoint.

# paths./deposit/start.post.description
This is the second and final step in the deposit flow. The expected input is the full output of `/deposit/calculate`. The selected route should be first, or only, route in the `liq.route.routes` array. The response of this endpoint will provide the transaction data and relevant metadata to execute the transaction onchain.

# paths./explorer/galxe/blast/{user}.get.description
Get user blast transaction galxe eligibility

# paths./explorer/galxe/blast/{user}.get.summary
Get user blast transaction galxe eligibility

# paths./explorer/galxe/crossChainTransaction/{user}.get.description
Get user cross chain transaction galxe eligibility

# paths./explorer/galxe/crossChainTransaction/{user}.get.summary
Get user cross chain transaction galxe eligibility

# paths./explorer/galxe/sameChainTransaction/{user}.get.description
Get user same chain transaction galxe eligibility

# paths./explorer/galxe/sameChainTransaction/{user}.get.summary
Get user same chain transaction galxe eligibility

# paths./health/db.get.description
Checks the health of the database connection.

# paths./health/debank.get.description
Checks the health of the Debank service.

# paths./health/llama.get.description
Checks the health of the DefiLlama service.

# paths./health/rpc.get.description
Checks the health of the RPC connection.

# paths./health/socket.get.description
Checks the health of the Socket service.

# paths./health/subgraph.get.description
Checks the health of the Subgraph service.

# paths./protocol/{id}/stats.get.description
Get historical stats for a protocol, comprising all of its vaults. If no parameters are passed, response will span the full range of available data.If a timestamp is passed, the data will be for that point in time. If a start and end timestamp are passed, the data will be for that range.

# paths./protocol/{id}/stats.get.parameters[].description
Unix timestamp for the start of the time series data

# paths./protocol/{id}/stats.get.parameters[].schema.description
Unix timestamp for the start of the time series data

# paths./protocol/{id}/stats.get.parameters[].description
Unix timestamp for the end of the time series data

# paths./protocol/{id}/stats.get.parameters[].schema.description
Unix timestamp for the end of the time series data

# paths./protocol/{id}/stats.get.parameters[].description
Granularity of the time series data. Default is day.

# paths./protocol/{id}/stats.get.parameters[].schema.description
Granularity of the time series data. Default is day.

# paths./protocol/{id}/stats.get.parameters[].description
Unix timestamp if you want the data at a point in time instead of a range

# paths./protocol/{id}/stats.get.parameters[].schema.description
Unix timestamp if you want the data at a point in time instead of a range

# paths./protocol/{id}/stats.get.parameters[].description
Calculate the Superform (not overall) TVL for all the vaults comprising this protocol

# paths./protocol/{id}/stats.get.parameters[].schema.description
Calculate the Superform (not overall) TVL for all the vaults comprising this protocol

# paths./protocolRewards/claim/{chain_id}/{user}.get.description
Get transaction for claiming rewards for a user

# paths./protocolRewards/claimable/{user}.get.description
Get claimable rewards for different vaults and protocols for a user

# paths./protocolRewards/userBalance/historical/vault/{vault_id}.get.description
Get users and and their balances for a vault for a given timestamp

# paths./protocolRewards/userBalance/historical/{protocol_id}.get.description
Get users and and their balances for a protocol for a given timestamp

# paths./protocolRewards/userBalance/historical/{protocol_id}.get.summary
Get user historical balances for protocol

# paths./stats/superform.get.description
Returns total Superform TVL, Volume, number of Vaults and Protocols

# paths./supported.get.description
Get the supported bridges, AMBs, and dexes that can be passed to /deposit/calculate or /withdraw/calculate.

# paths./supported/withdrawable-tokens.get.description
Returns the list of tokens that can be withdrawn to from the vaults.

# paths./supported/yield-types.get.description
When creating or updating a vault, you must specify a yield type. This endpoint returns the supported yield types.

# paths./token-distribution/claim/{user}.get.description
Start the piggy token claim process for a user and get the claim transaction

# paths./token-distribution/{user}.get.description
Returns the distribution of the piggy token and superrewards for the user

# paths./token/balances/{address}.get.description
Get all ERC-20 token balances with their prices for a user.

# paths./token/superpositions/balances/{address}.get.description
Get the superpositions balances for an address.

# paths./user/portfolio/{address}.get.description
Get historical portfolio balances for an address. The response is cached for 4 hours.

# paths./user/portfolio/{address}.get.parameters[].description
Unix timestamp for the start of the time series data, trimmed to 8 decimal places.

# paths./user/portfolio/{address}.get.parameters[].schema.description
Unix timestamp for the start of the time series data, trimmed to 8 decimal places.

# paths./user/portfolio/{address}.get.parameters[].description
Unix timestamp for the end of the time series data, trimmed to 8 decimal places

# paths./user/portfolio/{address}.get.parameters[].schema.description
Unix timestamp for the end of the time series data, trimmed to 8 decimal places

# paths./user/portfolio/{address}.get.summary
Get historical portfolio balances for an address. The default and only granularity is daily. The data is collected at a daily interval.

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.description
Get historical vault data by vaultID(s) or superformID(s)

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].description
Comma-separated list of vault or superform IDs

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].schema.description
Comma-separated list of vault or superform IDs

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].description
Unix timestamp for the start of the time series data

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].schema.description
Unix timestamp for the start of the time series data

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].description
Unix timestamp for the end of the time series data

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].schema.description
Unix timestamp for the end of the time series data

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].description
Granularity of the time series data. Default is day.

# paths./vault/data/historical/{vaultOrSuperformIDs}.get.parameters[].schema.description
Granularity of the time series data. Default is day.

# paths./vault/{vaultOrSuperformIDOrContractAddress}.get.description
Get vault data by vaultID, superformID, or contractAddress.

# paths./withdraw/calculate.post.description
This is the first of two steps for a withdrawal flow. After providing relevant options as input, this endpoint will return a number of possible routes. The selected route should be used as input for the `/withdraw/start` endpoint.

# paths./withdraw/start.post.description
This is the second and final step in the withdrawal flow. The expected input is the full output of `/withdraw/calculate`. The selected route should be first, or only, route in the `liq.route.routes` array. The response of this endpoint will provide the transaction data and relevant metadata to execute the transaction onchain. 
 > **Note**: if the `approval_data` field is not empty, the user must first approve the token transfer before executing the transaction.