> ## Documentation Index > Fetch the complete documentation index at: https://docs.superform.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get Vault Details ## OpenAPI ````yaml https://persephone.superform.xyz/openapi.json get /v1/vaults/{id} openapi: 3.1.0 info: title: Superform API description: API for interacting with the Superform platform version: 33.2.0 contact: name: Superform Team url: https://superform.xyz servers: - url: https://persephone.superform.xyz security: - SF-API-KEY: [] tags: - name: RestAPIService paths: /v1/vaults/{id}: get: tags: - RestAPIService summary: Get Vault Details operationId: RestAPIService_GetVaultDetails parameters: - name: id description: Vault ID (chain_id + '_' + address) in: path required: true schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/restGetVaultDetailsResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/rpcStatus' components: schemas: restGetVaultDetailsResponse: type: object properties: vault: $ref: '#/components/schemas/commonVault' rpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' commonVault: type: object properties: id: type: string title: chain_id + "_" + address address: type: string chain_id: type: string format: uint64 name: type: string symbol: type: string decimals: type: integer format: int32 friendly_name: type: string category: type: string title: yield, staking, rwa, etc type: type: string example: '4626' enum: - '4626' - fully_async_7540 - async_deposit_7540 - async_redeem_7540 description: >- Canonical vault standard. Allowed values: 4626, fully_async_7540, async_deposit_7540, async_redeem_7540. description: type: string short_description: type: string description: Optional short vault description. Maximum 200 characters. visibility: type: string example: listed description: 'Visibility of the vault. One of: listed, unlisted, hidden, featured.' availability: type: string example: available description: >- Availability of the vault. One of: available, unavailable, paused, withdraw_only, deposit_only. risk_rating: type: string risk_data: $ref: '#/components/schemas/commonVaultRiskData' status_message: type: string external_url: type: string has_rewards: type: boolean description: Kept for backwards compatibility with current frontend consumers. is_on_mobile: type: boolean has_timelock: type: boolean timelock_duration: type: string format: uint64 timelock_unit: type: string is_supervault: type: boolean is_on_earn_page: type: boolean is_supervault_v2: type: boolean asset_ids: type: array items: type: string title: many-to-many association provider_ids: type: array items: type: string title: many-to-many association yield_source_ids: type: array items: type: string title: identifiers for underlying yield sources metadata: $ref: '#/components/schemas/commonVaultMetadata' stats_basic: $ref: '#/components/schemas/commonVaultStatsBasic' deployment_date: type: string format: date-time title: date deployed onchain created_at: type: string format: date-time title: date listed on superform admin_status: type: string example: approved description: >- Admin approval status for the vault. One of: enqueued, approved, rejected. title: Vault represents a yield-generating vault protobufAny: type: object properties: '@type': type: string additionalProperties: {} commonVaultRiskData: type: object properties: pool_rating: type: string pool_rating_color: type: string pool_rating_description: type: string pool_url: type: string pool_design: $ref: '#/components/schemas/VaultRiskDataPoolDesign' chain: $ref: '#/components/schemas/VaultRiskDataRiskCategory' assets: $ref: '#/components/schemas/VaultRiskDataRiskCategory' protocols: $ref: '#/components/schemas/VaultRiskDataRiskCategory' commonVaultMetadata: type: object properties: audits: type: array items: $ref: '#/components/schemas/commonAudit' kyc: type: array items: $ref: '#/components/schemas/VaultMetadataKYC' faq: type: array items: $ref: '#/components/schemas/commonFAQ' other: type: array items: $ref: '#/components/schemas/VaultMetadataOther' commonVaultStatsBasic: type: object properties: apy_snapshot_now: type: number format: double apy_snapshot_day: type: number format: double apy_snapshot_week: type: number format: double apy_snapshot_month: type: number format: double apy_snapshot_year: type: number format: double apy_snapshot_all_time: type: number format: double apy_change_day: type: number format: double apy_change_week: type: number format: double apy_change_month: type: number format: double apy_change_year: type: number format: double apy_change_all_time: type: number format: double tvl_total: type: number format: double tvl_superform: type: number format: double tvl_total_change_day: type: number format: double tvl_total_change_week: type: number format: double tvl_total_change_month: type: number format: double tvl_total_change_year: type: number format: double tvl_total_change_all_time: type: number format: double tvl_superform_change_day: type: number format: double tvl_superform_change_week: type: number format: double tvl_superform_change_month: type: number format: double tvl_superform_change_year: type: number format: double tvl_superform_change_all_time: type: number format: double sharpe_snapshot_day: type: number format: double sharpe_snapshot_week: type: number format: double sharpe_snapshot_month: type: number format: double sharpe_snapshot_year: type: number format: double sharpe_snapshot_all_time: type: number format: double return_day: type: number format: double return_week: type: number format: double return_month: type: number format: double return_year: type: number format: double return_all_time: type: number format: double pps: type: number format: double pps_usd: type: number format: double reward_rate: type: number format: double net_inflow_total_day: type: number format: double description: >- Signed net inflow in USD over the trailing window (positive = inflow, negative = outflow), derived from share-supply deltas. net_inflow_total_week: type: number format: double net_inflow_total_month: type: number format: double net_inflow_total_day_assets: type: number format: double description: >- Same signal denominated in whole units of the vault's underlying asset (e.g. 10.5 = 10.5 USDC for a USDC vault). Signed. net_inflow_total_week_assets: type: number format: double net_inflow_total_month_assets: type: number format: double VaultRiskDataPoolDesign: type: object properties: rating: type: string rating_color: type: string VaultRiskDataRiskCategory: type: object properties: rating: type: string rating_color: type: string underlying: type: array items: $ref: '#/components/schemas/VaultRiskDataUnderlying' commonAudit: type: object properties: date: type: string format: date-time url: type: string auditor: type: string VaultMetadataKYC: type: object properties: issuer: type: string issuer_link: type: string provider: type: string commonFAQ: type: object properties: question: type: string answer: type: string title: '--- metadata types ---' VaultMetadataOther: type: object properties: info: type: string description: type: string VaultRiskDataUnderlying: type: object properties: name: type: string rating: type: string rating_color: type: string url: type: string securitySchemes: SF-API-KEY: type: apiKey description: >- API key required for authentication. Use the value {{v2_api_key}} in Postman. name: SF-API-KEY in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.