{"openapi":"3.0.3","info":{"title":"Vaults.fyi API","version":"2.0.0","description":"The Vaults.fyi V2 API offers a streamlined, better structured, and more performant interface for accessing DeFi vault data. This simplified version delivers optimized performance while maintaining comprehensive coverage across networks. Basic API key use is limited to 10 requests per minute."},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"x-api-key","in":"header"}},"schemas":{}},"paths":{"/v2/health":{"get":{"operationId":"getHealth","summary":"Health check","tags":["Health"],"description":"Checks the health status of the API and its dependencies including database connections and cache availability.","responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}},"required":["status","message"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/vaults":{"get":{"operationId":"listVaults","summary":"List vaults","tags":["General"],"description":"Retrieves a filtered list of vaults with their basic information including address, network, associated asset details, and transactional support status.","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":5000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"query","name":"network","required":false,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string","minLength":1},"in":"query","name":"assetSymbol","required":false,"description":"Include only vaults with an asset of provided symbol(ticker)"},{"schema":{"type":"boolean"},"in":"query","name":"onlyTransactional","required":false,"description":"Include only vaults that are supported in the transactional interface."},{"schema":{"type":"boolean"},"in":"query","name":"onlyAppFeatured","required":false,"description":"Include only vaults that are featured in app.vaults.fyi"},{"schema":{"type":"boolean","default":false},"in":"query","name":"allowCorrupted","required":false,"description":"Allow inclusion of corrupted vaults."}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault"},"name":{"type":"string","description":"Name of the vault"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the vault"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi"}},"required":["vaultId","address","name","network","asset","isTransactional","isAppFeatured"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/assets":{"get":{"operationId":"listAssets","summary":"List assets","tags":["General"],"description":"Retrieves a filtered list of supported assets with their metadata including address, symbol, name, decimals, and network information.","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":5000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"query","name":"network","required":false,"description":"Include only vaults with provided network(name or CAIP)"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the asset"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","network"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/tags":{"get":{"operationId":"listTags","summary":"List tags","tags":["General"],"description":"Retrieves a complete list of available vault categorization tags that can be used for filtering and organizing vault data","security":[{"apiKey":[]}],"responses":{"200":{"description":"Tags of the vault","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","minLength":1},"description":"Tags of the vault"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/networks":{"get":{"operationId":"listNetworks","summary":"List networks","tags":["General"],"description":"Retrieves a complete list of supported blockchain networks with their identifiers including network name, chain ID, and CAIP format identifier.","security":[{"apiKey":[]}],"responses":{"200":{"description":"List of supported networks","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false},"description":"List of supported networks"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/curators":{"get":{"operationId":"listCurators","summary":"List curators","tags":["General"],"description":"Retrieves a complete list of available vault curators that can be used for filtering and organizing vault data","security":[{"apiKey":[]}],"responses":{"200":{"description":"List of curators","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the curator"},"displayName":{"type":"string","description":"Display name of the curator"},"description":{"type":"string","description":"Description of the curator"},"websiteUrl":{"type":"string","description":"Website URL of the curator"}},"required":["name"],"additionalProperties":false},"description":"List of curators"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/protocols":{"get":{"operationId":"listProtocols","summary":"List protocols","tags":["General"],"description":"Retrieves a complete list of available protocols that can be used for filtering and organizing vault data","security":[{"apiKey":[]}],"responses":{"200":{"description":"List of protocols","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"}},"required":["protocolId","name"],"additionalProperties":false},"description":"List of protocols"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/historical/{network}/{vaultId}":{"get":{"operationId":"getHistoricalData","summary":"Get vault historical data","tags":["Historical"],"description":"Retrieves historical APY and TVL for a specific vault, based on the provided query parameters.","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":20000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"string","enum":["1hour","1day","1week"],"default":"1hour"},"in":"query","name":"granularity","required":false,"description":"Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week"},{"schema":{"type":"integer","default":0},"in":"query","name":"fromTimestamp","required":false,"description":"Timestamp for the start of the time period for which data will be fetched"},{"schema":{"type":"integer"},"in":"query","name":"toTimestamp","required":false,"description":"Timestamp for the end of the time period for which data will be fetched"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Historical TVL and APY data for a vault, paginated by timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Timestamp of the data point"},"blockNumber":{"type":"string","description":"Block number of the data point"},"apy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY breakdown"},"tvl":{"type":"object","properties":{"usd":{"type":"string","description":"TVL in USD"},"native":{"type":"string","description":"Native TVL"}},"required":["usd","native"],"additionalProperties":false,"description":"TVL breakdown"},"sharePrice":{"type":"number","description":"Share price of vault"}},"required":["timestamp","blockNumber","apy","tvl","sharePrice"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false,"description":"Historical TVL and APY data for a vault, paginated by timestamp"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/historical/{network}/{vaultId}/apy":{"get":{"operationId":"getHistoricalApy","summary":"Get historical APY","tags":["Historical"],"description":"Retrieves time-series historical APY data for a specific vault, including base yield and rewards components over a customizable time range","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":20000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"string","enum":["1hour","1day","1week"],"default":"1hour"},"in":"query","name":"granularity","required":false,"description":"Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week"},{"schema":{"type":"integer","default":0},"in":"query","name":"fromTimestamp","required":false,"description":"Timestamp for the start of the time period for which data will be fetched"},{"schema":{"type":"integer"},"in":"query","name":"toTimestamp","required":false,"description":"Timestamp for the end of the time period for which data will be fetched"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Historical APY data for a vault, paginated by timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Timestamp of the data point"},"blockNumber":{"type":"string","description":"Block number of the data point"},"apy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY breakdown"}},"required":["timestamp","blockNumber","apy"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false,"description":"Historical APY data for a vault, paginated by timestamp"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/historical/{network}/{vaultId}/tvl":{"get":{"operationId":"getHistoricalTvl","summary":"Get historical TVL","tags":["Historical"],"description":"Retrieves time-series historical TVL data for a specific vault, including base yield and rewards components over a customizable time range","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":20000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"string","enum":["1hour","1day","1week"],"default":"1hour"},"in":"query","name":"granularity","required":false,"description":"Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week"},{"schema":{"type":"integer","default":0},"in":"query","name":"fromTimestamp","required":false,"description":"Timestamp for the start of the time period for which data will be fetched"},{"schema":{"type":"integer"},"in":"query","name":"toTimestamp","required":false,"description":"Timestamp for the end of the time period for which data will be fetched"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Historical TVL data for a vault, paginated by timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Timestamp of the data point"},"blockNumber":{"type":"string","description":"Block number of the data point"},"tvl":{"type":"object","properties":{"usd":{"type":"string","description":"TVL in USD"},"native":{"type":"string","description":"Native TVL"}},"required":["usd","native"],"additionalProperties":false,"description":"TVL breakdown"}},"required":["timestamp","blockNumber","tvl"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false,"description":"Historical TVL data for a vault, paginated by timestamp"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/historical/{network}/{vaultId}/sharePrice":{"get":{"operationId":"getHistoricalSharePrice","summary":"Get historical share price","tags":["Historical"],"description":"Retrieves time-series historical TVL data for a specific vault, including base yield and rewards components over a customizable time range","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":20000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"string","enum":["1hour","1day","1week"],"default":"1hour"},"in":"query","name":"granularity","required":false,"description":"Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week"},{"schema":{"type":"integer","default":0},"in":"query","name":"fromTimestamp","required":false,"description":"Timestamp for the start of the time period for which data will be fetched"},{"schema":{"type":"integer"},"in":"query","name":"toTimestamp","required":false,"description":"Timestamp for the end of the time period for which data will be fetched"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Historical SharePrice data for a vault, paginated by timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Timestamp of the data point"},"blockNumber":{"type":"string","description":"Block number of the data point"},"sharePrice":{"type":"number","description":"Share price of vault"}},"required":["timestamp","blockNumber","sharePrice"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false,"description":"Historical SharePrice data for a vault, paginated by timestamp"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/historical/asset-prices/{network}/{assetAddress}":{"get":{"operationId":"getHistoricalAssetPrices","summary":"Get historical asset prices","tags":["Historical"],"description":"Retrieves historical USD prices for a specific asset on a given network.","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":20000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["1hour","1day","1week"],"default":"1hour"},"in":"query","name":"granularity","required":false,"description":"Granularity for historical data (even intervals starting from epoch 0). Possible values: 1hour, 1day, 1week"},{"schema":{"type":"integer","default":0},"in":"query","name":"fromTimestamp","required":false,"description":"Timestamp for the start of the time period for which data will be fetched"},{"schema":{"type":"integer"},"in":"query","name":"toTimestamp","required":false,"description":"Timestamp for the end of the time period for which data will be fetched"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"assetAddress","required":true,"description":"Asset address to get the historical prices for"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Historical price data for an asset, paginated by timestamp","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Aggregating timestamp of the price data point"},"priceInUsd":{"type":"string","description":"Asset price in USD"}},"required":["timestamp","priceInUsd"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false,"description":"Historical price data for an asset, paginated by timestamp"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/detailed-vaults":{"get":{"operationId":"listDetailedVaults","summary":"List detailed vaults","tags":["Detailed Vaults"],"description":"Retrieves a comprehensive list of vaults with detailed performance metrics including APY, TVL, rewards, risk scores, and protocol information based on specified filters.","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":5000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedAssets","required":false,"description":"Assets to be included by symbol(ticker)."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedAssets","required":false,"description":"Assets to be excluded by symbol(ticker). The parameter is ignored if \"allowedAssets\" is specified."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedProtocols","required":false,"description":"Protocols to be included by protocol ID or name."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedProtocols","required":false,"description":"Protocols to be excluded by protocol ID or name. The parameter is ignored if \"allowedProtocols\" is specified."},{"schema":{"type":"integer","minimum":0,"default":100000},"in":"query","name":"minTvl","required":false,"description":"Minimum TVL in USD of the vaults to be included"},{"schema":{"type":"number","minimum":0},"in":"query","name":"minVaultScore","required":false,"description":"Minimum vault score required for a vault to be included"},{"schema":{"type":"boolean"},"in":"query","name":"onlyTransactional","required":false,"description":"Include only vaults that are supported in the transactional interface."},{"schema":{"type":"boolean"},"in":"query","name":"onlyAppFeatured","required":false,"description":"Include only vaults that are featured in app.vaults.fyi"},{"schema":{"type":"boolean","default":false},"in":"query","name":"allowCorrupted","required":false,"description":"Allow inclusion of corrupted vaults."},{"schema":{"type":"boolean"},"in":"query","name":"allowVaultsWithWarnings","required":false,"description":"Whether to include vaults with warnings. Defaults to true."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"},"default":["base","mainnet","arbitrum","optimism"]},"in":"query","name":"allowedNetworks","required":false,"description":"Networks to be included (name or CAIP)."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"}},"in":"query","name":"disallowedNetworks","required":false,"description":"Networks to be excluded (name or CAIP). The parameter is ignored if \"allowedNetworks\" is specified."},{"schema":{"type":"integer"},"in":"query","name":"maxTvl","required":false,"description":"Maximum TVL in USD of the vaults to be included"},{"schema":{"type":"number"},"in":"query","name":"maxApy","required":false,"description":"Maximum APY (in decimal) of the vaults to be included"},{"schema":{"type":"number"},"in":"query","name":"minApy","required":false,"description":"Minimum APY (in decimal) of the vaults to be included"},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"tags","required":false,"description":"Tags to be included."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"curators","required":false,"description":"Curators to be included."},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"sortOrder","required":false,"description":"Sort order, either asc or desc. Ascending is default."},{"schema":{"type":"string","enum":["tvl","apy1day","apy7day","apy30day"]},"in":"query","name":"sortBy","required":false,"description":"Field to sort by"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault"},"name":{"type":"string","description":"Name of the vault"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the vault"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi"},"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"description":{"type":"string","description":"Description of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"}},"required":["protocolId","name"],"additionalProperties":false,"description":"Protocol details of the vault"},"lendUrl":{"type":"string","description":"URL to lend the asset"},"description":{"type":"string","description":"Description of the vault"},"protocolVaultUrl":{"type":"string","description":"URL to the protocol vault"},"tags":{"type":"array","items":{"type":"string","minLength":1},"description":"Tags of the vault"},"holdersData":{"type":"object","properties":{"totalCount":{"type":"number","description":"Number of holders of the vault"},"totalBalance":{"type":"string","description":"Total balance of the vault holders"},"topHolders":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the holder"},"lpTokenBalance":{"type":"string","description":"Balance of the LP token of the holder"}},"required":["address","lpTokenBalance"],"additionalProperties":false},"description":"Top holders of the vault"}},"additionalProperties":false},"apy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"},"1hour":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1hour APY details"}},"required":["1day","7day","30day","1hour"],"additionalProperties":false,"description":"APY details of the vault"},"tvl":{"type":"object","properties":{"usd":{"type":"string","description":"TVL in USD"},"native":{"type":"string","description":"Native TVL"}},"required":["usd","native"],"additionalProperties":false,"description":"TVL details of the vault"},"lastUpdateTimestamp":{"type":"integer","description":"Timestamp of the last vault data update"},"creationData":{"type":"object","properties":{"deploymentTimestamp":{"type":"integer","description":"Timestamp of the vault contract deployment block"}},"required":["deploymentTimestamp"],"additionalProperties":false,"description":"Vault contract creation data"},"rewards":{"type":"array","items":{"type":"object","properties":{"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the reward"},"apy":{"type":"object","properties":{"1hour":{"type":"number","description":"1hour APY of the reward asset"},"1day":{"type":"number","description":"1day APY of the reward asset"},"7day":{"type":"number","description":"7day APY of the reward asset"},"30day":{"type":"number","description":"30day APY of the reward asset"}},"required":["1hour","1day","7day","30day"],"additionalProperties":false}},"required":["asset","apy"],"additionalProperties":false},"description":"List of rewards for the vault"},"score":{"type":"object","properties":{"vaultScore":{"type":"number","description":"Score of the vault"},"vaultTvlScore":{"type":"number","description":"TVL score of the vault"},"protocolTvlScore":{"type":"number","description":"TVL score of the protocol"},"holderScore":{"type":"number","description":"Holder score of the vault"},"networkScore":{"type":"number","description":"Deprecated network score; not included in the Reputation Score"},"assetScore":{"type":"number","description":"Asset score of the vault"},"totalScorePenalty":{"type":"number","description":"Penalty applied to the vault score"},"penaltyComponents":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"content":{"type":"string","description":"Content of the flag"},"severity":{"type":"string","enum":["info","warning","critical"],"description":"Severity level of the flag"},"endDate":{"type":"number","description":"Unix timestamp (seconds) when this flag expires"},"resolution":{"type":"string","description":"Resolution details if the flag has been resolved"},"type":{"type":"string","enum":["flag"],"description":"Type of the penalty component"},"value":{"type":"number","description":"Value of the penalty component, e.g., flag penalty or score factor penalty"}},"required":["content","severity","endDate","type","value"],"additionalProperties":false,"description":"Penalty component derived from a flag"},{"type":"object","properties":{"type":{"type":"string","description":"Type of the penalty component, e.g., score factor penalty"},"value":{"type":"number","description":"Value of the score factor penalty, e.g., 0.1 for a 10% penalty"}},"required":["type","value"],"additionalProperties":false,"description":"Penalty component derived from a score factor"}]},"description":"List of penalty components applied to the vault score"}},"required":["vaultScore","vaultTvlScore","protocolTvlScore","holderScore","networkScore","assetScore","totalScorePenalty","penaltyComponents"],"additionalProperties":false,"description":"Score details of the vault"},"additionalIncentives":{"type":"string","description":"Additional incentives of the vault"},"curator":{"type":"object","properties":{"name":{"type":"string","description":"Name of the curator"},"displayName":{"type":"string","description":"Display name of the curator"},"description":{"type":"string","description":"Description of the curator"},"websiteUrl":{"type":"string","description":"Website URL of the curator"}},"required":["name"],"additionalProperties":false,"description":"Curator of the vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"}},"required":["address","tokenCaip","name","symbol","decimals"],"additionalProperties":false,"description":"LP token details of the vault"},"remainingCapacity":{"type":"string","description":"Remaining capacity of the vault"},"maxCapacity":{"type":"string","description":"Maximum capacity limit of the vault"},"isCorrupted":{"type":"boolean","description":"Indicates if the vault is corrupted"},"userEventsIndexed":{"type":"boolean","description":"Indicates if user events related to the vault are indexed and available in the API"},"childrenVaults":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the child vault"},"address":{"type":"string","description":"Address of the child vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the child vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"}},"required":["address","tokenCaip","name","symbol","decimals"],"additionalProperties":false,"description":"LP token details of the child vault"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false},"description":"Additional assets of the child vault"}},"required":["vaultId","address","asset"],"additionalProperties":false},"description":"List of child vaults"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false},"description":"Additional assets of the vault"},"transactionalProperties":{"type":"object","properties":{"depositStepsType":{"type":"string","enum":["instant","complex"],"description":"Type of transaction steps, either \"instant\" or \"complex\""},"redeemStepsType":{"type":"string","enum":["instant","complex"],"description":"Type of transaction steps, either \"instant\" or \"complex\""},"rewardsSupported":{"type":"boolean","description":"Indicates if the vault supports rewards transaction flows"}},"required":["depositStepsType","redeemStepsType","rewardsSupported"],"additionalProperties":false,"description":"Transactional properties of the vault"},"fees":{"type":"object","properties":{"performanceFee":{"type":"number","description":"Performance fee as decimal"},"managementFee":{"type":"number","description":"Management fee as decimal"},"withdrawalFee":{"type":"number","description":"Withdrawal fee as decimal"},"depositFee":{"type":"number","description":"Deposit fee as decimal"}},"additionalProperties":false,"description":"Fee structure of the vault"},"warnings":{"type":"array","items":{"type":"string"},"description":"List of warnings related to the vault"},"flags":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string","description":"Content of the flag"},"severity":{"type":"string","enum":["info","warning","critical"],"description":"Severity level of the flag"},"endDate":{"type":"number","description":"Unix timestamp (seconds) when this flag expires"},"resolution":{"type":"string","description":"Resolution details if the flag has been resolved"}},"required":["content","severity","endDate"],"additionalProperties":false},"description":"List of flags with severity and expiry information"},"apyComposite":{"type":"object","properties":{"totalApy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"},"1hour":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1hour APY details"}},"required":["1day","7day","30day","1hour"],"additionalProperties":false,"description":"Compounded APY details combining the vault and its underlying vault"},"intrinsicApy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"},"1hour":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1hour APY details"}},"required":["1day","7day","30day","1hour"],"additionalProperties":false,"description":"APY details of the underlying vault before compounding"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the underlying vault"},"vault":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the underlying vault"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the underlying vault"}},"required":["vaultId","address"],"additionalProperties":false}},"required":["totalApy","intrinsicApy","asset","vault"],"additionalProperties":false,"description":"Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY"}},"required":["vaultId","address","name","network","asset","isTransactional","isAppFeatured","protocol","tags","holdersData","apy","tvl","lastUpdateTimestamp","creationData","rewards","isCorrupted","userEventsIndexed","warnings","flags"],"additionalProperties":false,"description":"Array of items on the current page"}},"errors":{"type":"object","properties":{"unsupportedNetworks":{"type":"array","items":{"type":"string"}},"unsupportedAssets":{"type":"array","items":{"type":"string"}},"unsupportedProtocols":{"type":"array","items":{"type":"string"}}},"required":["unsupportedNetworks","unsupportedAssets","unsupportedProtocols"],"additionalProperties":false}},"required":["itemsOnPage","data","errors"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/detailed-vaults/{network}/{vaultId}":{"get":{"operationId":"getDetailedVault","summary":"Get vault details","tags":["Detailed Vaults"],"description":"Retrieves a detailed performance metrics of single vault including APY, TVL, rewards, risk scores, and protocol information based on specified filters.","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault"},"name":{"type":"string","description":"Name of the vault"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the vault"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi"},"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"description":{"type":"string","description":"Description of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"}},"required":["protocolId","name"],"additionalProperties":false,"description":"Protocol details of the vault"},"lendUrl":{"type":"string","description":"URL to lend the asset"},"description":{"type":"string","description":"Description of the vault"},"protocolVaultUrl":{"type":"string","description":"URL to the protocol vault"},"tags":{"type":"array","items":{"type":"string","minLength":1},"description":"Tags of the vault"},"holdersData":{"type":"object","properties":{"totalCount":{"type":"number","description":"Number of holders of the vault"},"totalBalance":{"type":"string","description":"Total balance of the vault holders"},"topHolders":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the holder"},"lpTokenBalance":{"type":"string","description":"Balance of the LP token of the holder"}},"required":["address","lpTokenBalance"],"additionalProperties":false},"description":"Top holders of the vault"}},"additionalProperties":false},"apy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"},"1hour":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1hour APY details"}},"required":["1day","7day","30day","1hour"],"additionalProperties":false,"description":"APY details of the vault"},"tvl":{"type":"object","properties":{"usd":{"type":"string","description":"TVL in USD"},"native":{"type":"string","description":"Native TVL"}},"required":["usd","native"],"additionalProperties":false,"description":"TVL details of the vault"},"lastUpdateTimestamp":{"type":"integer","description":"Timestamp of the last vault data update"},"creationData":{"type":"object","properties":{"deploymentTimestamp":{"type":"integer","description":"Timestamp of the vault contract deployment block"}},"required":["deploymentTimestamp"],"additionalProperties":false,"description":"Vault contract creation data"},"rewards":{"type":"array","items":{"type":"object","properties":{"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the reward"},"apy":{"type":"object","properties":{"1hour":{"type":"number","description":"1hour APY of the reward asset"},"1day":{"type":"number","description":"1day APY of the reward asset"},"7day":{"type":"number","description":"7day APY of the reward asset"},"30day":{"type":"number","description":"30day APY of the reward asset"}},"required":["1hour","1day","7day","30day"],"additionalProperties":false}},"required":["asset","apy"],"additionalProperties":false},"description":"List of rewards for the vault"},"score":{"type":"object","properties":{"vaultScore":{"type":"number","description":"Score of the vault"},"vaultTvlScore":{"type":"number","description":"TVL score of the vault"},"protocolTvlScore":{"type":"number","description":"TVL score of the protocol"},"holderScore":{"type":"number","description":"Holder score of the vault"},"networkScore":{"type":"number","description":"Deprecated network score; not included in the Reputation Score"},"assetScore":{"type":"number","description":"Asset score of the vault"},"totalScorePenalty":{"type":"number","description":"Penalty applied to the vault score"},"penaltyComponents":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"content":{"type":"string","description":"Content of the flag"},"severity":{"type":"string","enum":["info","warning","critical"],"description":"Severity level of the flag"},"endDate":{"type":"number","description":"Unix timestamp (seconds) when this flag expires"},"resolution":{"type":"string","description":"Resolution details if the flag has been resolved"},"type":{"type":"string","enum":["flag"],"description":"Type of the penalty component"},"value":{"type":"number","description":"Value of the penalty component, e.g., flag penalty or score factor penalty"}},"required":["content","severity","endDate","type","value"],"additionalProperties":false,"description":"Penalty component derived from a flag"},{"type":"object","properties":{"type":{"type":"string","description":"Type of the penalty component, e.g., score factor penalty"},"value":{"type":"number","description":"Value of the score factor penalty, e.g., 0.1 for a 10% penalty"}},"required":["type","value"],"additionalProperties":false,"description":"Penalty component derived from a score factor"}]},"description":"List of penalty components applied to the vault score"}},"required":["vaultScore","vaultTvlScore","protocolTvlScore","holderScore","networkScore","assetScore","totalScorePenalty","penaltyComponents"],"additionalProperties":false,"description":"Score details of the vault"},"additionalIncentives":{"type":"string","description":"Additional incentives of the vault"},"curator":{"type":"object","properties":{"name":{"type":"string","description":"Name of the curator"},"displayName":{"type":"string","description":"Display name of the curator"},"description":{"type":"string","description":"Description of the curator"},"websiteUrl":{"type":"string","description":"Website URL of the curator"}},"required":["name"],"additionalProperties":false,"description":"Curator of the vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"}},"required":["address","tokenCaip","name","symbol","decimals"],"additionalProperties":false,"description":"LP token details of the vault"},"remainingCapacity":{"type":"string","description":"Remaining capacity of the vault"},"maxCapacity":{"type":"string","description":"Maximum capacity limit of the vault"},"isCorrupted":{"type":"boolean","description":"Indicates if the vault is corrupted"},"userEventsIndexed":{"type":"boolean","description":"Indicates if user events related to the vault are indexed and available in the API"},"childrenVaults":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the child vault"},"address":{"type":"string","description":"Address of the child vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the child vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"}},"required":["address","tokenCaip","name","symbol","decimals"],"additionalProperties":false,"description":"LP token details of the child vault"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false},"description":"Additional assets of the child vault"}},"required":["vaultId","address","asset"],"additionalProperties":false},"description":"List of child vaults"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false},"description":"Additional assets of the vault"},"transactionalProperties":{"type":"object","properties":{"depositStepsType":{"type":"string","enum":["instant","complex"],"description":"Type of transaction steps, either \"instant\" or \"complex\""},"redeemStepsType":{"type":"string","enum":["instant","complex"],"description":"Type of transaction steps, either \"instant\" or \"complex\""},"rewardsSupported":{"type":"boolean","description":"Indicates if the vault supports rewards transaction flows"}},"required":["depositStepsType","redeemStepsType","rewardsSupported"],"additionalProperties":false,"description":"Transactional properties of the vault"},"fees":{"type":"object","properties":{"performanceFee":{"type":"number","description":"Performance fee as decimal"},"managementFee":{"type":"number","description":"Management fee as decimal"},"withdrawalFee":{"type":"number","description":"Withdrawal fee as decimal"},"depositFee":{"type":"number","description":"Deposit fee as decimal"}},"additionalProperties":false,"description":"Fee structure of the vault"},"warnings":{"type":"array","items":{"type":"string"},"description":"List of warnings related to the vault"},"flags":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string","description":"Content of the flag"},"severity":{"type":"string","enum":["info","warning","critical"],"description":"Severity level of the flag"},"endDate":{"type":"number","description":"Unix timestamp (seconds) when this flag expires"},"resolution":{"type":"string","description":"Resolution details if the flag has been resolved"}},"required":["content","severity","endDate"],"additionalProperties":false},"description":"List of flags with severity and expiry information"},"apyComposite":{"type":"object","properties":{"totalApy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"},"1hour":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1hour APY details"}},"required":["1day","7day","30day","1hour"],"additionalProperties":false,"description":"Compounded APY details combining the vault and its underlying vault"},"intrinsicApy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"},"1hour":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1hour APY details"}},"required":["1day","7day","30day","1hour"],"additionalProperties":false,"description":"APY details of the underlying vault before compounding"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the underlying vault"},"vault":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the underlying vault"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the underlying vault"}},"required":["vaultId","address"],"additionalProperties":false}},"required":["totalApy","intrinsicApy","asset","vault"],"additionalProperties":false,"description":"Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY"}},"required":["vaultId","address","name","network","asset","isTransactional","isAppFeatured","protocol","tags","holdersData","apy","tvl","lastUpdateTimestamp","creationData","rewards","isCorrupted","userEventsIndexed","warnings","flags"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/detailed-vaults/{network}/{vaultId}/apy":{"get":{"operationId":"getVaultApy","summary":"Get vault APY","tags":["Detailed Vaults"],"description":"Retrieves vault APY breakdown.","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"}},"required":["1day","7day","30day"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/detailed-vaults/{network}/{vaultId}/tvl":{"get":{"operationId":"getVaultTvl","summary":"Get vault TVL","tags":["Detailed Vaults"],"description":"Retrieves vault Tvl breakdown.","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"usd":{"type":"string","description":"TVL in USD"},"native":{"type":"string","description":"Native TVL"}},"required":["usd","native"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/portfolio/best-vault/{userAddress}":{"get":{"operationId":"getBestVault","summary":"Get best vault","tags":["Portfolio"],"description":"Returns the single best vault opportunity for the user, based on balance and yield analysis.","parameters":[{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedAssets","required":false,"description":"Assets to be included by symbol(ticker)."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedAssets","required":false,"description":"Assets to be excluded by symbol(ticker). The parameter is ignored if \"allowedAssets\" is specified."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedProtocols","required":false,"description":"Protocols to be included by protocol ID or name."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedProtocols","required":false,"description":"Protocols to be excluded by protocol ID or name. The parameter is ignored if \"allowedProtocols\" is specified."},{"schema":{"type":"integer","minimum":0,"default":100000},"in":"query","name":"minTvl","required":false,"description":"Minimum TVL in USD of the vaults to be included"},{"schema":{"type":"number","minimum":0},"in":"query","name":"minVaultScore","required":false,"description":"Minimum vault score required for a vault to be included"},{"schema":{"type":"boolean"},"in":"query","name":"onlyTransactional","required":false,"description":"Include only vaults that are supported in the transactional interface."},{"schema":{"type":"boolean","default":"true"},"in":"query","name":"onlyAppFeatured","required":false,"description":"Include only vaults that are featured in app.vaults.fyi"},{"schema":{"type":"boolean","default":false},"in":"query","name":"allowCorrupted","required":false,"description":"Allow inclusion of corrupted vaults."},{"schema":{"type":"boolean","default":"false"},"in":"query","name":"allowVaultsWithWarnings","required":false,"description":"Whether to include vaults with warnings. Defaults to false."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"},"default":["base","mainnet","arbitrum","optimism"]},"in":"query","name":"allowedNetworks","required":false,"description":"Networks to be included (name or CAIP)."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"}},"in":"query","name":"disallowedNetworks","required":false,"description":"Networks to be excluded (name or CAIP). The parameter is ignored if \"allowedNetworks\" is specified."},{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"number","minimum":0},"in":"query","name":"minApy","required":false,"description":"Minimum APY of the vault to be included"},{"schema":{"type":"number"},"in":"query","name":"maxApy","required":false,"description":"Maximum APY (in decimal) of the vaults to be included"},{"schema":{"type":"integer"},"in":"query","name":"maxTvl","required":false,"description":"Maximum TVL in USD of the vaults to be included"},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"tags","required":false,"description":"Tags to be included."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"curators","required":false,"description":"Curators to be included."},{"schema":{"type":"number","minimum":0,"default":1},"in":"query","name":"minUsdAssetValueThreshold","required":false,"description":"Minimum USD value of the vault to be included"},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to be used for best vault calculation"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"requestedAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the user requesting the data"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset"},"balanceUsd":{"type":"string","description":"USD value of the asset"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Requested asset details"},"vault":{"type":"object","properties":{"name":{"type":"string","description":"Name of the vault"},"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi"},"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"description":{"type":"string","description":"Description of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"}},"required":["protocolId","name"],"additionalProperties":false,"description":"Protocol details of the vault"},"tvl":{"type":"object","properties":{"usd":{"type":"string","description":"TVL in USD"},"native":{"type":"string","description":"Native TVL"}},"required":["usd","native"],"additionalProperties":false,"description":"Total Value Locked (TVL) in the vault"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the vault"},"apy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"Annual Percentage Yield (APY) breakdown"},"projectedUsdAnnualEarnings":{"type":"string","description":"Projected annual earnings in USD"},"lendUrl":{"type":"string","description":"URL to lend the asset in the vault"},"protocolVaultUrl":{"type":"string","description":"URL to the vault in the protocol"}},"required":["name","vaultId","address","network","isTransactional","isAppFeatured","protocol","tvl","apy","projectedUsdAnnualEarnings"],"additionalProperties":false,"description":"Best vault details for the requested asset"},"errors":{"type":"object","properties":{"unsupportedNetworks":{"type":"array","items":{"type":"string"}},"unsupportedAssets":{"type":"array","items":{"type":"string"}},"unsupportedProtocols":{"type":"array","items":{"type":"string"}}},"required":["unsupportedNetworks","unsupportedAssets","unsupportedProtocols"],"additionalProperties":false}},"required":["requestedAddress"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/portfolio/positions/{userAddress}":{"get":{"operationId":"listPortfolioPositions","summary":"List portfolio positions","tags":["Portfolio"],"description":"Provides all vault positions for the user, with optional filters.","parameters":[{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedAssets","required":false,"description":"Assets to be included by symbol(ticker)."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedAssets","required":false,"description":"Assets to be excluded by symbol(ticker). The parameter is ignored if \"allowedAssets\" is specified."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedProtocols","required":false,"description":"Protocols to be included by protocol ID or name."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedProtocols","required":false,"description":"Protocols to be excluded by protocol ID or name. The parameter is ignored if \"allowedProtocols\" is specified."},{"schema":{"type":"integer","minimum":0,"default":100000},"in":"query","name":"minTvl","required":false,"description":"Minimum TVL in USD of the vaults to be included"},{"schema":{"type":"number","minimum":0},"in":"query","name":"minVaultScore","required":false,"description":"Minimum vault score required for a vault to be included"},{"schema":{"type":"boolean"},"in":"query","name":"onlyTransactional","required":false,"description":"Include only vaults that are supported in the transactional interface."},{"schema":{"type":"boolean"},"in":"query","name":"onlyAppFeatured","required":false,"description":"Include only vaults that are featured in app.vaults.fyi"},{"schema":{"type":"boolean","default":false},"in":"query","name":"allowCorrupted","required":false,"description":"Allow inclusion of corrupted vaults."},{"schema":{"type":"boolean"},"in":"query","name":"allowVaultsWithWarnings","required":false,"description":"Whether to include vaults with warnings. Defaults to true."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"},"default":["base","mainnet","arbitrum","optimism"]},"in":"query","name":"allowedNetworks","required":false,"description":"Networks to be included (name or CAIP)."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"}},"in":"query","name":"disallowedNetworks","required":false,"description":"Networks to be excluded (name or CAIP). The parameter is ignored if \"allowedNetworks\" is specified."},{"schema":{"type":"integer"},"in":"query","name":"maxTvl","required":false,"description":"Maximum TVL in USD of the vaults to be included"},{"schema":{"type":"number"},"in":"query","name":"maxApy","required":false,"description":"Maximum APY (in decimal) of the vaults to be included"},{"schema":{"type":"number"},"in":"query","name":"minApy","required":false,"description":"Minimum APY (in decimal) of the vaults to be included"},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"tags","required":false,"description":"Tags to be included."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"curators","required":false,"description":"Curators to be included."},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"sortOrder","required":false,"description":"Sort order, either asc or desc. Ascending is default."},{"schema":{"type":"string","enum":["balanceUsd","tvl","apy1Day","apy7Day","apy30Day"]},"in":"query","name":"sortBy","required":false,"description":"Field to sort by."},{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"number","minimum":0,"default":1},"in":"query","name":"minUsdAssetValueThreshold","required":false,"description":"Minimum USD value of the vault to be included"},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to be used for best vault calculation"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details of the vault"},"name":{"type":"string","description":"Name of the vault"},"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"description":{"type":"string","description":"Description of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"}},"required":["protocolId","name"],"additionalProperties":false,"description":"Protocol details of the vault"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false},"description":"Additional assets of the vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details of the vault"},"childrenVaults":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the child vault"},"address":{"type":"string","description":"Address of the child vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details of the child vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details of the child vault"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false},"description":"Additional assets of the child vault"}},"required":["vaultId","address","asset"],"additionalProperties":false},"description":"List of child vaults"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi"},"userEventsIndexed":{"type":"boolean","description":"Indicates if user events related to the vault are indexed and available in the API"},"apy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY details of the vault"},"apyComposite":{"type":"object","properties":{"totalApy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"Compounded APY combining the vault and its underlying vault"},"intrinsicApy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY of the underlying vault before compounding"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the underlying vault"},"vault":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the underlying vault"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the underlying vault"}},"required":["vaultId","address"],"additionalProperties":false}},"required":["totalApy","intrinsicApy","asset","vault"],"additionalProperties":false,"description":"Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY"}},"required":["vaultId","address","network","asset","name","protocol","isTransactional","isAppFeatured","userEventsIndexed","apy"],"additionalProperties":false}},"errors":{"type":"object","properties":{"unsupportedNetworks":{"type":"array","items":{"type":"string"}},"unsupportedAssets":{"type":"array","items":{"type":"string"}},"unsupportedProtocols":{"type":"array","items":{"type":"string"}}},"required":["unsupportedNetworks","unsupportedAssets","unsupportedProtocols"],"additionalProperties":false}},"required":["data","errors"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/portfolio/positions/{userAddress}/{network}/{vaultId}":{"get":{"operationId":"getPortfolioPosition","summary":"Get portfolio position","tags":["Portfolio"],"description":"Gives a detailed view of one specific vault position on a given network.","parameters":[{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to be used for best vault calculation"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details of the vault"},"name":{"type":"string","description":"Name of the vault"},"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"description":{"type":"string","description":"Description of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"}},"required":["protocolId","name"],"additionalProperties":false,"description":"Protocol details of the vault"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false},"description":"Additional assets of the vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details of the vault"},"childrenVaults":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the child vault"},"address":{"type":"string","description":"Address of the child vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details of the child vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details of the child vault"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false},"description":"Additional assets of the child vault"}},"required":["vaultId","address","asset"],"additionalProperties":false},"description":"List of child vaults"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi"},"userEventsIndexed":{"type":"boolean","description":"Indicates if user events related to the vault are indexed and available in the API"},"apy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY details of the vault"},"apyComposite":{"type":"object","properties":{"totalApy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"Compounded APY combining the vault and its underlying vault"},"intrinsicApy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY of the underlying vault before compounding"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the underlying vault"},"vault":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the underlying vault"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the underlying vault"}},"required":["vaultId","address"],"additionalProperties":false}},"required":["totalApy","intrinsicApy","asset","vault"],"additionalProperties":false,"description":"Composite APY data when vault asset is another vault LP token. When present, totalApy compounds the current vault with the underlying vault and intrinsicApy shows the underlying vault's own APY"}},"required":["vaultId","address","network","asset","name","protocol","isTransactional","isAppFeatured","userEventsIndexed","apy"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/portfolio/best-deposit-options/{userAddress}":{"get":{"operationId":"getBestDepositOptions","summary":"Get best deposit options","tags":["Portfolio"],"description":"Analyzes a user's existing wallet balances and recommends optimal vault deposit opportunities based on yield performance, risk parameters, and user-defined criteria.","parameters":[{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedAssets","required":false,"description":"Assets to be included by symbol(ticker)."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedAssets","required":false,"description":"Assets to be excluded by symbol(ticker). The parameter is ignored if \"allowedAssets\" is specified."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedProtocols","required":false,"description":"Protocols to be included by protocol ID or name."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedProtocols","required":false,"description":"Protocols to be excluded by protocol ID or name. The parameter is ignored if \"allowedProtocols\" is specified."},{"schema":{"type":"integer","minimum":0,"default":100000},"in":"query","name":"minTvl","required":false,"description":"Minimum TVL in USD of the vaults to be included"},{"schema":{"type":"number","minimum":0},"in":"query","name":"minVaultScore","required":false,"description":"Minimum vault score required for a vault to be included"},{"schema":{"type":"boolean"},"in":"query","name":"onlyTransactional","required":false,"description":"Include only vaults that are supported in the transactional interface."},{"schema":{"type":"boolean","default":"true"},"in":"query","name":"onlyAppFeatured","required":false,"description":"Include only vaults that are featured in app.vaults.fyi"},{"schema":{"type":"boolean","default":false},"in":"query","name":"allowCorrupted","required":false,"description":"Allow inclusion of corrupted vaults."},{"schema":{"type":"boolean","default":"false"},"in":"query","name":"allowVaultsWithWarnings","required":false,"description":"Whether to include vaults with warnings. Defaults to false."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"},"default":["base","mainnet","arbitrum","optimism"]},"in":"query","name":"allowedNetworks","required":false,"description":"Networks to be included (name or CAIP)."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"}},"in":"query","name":"disallowedNetworks","required":false,"description":"Networks to be excluded (name or CAIP). The parameter is ignored if \"allowedNetworks\" is specified."},{"schema":{"type":"string","enum":["1day","7day","30day"],"default":"7day"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},{"schema":{"type":"number","minimum":0},"in":"query","name":"minApy","required":false,"description":"Minimum APY of the vault to be included"},{"schema":{"type":"number"},"in":"query","name":"maxApy","required":false,"description":"Maximum APY (in decimal) of the vaults to be included"},{"schema":{"type":"integer"},"in":"query","name":"maxTvl","required":false,"description":"Maximum TVL in USD of the vaults to be included"},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"tags","required":false,"description":"Tags to be included."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"curators","required":false,"description":"Curators to be included."},{"schema":{"type":"number","minimum":0,"default":1},"in":"query","name":"minUsdAssetValueThreshold","required":false,"description":"Minimum USD value of the vault to be included"},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"alwaysReturnAssets","required":false,"description":"Assets to always be included in the response."},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"default":3},"in":"query","name":"maxVaultsPerAsset","required":false,"description":"Maximum number of vaults to be included per asset."},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to be used for best vault calculation"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"requestedAddress":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the user requesting the data"},"userBalances":{"type":"array","items":{"type":"object","properties":{"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset"},"balanceUsd":{"type":"string","description":"USD value of the asset"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Requested asset details"},"depositOptions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the vault"},"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi"},"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"description":{"type":"string","description":"Description of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"}},"required":["protocolId","name"],"additionalProperties":false,"description":"Protocol details of the vault"},"tvl":{"type":"object","properties":{"usd":{"type":"string","description":"TVL in USD"},"native":{"type":"string","description":"Native TVL"}},"required":["usd","native"],"additionalProperties":false,"description":"Total Value Locked (TVL) in the vault"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags associated with the vault"},"apy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"Annual Percentage Yield (APY) breakdown"},"projectedUsdAnnualEarnings":{"type":"string","description":"Projected annual earnings in USD"},"lendUrl":{"type":"string","description":"URL to lend the asset in the vault"},"protocolVaultUrl":{"type":"string","description":"URL to the vault in the protocol"}},"required":["name","vaultId","address","network","isTransactional","isAppFeatured","protocol","tvl","apy","projectedUsdAnnualEarnings"],"additionalProperties":false,"description":"Best vault details for the requested asset"}}},"required":["depositOptions"],"additionalProperties":false},"description":"Array of user balances with asset and vault details"},"errors":{"type":"object","properties":{"unsupportedNetworks":{"type":"array","items":{"type":"string"}},"unsupportedAssets":{"type":"array","items":{"type":"string"}},"unsupportedProtocols":{"type":"array","items":{"type":"string"}}},"required":["unsupportedNetworks","unsupportedAssets","unsupportedProtocols"],"additionalProperties":false}},"required":["requestedAddress","userBalances"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/portfolio/idle-assets/{userAddress}":{"get":{"operationId":"listIdleAssets","summary":"List idle assets","tags":["Portfolio"],"description":"Get balances of idle assets for a specific user address.","parameters":[{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"allowedAssets","required":false,"description":"Assets to be included by symbol(ticker)."},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"disallowedAssets","required":false,"description":"Assets to be excluded by symbol(ticker). The parameter is ignored if \"allowedAssets\" is specified."},{"schema":{"type":"number","minimum":0,"default":0.5},"in":"query","name":"minUsdAssetValueThreshold","required":false,"description":"Minimum USD value of the asset to be included"},{"schema":{"type":"string","enum":["balanceUsd"]},"in":"query","name":"sortBy","required":false,"description":"Field to sort the results by. Currently, only \"balanceUsd\" is supported."},{"schema":{"type":"string","enum":["asc","desc"],"default":"asc"},"in":"query","name":"sortDirection","required":false,"description":"Sort order, either asc or desc. Ascending is default."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"},"default":["base","mainnet","arbitrum","optimism"]},"in":"query","name":"allowedNetworks","required":false,"description":"Networks to be included (name or CAIP)."},{"schema":{"type":"array","items":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"],"description":"Include only vaults with provided network(name or CAIP)"}},"in":"query","name":"disallowedNetworks","required":false,"description":"Networks to be excluded (name or CAIP). The parameter is ignored if \"allowedNetworks\" is specified."},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to be used for best vault calculation"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset"},"balanceUsd":{"type":"string","description":"USD value of the asset"},"network":{"type":"object","properties":{"name":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Name of the network"},"chainId":{"type":"integer","description":"Chain ID of the network"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative","network"],"additionalProperties":false}},"errors":{"type":"object","properties":{"unsupportedNetworks":{"type":"array","items":{"type":"string"}},"unsupportedAssets":{"type":"array","items":{"type":"string"}}},"required":["unsupportedNetworks","unsupportedAssets"],"additionalProperties":false}},"required":["data","errors"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/portfolio/total-returns/{userAddress}/{network}/{vaultId}":{"get":{"operationId":"getTotalReturns","summary":"Get total returns","tags":["Portfolio"],"description":"Retrieves the total returns for a user's position in a specific vault, including asset details and native returns amount.","parameters":[{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to get returns for"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Network to get returns for"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id to get returns for"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"returnsNative":{"type":"string","description":"Total returns in native token amount"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","returnsNative"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/portfolio/events/{userAddress}/{network}/{vaultId}":{"get":{"operationId":"listPortfolioEvents","summary":"List position events","tags":["Portfolio"],"description":"Retrieves all transactions (deposits and withdrawals) for a user's position in a specific vault, including transaction details and metadata.","parameters":[{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to get returns for"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Network to get returns for"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id to get returns for"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Details of the asset"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"}},"required":["address","tokenCaip","name","symbol","decimals"],"additionalProperties":false,"description":"Details of the LP token"},"data":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Transaction timestamp"},"blockNumber":{"type":"string","description":"Block number of the transaction"},"eventType":{"type":"string","enum":["deposit","withdrawal"],"description":"Type of transaction event"},"assetAmountNative":{"type":"string","description":"Asset amount in native units"},"sharePrice":{"type":"number","description":"Share price of the LP token"},"lpTokenAmount":{"type":"string","description":"LP token amount"},"transactionHash":{"type":"string","description":"Transaction hash"},"logIndex":{"type":"number","description":"Log index of the transaction"}},"required":["timestamp","blockNumber","eventType","assetAmountNative","sharePrice","lpTokenAmount","transactionHash","logIndex"],"additionalProperties":false},"description":"List of transaction events sorted by timestamp"},"items":{"type":"number","description":"Total number of transaction events"}},"required":["asset","lpToken","data","items"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/transactions/context/{userAddress}/{network}/{vaultId}":{"get":{"operationId":"getTransactionContext","summary":"Get transaction context","tags":["Transactions"],"description":"Retrieves the complete transactional context for a user's interaction with a specific vault, including available deposit/redeem steps, current balances, and claimable rewards.","parameters":[{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Network name or CAIP-2 identifier"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Transaction context information for a user and vault","content":{"application/json":{"schema":{"type":"object","properties":{"currentDepositStep":{"type":"string","enum":["deposit","redeem","request-redeem","request-deposit","claim-redeem","claim-deposit","claim-rewards","start-redeem-cooldown"],"description":"Current deposit step"},"depositSteps":{"type":"array","items":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"string"}},"actionsUrl":{"type":"string"},"name":{"type":"string","enum":["deposit","redeem","request-redeem","request-deposit","claim-redeem","claim-deposit","claim-rewards","start-redeem-cooldown"]}},"required":["actions","actionsUrl","name"],"additionalProperties":false},"description":"Deposit steps"},"currentRedeemStep":{"type":"string","enum":["deposit","redeem","request-redeem","request-deposit","claim-redeem","claim-deposit","claim-rewards","start-redeem-cooldown"],"description":"Current redeem step"},"redeemSteps":{"type":"array","items":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"string"}},"actionsUrl":{"type":"string"},"name":{"type":"string","enum":["deposit","redeem","request-redeem","request-deposit","claim-redeem","claim-deposit","claim-rewards","start-redeem-cooldown"]}},"required":["actions","actionsUrl","name"],"additionalProperties":false},"description":"Redeem steps"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"},"balanceNative":{"type":"string","description":"Balance of the LP token"},"balanceUsd":{"type":"string","description":"USD value of the LP token"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"depositLimit":{"type":"string","description":"Maximum amount that can be deposited"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"depositLimit":{"type":"string","description":"Maximum amount that can be deposited"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false},"description":"Additional assets details"},"childrenPositions":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","description":"Address of the child vault"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"integer"},"balanceNative":{"type":"string","description":"Balance of the LP token"},"balanceUsd":{"type":"string","description":"USD value of the LP token"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details of the child vault"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"depositLimit":{"type":"string","description":"Maximum amount that can be deposited"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details of the child vault"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available."},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision"},"depositLimit":{"type":"string","description":"Maximum amount that can be deposited"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false},"description":"Additional assets details of the child vault"}},"required":["address","lpToken","asset","additionalAssets"],"additionalProperties":false}},"vaultSpecificData":{"anyOf":[{"type":"object","properties":{"cooldownData":{"type":"object","properties":{"amount":{"type":"string"},"endOfCooldown":{"type":"string"},"withdrawalWindow":{"type":"string"},"status":{"type":"string","enum":["active","ready","expired"]}},"required":["amount","endOfCooldown","withdrawalWindow","status"],"additionalProperties":false}},"additionalProperties":false},{"type":"object","properties":{"claimData":{"type":"object","properties":{"status":{"type":"string","enum":["none","pending","ready"]},"cooldownEnd":{"type":"string"},"assetAmount":{"type":"string"}},"required":["status","cooldownEnd","assetAmount"],"additionalProperties":false}},"additionalProperties":false},{"type":"object","properties":{"claimData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ready","pending"]},"lpTokenAmount":{"type":"string"},"assetAmount":{"type":"string"}},"required":["id","status","lpTokenAmount","assetAmount"],"additionalProperties":false}}},"required":["claimData"],"additionalProperties":false},{"type":"object","properties":{"claimData":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ready","pending"]},"timestamp":{"type":"string"},"lpTokenAmount":{"type":"string"},"assetAmount":{"type":"string"}},"required":["id","status","timestamp","lpTokenAmount","assetAmount"],"additionalProperties":false}}},"required":["claimData"],"additionalProperties":false},{"type":"object","properties":{"claimData":{"type":"array","items":{"type":"object","properties":{"lpTokenAmount":{"type":"string"},"assetAmount":{"type":"string"},"status":{"type":"string","enum":["ready","pending"]},"id":{"type":"string"}},"required":["lpTokenAmount","assetAmount","status","id"],"additionalProperties":false}}},"required":["claimData"],"additionalProperties":false},{"type":"object","properties":{"requestData":{"type":"object","properties":{"claimableDeposit":{"type":"string"},"claimableRedeem":{"type":"string"},"pendingDeposit":{"type":"string"},"pendingRedeem":{"type":"string"},"redeemRequests":{"type":"array","items":{"type":"object","properties":{"timestamp":{"type":"number"},"lpTokenAmount":{"type":"string"},"isClaimable":{"type":"boolean"}},"required":["timestamp","lpTokenAmount","isClaimable"],"additionalProperties":false}}},"required":["claimableDeposit","claimableRedeem","pendingDeposit","pendingRedeem","redeemRequests"],"additionalProperties":false}},"required":["requestData"],"additionalProperties":false},{"type":"object","properties":{"requestData":{"type":"object","properties":{"claimableDeposit":{"type":"string"},"claimableRedeem":{"type":"string"},"pendingDeposit":{"type":"string"},"pendingRedeem":{"type":"string"}},"required":["claimableDeposit","claimableRedeem","pendingDeposit","pendingRedeem"],"additionalProperties":false},"pendingRequests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["deposit","redeem"]},"status":{"type":"string","enum":["pending","ready"]},"assetAmount":{"type":"string"},"lpTokenAmount":{"type":"string"},"timestamp":{"type":"number"},"deadline":{"type":"number"}},"required":["type","status"],"additionalProperties":false}}},"required":["requestData","pendingRequests"],"additionalProperties":false},{"type":"object","properties":{"redeemState":{"type":"object","properties":{"deadline":{"type":"string"},"rate":{"type":"string"},"lpTokenAmount":{"type":"string"},"assetAmount":{"type":"string"}},"required":["deadline","rate","lpTokenAmount","assetAmount"],"additionalProperties":false}},"additionalProperties":false},{"type":"object","properties":{"claimData":{"type":"object","properties":{"lpTokenAmount":{"type":"string"},"assetAmount":{"type":"string"}},"required":["lpTokenAmount","assetAmount"],"additionalProperties":false},"eligible":{"type":"boolean"}},"required":["eligible"],"additionalProperties":false},{"type":"object","properties":{"pendingRequests":{"type":"object","properties":{"deposits":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string"},"deadline":{"type":"string"}},"required":["amount","deadline"],"additionalProperties":false}},"redeems":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string"},"deadline":{"type":"string"}},"required":["amount","deadline"],"additionalProperties":false}}},"required":["deposits","redeems"],"additionalProperties":false}},"additionalProperties":false},{"type":"object","properties":{"pendingRequests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["deposit","redeem"]},"status":{"type":"string","enum":["pending","ready"]},"assetAmount":{"type":"string"},"lpTokenAmount":{"type":"string"},"timestamp":{"type":"number"},"deadline":{"type":"number"}},"required":["type","status"],"additionalProperties":false}}},"required":["pendingRequests"],"additionalProperties":false},{"type":"object","properties":{"redeemFeeBips":{"type":"string"}},"required":["redeemFeeBips"],"additionalProperties":false},{"type":"object","properties":{"pendingRedeemRequest":{"type":"object","properties":{"assets":{"type":"string"},"shares":{"type":"string"}},"required":["assets","shares"],"additionalProperties":false},"liquidAssets":{"type":"string"}},"required":["liquidAssets"],"additionalProperties":false},{"type":"object","properties":{"requests":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","executed","cancelled","unknown"]},"type":{"type":"string","enum":["subscription","redemption","unknown"]},"assetsAmount":{"type":"string"},"sharesAmount":{"type":"string"},"timestamp":{"type":"number"},"asset":{"type":"string"}},"required":["status","type","assetsAmount","sharesAmount","timestamp","asset"],"additionalProperties":false}},"redemptionFeeBips":{"type":"string"}},"required":["requests","redemptionFeeBips"],"additionalProperties":false},{"type":"object","properties":{"pendingRequests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["deposit","redeem"]},"status":{"type":"string","enum":["pending","ready"]},"assetAmount":{"type":"string"},"lpTokenAmount":{"type":"string"},"timestamp":{"type":"number"},"deadline":{"type":"number"}},"required":["type","status"],"additionalProperties":false}},"minDeposit":{"type":"string"},"minRedeem":{"type":"string"}},"required":["pendingRequests","minDeposit","minRedeem"],"additionalProperties":false},{"type":"object","properties":{"pendingWithdrawals":{"type":"array","items":{"type":"object","properties":{"assetAmount":{"type":"string"},"claimTimestamp":{"type":"string"}},"required":["assetAmount","claimTimestamp"],"additionalProperties":false}}},"additionalProperties":false},{"type":"object","properties":{"eligible":{"type":"boolean"},"kycUrl":{"type":"string"}},"required":["eligible","kycUrl"],"additionalProperties":false},{"type":"object","properties":{},"additionalProperties":false}]},"pendingRequests":{"type":"object","properties":{"deposits":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","ready"]},"assetAmount":{"type":"string"},"lpTokenAmount":{"type":"string"},"requestTimestamp":{"type":"number"},"estimatedResolution":{"type":"number"},"withdrawalStart":{"type":"number"},"withdrawalEnd":{"type":"number"}},"required":["status"],"additionalProperties":false}},"redeems":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","ready"]},"assetAmount":{"type":"string"},"lpTokenAmount":{"type":"string"},"requestTimestamp":{"type":"number"},"estimatedResolution":{"type":"number"},"withdrawalStart":{"type":"number"},"withdrawalEnd":{"type":"number"}},"required":["status"],"additionalProperties":false}}},"required":["deposits","redeems"],"additionalProperties":false,"description":"Pending requests"},"rewards":{"type":"object","properties":{"claimable":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string","description":"Amount of the claimable reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"network":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"description":"Network of the reward"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","network"],"additionalProperties":false}},"required":["amount","asset"],"additionalProperties":false}},"currentStep":{"type":"string","enum":["deposit","redeem","request-redeem","request-deposit","claim-redeem","claim-deposit","claim-rewards","start-redeem-cooldown"],"description":"Current step for claiming rewards"},"steps":{"type":"array","items":{"type":"object","properties":{"actions":{"type":"array","items":{"type":"string"}},"actionsUrl":{"type":"string"},"name":{"type":"string","enum":["deposit","redeem","request-redeem","request-deposit","claim-redeem","claim-deposit","claim-rewards","start-redeem-cooldown"]}},"required":["actions","actionsUrl","name"],"additionalProperties":false},"description":"Steps for claiming rewards"}},"required":["claimable","currentStep","steps"],"additionalProperties":false}},"required":["currentDepositStep","depositSteps","currentRedeemStep","redeemSteps","lpToken","asset","additionalAssets","childrenPositions"],"additionalProperties":false,"description":"Transaction context information for a user and vault"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/transactions/suffix/{userAddress}/{vaultId}":{"get":{"operationId":"getTransactionSuffix","summary":"Get transaction suffix","tags":["Transactions"],"description":"Generates the transaction suffix for the current API key, user address, and vault. Append the returned raw hex suffix to calldata without a 0x prefix.","parameters":[{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"suffix":{"type":"string","pattern":"^[0-9a-fA-F]+$","description":"Raw hex suffix to append to transaction calldata, without the 0x prefix"}},"required":["suffix"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/transactions/{action}/{userAddress}/{network}/{vaultId}":{"get":{"operationId":"getTransaction","summary":"Get transaction payload","tags":["Transactions"],"description":"Retrieves executable transaction payloads for specific actions (deposit, redeem, claim) for a user interacting with a vault, including ready-to-sign transaction data and optional simulation results.","parameters":[{"schema":{"type":"boolean","default":"false"},"in":"query","name":"simulate","required":false,"description":"DEPRECATED: This parameter is deprecated and no longer functional"},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"query","name":"assetAddress","required":true,"description":"Address of the asset to be used in the transaction"},{"schema":{"type":"string"},"in":"query","name":"amount","required":false,"description":"Only applicable to deposit, redeem, request-redeem, Amount of the asset to be used in the transaction"},{"schema":{"type":"boolean"},"in":"query","name":"all","required":false,"description":"Only applicable for redeem action. If true, all assets will be redeemed"},{"schema":{"type":"string","enum":["deposit","redeem","request-redeem","request-deposit","claim-redeem","claim-deposit","claim-rewards","start-redeem-cooldown"]},"in":"path","name":"action","required":true,"description":"Action to be performed"},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to get returns for"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Network to get returns for"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id to get returns for"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/transactions/rewards/context/{userAddress}":{"get":{"operationId":"getRewardsContext","summary":"Get rewards context","tags":["Transactions"],"description":"Retrieves claimable rewards context for a user across all networks and vaults, including reward details and claim URLs.","parameters":[{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Rewards context information for claiming available rewards","content":{"application/json":{"schema":{"type":"object","properties":{"claimable":{"type":"object","required":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"properties":{"mainnet":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"optimism":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"arbitrum":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"polygon":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"gnosis":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"base":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"unichain":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"swellchain":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"celo":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"worldchain":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"berachain":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"ink":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"bsc":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"hyperliquid":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"plasma":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"avalanche":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"katana":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"linea":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"mega-eth":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"monad":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"etherlink":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}},"robinhood":{"type":"array","items":{"type":"object","properties":{"claimId":{"type":"string","description":"Unique identifier for the reward"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset"},"name":{"type":"string","description":"Name of the asset"},"symbol":{"type":"string","description":"Symbol of the asset"},"decimals":{"type":"integer","description":"Number of decimals of the asset"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER"},"claimableAmount":{"type":"string","description":"Amount of the asset that can be claimed"},"claimableAmountInUsd":{"type":"string","description":"Amount of the asset that can be claimed in USD"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","claimableAmount"],"additionalProperties":false,"description":"Reward asset details"},"sources":{"type":"array","items":{"type":"object","properties":{"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version"},"name":{"type":"string","description":"Name of the protocol"},"displayName":{"type":"string","description":"Display name of the protocol"},"product":{"type":"string","description":"Product of the protocol"},"version":{"type":"string","description":"Version of the protocol"},"protocolUrl":{"type":"string","description":"URL of the protocol"},"protocolLogo":{"type":"string","description":"URL of the protocol logo"},"description":{"type":"string","description":"Description of the protocol"}},"required":["protocolId","name"],"additionalProperties":false}},"required":["protocol"],"additionalProperties":false},"description":"Sources of the reward"},"actionUrl":{"type":"string","description":"URL to claim this specific reward"}},"required":["claimId","asset","sources","actionUrl"],"additionalProperties":false}}},"additionalProperties":false,"description":"Claimable rewards organized by network"},"actionUrl":{"type":"string","description":"URL for claiming all rewards"}},"required":["claimable","actionUrl"],"additionalProperties":false,"description":"Rewards context information for claiming available rewards"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/transactions/rewards/claim/{userAddress}":{"get":{"operationId":"claimRewards","summary":"Claim rewards","tags":["Transactions"],"description":"Generates a claim rewards transaction for a user, returning transaction payloads needed to claim rewards from protocols.","parameters":[{"schema":{"type":"boolean","default":"false"},"in":"query","name":"simulate","required":false,"description":"DEPRECATED: This parameter is deprecated and no longer functional"},{"schema":{"type":"array","items":{"type":"string","minLength":1}},"in":"query","name":"claimIds","required":true,"description":"Array of claim IDs to be claimed"},{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$"},"in":"path","name":"userAddress","required":true,"description":"User address to claim rewards for"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood"],"properties":{"mainnet":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"optimism":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"arbitrum":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"polygon":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"gnosis":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"base":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"unichain":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"swellchain":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"celo":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"worldchain":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"berachain":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"ink":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"bsc":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"hyperliquid":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"plasma":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"avalanche":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"katana":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"linea":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"mega-eth":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"monad":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"etherlink":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false},"robinhood":{"type":"object","properties":{"currentActionIndex":{"type":"number"},"actions":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action"},"tx":{"type":"object","properties":{"to":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the transaction recipient"},"chainId":{"type":"integer","exclusiveMinimum":true,"minimum":0,"description":"Chain ID of the transaction"},"data":{"type":"string","description":"Data to be sent with the transaction"},"value":{"type":"string","description":"Value to be sent with the transaction"}},"required":["to","chainId"],"additionalProperties":false},"simulation":{"type":"object","properties":{"url":{"type":"string","description":"URL to simulated transaction"},"status":{"type":"string","enum":["success","failure","internal server error"],"description":"Status of the simulation"},"tokensReceived":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens received from the transaction"},"tokensSpent":{"type":"object","additionalProperties":{"type":"string"},"description":"Tokens spent in the transaction"}},"required":["url","status"],"additionalProperties":false}},"required":["name","tx"],"additionalProperties":false}}},"required":["currentActionIndex","actions"],"additionalProperties":false}},"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/benchmarks/{network}":{"get":{"operationId":"getBenchmark","summary":"Get benchmark rate","tags":["Benchmarks"],"description":"Retrieves benchmark APY data for the specified network and benchmark code.","parameters":[{"schema":{"type":"string","enum":["usd","eth"]},"in":"query","name":"code","required":true,"description":"Benchmark code identifier. Available codes: usd, eth"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Network name or CAIP-2 identifier"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"apy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"}},"required":["1day","7day","30day"],"additionalProperties":false,"nullable":true,"description":"APY interval breakdown for the benchmark"},"timestamp":{"type":"integer","description":"Timestamp of the benchmark data point"}},"required":["apy","timestamp"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/historical-benchmarks/{network}":{"get":{"operationId":"getHistoricalBenchmarks","summary":"Get historical benchmarks","tags":["Benchmarks"],"description":"Retrieves historical benchmark APY data for the specified network and benchmark code with pagination.","parameters":[{"schema":{"type":"integer","minimum":0,"default":0},"in":"query","name":"page","required":false,"description":"Page number (starting from 0)"},{"schema":{"type":"integer","exclusiveMinimum":true,"minimum":0,"maximum":20000,"default":50},"in":"query","name":"perPage","required":false,"description":"Number of items per page"},{"schema":{"type":"string","enum":["usd","eth"]},"in":"query","name":"code","required":true,"description":"Benchmark code identifier. Available codes: usd, eth"},{"schema":{"type":"integer","default":0},"in":"query","name":"fromTimestamp","required":false,"description":"Timestamp for the start of the time period for which data will be fetched"},{"schema":{"type":"integer"},"in":"query","name":"toTimestamp","required":false,"description":"Timestamp for the end of the time period for which data will be fetched"},{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Network name or CAIP-2 identifier"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"itemsOnPage":{"type":"integer","description":"Number of items on the current page"},"nextPage":{"type":"integer","description":"Next page number"},"data":{"type":"array","items":{"type":"object","properties":{"apy":{"type":"object","properties":{"1day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"1day APY details"},"7day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"7day APY details"},"30day":{"type":"object","properties":{"base":{"type":"number","description":"Base APY"},"reward":{"type":"number","description":"Reward APY"},"total":{"type":"number","description":"Total APY"}},"required":["base","reward","total"],"additionalProperties":false,"description":"30day APY details"}},"required":["1day","7day","30day"],"additionalProperties":false,"nullable":true,"description":"APY interval breakdown for the benchmark"},"timestamp":{"type":"integer","description":"Timestamp of the benchmark data point"}},"required":["apy","timestamp"],"additionalProperties":false,"description":"Array of items on the current page"}}},"required":["itemsOnPage","data"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/nrt/vault/{network}/{vaultId}":{"get":{"operationId":"getVaultNrt","summary":"Get vault NRT data","tags":["NRT"],"description":"Retrieves nrt data for vault (underlyingAssetPrice, sharePrice, totalAssets, totalSupply)","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"NRT response schema","content":{"application/json":{"schema":{"type":"object","properties":{"totalSupply":{"type":"string","description":"Total supply of the vault denominated in asset wei"},"totalAssets":{"type":"string","description":"Total assets of the vault denominated in asset wei"},"sharePrice":{"type":"number","description":"Share price of the vault"},"underlyingAssetPrice":{"type":"number","description":"Underlying asset price of the vault in USD"}},"required":["totalSupply","totalAssets","sharePrice","underlyingAssetPrice"],"additionalProperties":false,"description":"NRT response schema"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/nrt/vault/{network}/{vaultId}/sharePrice":{"get":{"operationId":"getVaultNrtSharePrice","summary":"Get vault NRT share price","tags":["NRT"],"description":"Retrieves NRT share price for vault","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"NRT share price response schema","content":{"application/json":{"schema":{"type":"object","properties":{"sharePrice":{"type":"number","description":"Share price of the vault"}},"required":["sharePrice"],"additionalProperties":false,"description":"NRT share price response schema"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/nrt/vault/{network}/{vaultId}/totalSupply":{"get":{"operationId":"getVaultNrtTotalSupply","summary":"Get vault NRT total supply","tags":["NRT"],"description":"Retrieves total supply for vault","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"NRT total supply response schema","content":{"application/json":{"schema":{"type":"object","properties":{"totalSupply":{"type":"string","description":"Total supply of the vault denominated in asset wei"}},"required":["totalSupply"],"additionalProperties":false,"description":"NRT total supply response schema"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/nrt/vault/{network}/{vaultId}/totalAssets":{"get":{"operationId":"getVaultNrtTotalAssets","summary":"Get vault NRT total assets","tags":["NRT"],"description":"Retrieves total assets for vault","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"NRT total assets response schema","content":{"application/json":{"schema":{"type":"object","properties":{"totalAssets":{"type":"string","description":"Total assets of the vault denominated in asset wei"}},"required":["totalAssets"],"additionalProperties":false,"description":"NRT total assets response schema"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}},"/v2/nrt/vault/{network}/{vaultId}/underlyingAssetPrice":{"get":{"operationId":"getVaultNrtUnderlyingAssetPrice","summary":"Get vault NRT underlying asset price","tags":["NRT"],"description":"Retrieves underlying asset price for vault","parameters":[{"schema":{"type":"string","enum":["mainnet","optimism","arbitrum","polygon","gnosis","base","unichain","swellchain","celo","worldchain","berachain","ink","bsc","hyperliquid","plasma","avalanche","katana","linea","mega-eth","monad","etherlink","robinhood","eip155:1","eip155:10","eip155:42161","eip155:137","eip155:100","eip155:8453","eip155:130","eip155:1923","eip155:42220","eip155:480","eip155:80094","eip155:57073","eip155:56","eip155:999","eip155:9745","eip155:43114","eip155:747474","eip155:59144","eip155:4326","eip155:143","eip155:42793","eip155:4663"]},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},{"schema":{"type":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"NRT underlying price response schema","content":{"application/json":{"schema":{"type":"object","properties":{"underlyingAssetPrice":{"type":"number","description":"Underlying asset price of the vault in USD"}},"required":["underlyingAssetPrice"],"additionalProperties":false,"description":"NRT underlying price response schema"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Bad Request"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Unauthorized"]},"message":{"type":"string","enum":["An API key is required to access this service. Sign up at https://portal.vaults.fyi/signup to generate a key. We offer a Pay-As-You-Go plan so you only pay for what you use, with no commitments."]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"x402Version":{"anyOf":[{"type":"number"},{"type":"string"}]},"error":{"type":"string"},"resource":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"mimeType":{"type":"string"},"serviceName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"iconUrl":{"type":"string"}},"required":["url"],"additionalProperties":false},"accepts":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"]},"network":{"type":"string"},"amount":{"type":"string"},"payTo":{"type":"string"},"maxTimeoutSeconds":{"type":"number"},"asset":{"type":"string"},"extra":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"}},"required":["name","version"],"additionalProperties":false}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false}},{}]},"extensions":{"type":"object","additionalProperties":{}}},"required":["x402Version","resource"],"additionalProperties":false},{}]}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Forbidden"]},"message":{"type":"string","enum":["This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits"]},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"]},"message":{"type":"string"}},"required":["error","message"],"additionalProperties":false}}}},"408":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"message":{"type":"string"},"errorId":{"type":"string"}},"additionalProperties":false},{}]}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Unprocessable Entity"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"error":{"type":"string","enum":["Internal Server Error"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["error","message"],"additionalProperties":false},{}]}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string","enum":["Service Unavailable"]},"message":{"type":"string"},"errorId":{"type":"string"}},"required":["statusCode","error","message"],"additionalProperties":false},{}]}}}}}}}},"servers":[{"url":"https://api.vaults.fyi","description":"Vaults.fyi API"}],"tags":[{"name":"General","description":"Core informational endpoints providing essential reference data such as networks, assets, and vaults listings for orientation and exploration."},{"name":"Detailed Vaults","description":"Comprehensive vault data endpoints delivering in-depth analytics including APY metrics, TVL statistics, rewards breakdowns, and risk scores."},{"name":"Benchmarks","description":"Vaults.fyi curated benchmark endpoints providing aggregated yield performance data for USD and ETH denominated assets across selected networks."},{"name":"Historical","description":"Endpoints returning time-series historical data for vault metrics, enabling trend analysis and performance tracking over customizable periods."},{"name":"Portfolio","description":"Advanced endpoints providing detailed information about user balances, active positions, historical interactions, and tailored investment opportunities."},{"name":"Transactions","description":"Endpoints for executing vault deposits, withdrawals, and reward claims with ready-to-sign transaction payloads."},{"name":"NRT","description":"NRT (Near-Real-Time) endpoints return live vault data updated continuously throughout the day, including current share price, total supply, TVL, and APY."},{"name":"Health"}]}