Sign in

v1

latestOpenAPI 3.1.02026-08-0466147138.0 KB
Vault

Get vault data

Get vault data by vaultID, superformID, or contractAddress.

get/vault/{vaultOrSuperformIDOrContractAddress}

Path parameters

vaultOrSuperformIDOrContractAddressstring required
Example:6277101738082190570017043140855561342102135322485627578637

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

availability'available' | 'unavailable' | 'paused' | 'withdraw_only' | 'deposit_only' | ''

Availability on the Superform platform

contract_addressstring

This comes from on-chain data, it is the address of the vault contract.

created_atstring date-time
decimalsinteger

This comes from on-chain data, decimals of the vault.

deploy_datestring date-time

The date the vault was deployed on-chain.

descriptionstring

The description of the vault. Required when creating vault.

external_urlstring

The external URL of the vault.

form_implementation_idstring required

This is the formImplementationID of the vault

friendly_namestring

The friendly name of the vault.

has_aerc_20_registeredboolean

Whether the vault has an AERC20 registered.

has_rewardsboolean nullable
has_timelockboolean nullable

Whether the vault has a timelock.

idstring

This is the unique identifier for this vault.

is_authenticatedboolean
is_supervaultboolean
namestring required

This is the name of the vault.

num_depositorsinteger

The number of Superform depositors in the vault.

protocol_idstring nullable

Optional. This is the unique identifier for the protocol that this vault belongs to.

recommend_vault_share_withdrawalboolean nullable
risk_data_last_updatedstring date-time

The last time the risk data was updated.

super_poolsinteger[]

Array of chainIDs on which there is a liquidity pool for this vault

superform_addressstring nullable

This comes from on-chain data, it is the address of the superform contract.

superform_idstring nullable

This comes from on-chain data, it is the unique identifier for this superform.

symbolstring

This comes from on-chain data, symbol of the vault.

timelock_durationinteger nullable

The duration of the timelock.

timelock_unit'hours' | 'days' | 'weeks' | 'months' | 'years' | '' nullable

The unit of the timelock duration.

updated_atstring date-time
vault_listerstring

The address of the user who listed the vault.

vault_status_messagestring nullable

Optional. The status message of the vault.

visibility'listed' | 'unlisted' | 'hidden' | 'featured' | ''

Visibility on the Superform platform

withdraw_to_vault_asset_onlyboolean nullable

If confidence score falls below a threshold, the vault will only allow withdrawals to the vault asset to minimize crosschain withdrawal failure rate.

withdrawal_confidence_scorenumber double nullable

This confidence score is based on revent withdrwawal failure rate

withdrawal_linkstring
yield_sourcestring

The yield source of the vault.

yield_type'Yield' | 'Liquid Staking' | 'Liquid Restaking' | 'Lending' | 'Basis Trading' | 'RWA' | 'Dexes' | 'Derivatives' | 'Yield Aggregator' | 'Leveraged Farming' | 'Insurance' | 'Intelligent' | 'Onchain Capital Allocator'

The yield type of the vault. Required when creating vault.

Example response

{
  "$schema": "https://api.superform.xyz/schemas/Vault.json",
  "protocol": {
    "$schema": "https://api.superform.xyz/schemas/Protocol.json"
  },
  "super_pools": [
    1,
    137
  ],
  "timelock_duration": 7
}