{
"error": "Unauthorized",
"message": "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": "<string>"
}
{
"error": "Forbidden",
"message": "This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits",
"errorId": "<string>"
}
{
"error": "Unauthorized",
"message": "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": "<string>"
}
{
"error": "Forbidden",
"message": "This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits",
"errorId": "<string>"
}
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
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vaults.fyi","colors":{"primary":"#18abff","light":"#96caff","dark":"#187ee8"},"logo":{"light":"https://mintcdn.com/vaultsfyi/e2nu_rHbR1M8lgfT/images/Logo-384px-black.png?fit=max\u0026auto=format\u0026n=e2nu_rHbR1M8lgfT\u0026q=85\u0026s=ad6b6e6796d582b64af53e9100b8b169","dark":"https://mintcdn.com/vaultsfyi/e2nu_rHbR1M8lgfT/images/Logo-384px-white.png?fit=max\u0026auto=format\u0026n=e2nu_rHbR1M8lgfT\u0026q=85\u0026s=83209def8b210124b3bf53b5ccc42449","href":"https://vaults.fyi/"},"favicon":"https://mintcdn.com/vaultsfyi/LV19mJjFpALwuFJ6/images/icon_blue.png?fit=max\u0026auto=format\u0026n=LV19mJjFpALwuFJ6\u0026q=85\u0026s=86baed3673733df8b24c661f1aca87f3","appearance":{"default":"system"},"background":{"color":{"light":"#FFFFFF"}},"navbar":{"primary":{"type":"button","label":"Get API Access","href":"https://portal.vaults.fyi/signup"}},"footer":{"socials":{"x":"https://x.com/vaultsfyi"}},"fonts":{"family":"Geist"},"integrations":{"ga4":{"measurementId":"G-6YJ3LN6CD5"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vaultsfyi","hasAudioNarration":false,"actualSubdomain":"vaultsfyi","customDomains":["docs.vaults.fyi"],"gitSource":{"type":"github","owner":"wallfacerlabs","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ade50e053c1438f0e67710a","collectionId":"02e9e4dc-aa56-4076-af8c-2947302e247b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ade50e053c1438f0e67710a"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ade50e053c1438f0e67710a","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":89},{"language":"default","tag":"Endpoints","count":43},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Beta","count":33},{"language":"default","tag":"Alpha","count":12},{"language":"default","tag":"Resources","count":11},{"language":"default","tag":"Borrow Markets","count":11},{"language":"default","tag":"SVM","count":10},{"language":"default","tag":"Sections","count":8},{"language":"default","tag":"Case Studies","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/portfolio/get-portfolio-position","slug":"/api-reference/portfolio/get-portfolio-position","pageMetadata":{"title":"Get portfolio position","description":"Gives a detailed view of one specific vault position on a given network.","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/positions/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/get-portfolio-position","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Gives a detailed view of one specific vault position on a given network.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get portfolio position","description":"Gives a detailed view of one specific vault position on a given network.","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/positions/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/get-portfolio-position","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getPortfolioPosition","summary":"Get portfolio position","tags":["Portfolio"],"description":"Gives a detailed view of one specific vault position on a given network.","parameters":["95ec4e2c-e3f4-4dcc-ad77-6b3e0829dd34","64700554-03fe-4a2a-9d73-71c131b16aba","4519dbe6-97b1-457a-9310-c981839c74d0","120e8b18-bc0f-423e-89ba-d328dcdddc3d"],"security":["f2ba0041-fee6-4b84-ba71-d33f6879f88d"],"responses":{"200":"078269c9-fef0-47c4-bc1d-e37e576602e0","400":"bb1dd400-9351-4209-8167-37ad434d5861","401":"be902c47-3ac4-4db1-8256-17f206ed49ff","402":"75c2d8fb-401f-46e0-8cdb-7b2fe33f9fe0","403":"4c42869c-d11a-41f6-9f2c-92b4b6faf3f0","404":"5a4d5ddc-0ff0-40fd-a229-8c8c6874e5f6","408":"d148cb51-afcf-4625-bfe8-e93659cbe992","422":"cf2c7c99-b4a1-4f2b-9909-a035255f63ea","500":"49beb33d-c31c-4689-82a5-1a0526f606da","503":"6f40b8eb-ffcd-4bf3-9ae1-3d81b0b23076"},"method":"get","type":"path","servers":["20bee595-32b6-49b5-859f-8f62b9ee0c52"],"path":"/v2/portfolio/positions/{userAddress}/{network}/{vaultId}","baseUrlOptions":["https://api.vaults.fyi"],"title":"Get portfolio position","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"95ec4e2c-e3f4-4dcc-ad77-6b3e0829dd34":{"schema":{"type":"string","enum":["1day","7day","30day","90day"],"default":"7day","isRequired":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"query","name":"apyInterval","required":false,"description":"Interval for APY data. Possible values: 1day, 7day, 30day"},"64700554-03fe-4a2a-9d73-71c131b16aba":{"schema":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"description":"User address to be used for best vault calculation","uniqueKey":"","typeLabel":"string"},"in":"path","name":"userAddress","required":true,"description":"User address to be used for best vault calculation"},"4519dbe6-97b1-457a-9310-c981839c74d0":{"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"],"isRequired":true,"description":"Include only vaults with provided network(name or CAIP)","uniqueKey":"","typeLabel":"enum\u003cstring>"},"in":"path","name":"network","required":true,"description":"Include only vaults with provided network(name or CAIP)"},"120e8b18-bc0f-423e-89ba-d328dcdddc3d":{"schema":{"type":"string","isRequired":true,"description":"Vault id of the vault for which the data will be returned","uniqueKey":"","typeLabel":"string"},"in":"path","name":"vaultId","required":true,"description":"Vault id of the vault for which the data will be returned"}},"responses":{"078269c9-fef0-47c4-bc1d-e37e576602e0":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"vaultId":{"type":"string","description":"Stable vault identity for API lookups and links","isRequired":true,"uniqueKey":"vaultId","typeLabel":"string"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the vault","isRequired":true,"uniqueKey":"address","typeLabel":"string"},"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","isRequired":true,"uniqueKey":"network.name","typeLabel":"enum\u003cstring>"},"chainId":{"type":"integer","description":"Chain ID of the network","isRequired":true,"uniqueKey":"network.chainId","typeLabel":"integer"},"networkCaip":{"type":"string","pattern":"^eip155:\\d+$","description":"CAIP-2 of the network","isRequired":true,"uniqueKey":"network.networkCaip","typeLabel":"string"}},"required":["name","chainId","networkCaip"],"additionalProperties":false,"description":"Network details of the vault","isRequired":true,"uniqueKey":"network","typeLabel":"object"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset","isRequired":true,"uniqueKey":"asset.address","typeLabel":"string"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset","isRequired":true,"uniqueKey":"asset.assetCaip","typeLabel":"string"},"name":{"type":"string","description":"Name of the asset","isRequired":true,"uniqueKey":"asset.name","typeLabel":"string"},"symbol":{"type":"string","description":"Symbol of the asset","isRequired":true,"uniqueKey":"asset.symbol","typeLabel":"string"},"decimals":{"type":"integer","description":"Number of decimals of the asset","isRequired":true,"uniqueKey":"asset.decimals","typeLabel":"integer"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER","isRequired":true,"uniqueKey":"asset.assetGroup","typeLabel":"string"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision","isRequired":true,"uniqueKey":"asset.balanceNative","typeLabel":"string"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo","uniqueKey":"asset.assetLogo","typeLabel":"string\u003curi>"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD","uniqueKey":"asset.assetPriceInUsd","typeLabel":"string"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available.","uniqueKey":"asset.balanceUsd","typeLabel":"string"},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision","uniqueKey":"asset.unclaimedNative","typeLabel":"string"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd","uniqueKey":"asset.unclaimedUsd","typeLabel":"string"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision","uniqueKey":"asset.positionValueInAsset","typeLabel":"string"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details of the vault","isRequired":true,"uniqueKey":"asset","typeLabel":"object"},"name":{"type":"string","description":"Name of the vault","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"protocol":{"type":"object","properties":{"protocolId":{"type":"string","description":"Lowercase protocol ID constructed from its name, product, and version","isRequired":true,"uniqueKey":"protocol.protocolId","typeLabel":"string"},"name":{"type":"string","description":"Name of the protocol","isRequired":true,"uniqueKey":"protocol.name","typeLabel":"string"},"displayName":{"type":"string","description":"Display name of the protocol","uniqueKey":"protocol.displayName","typeLabel":"string"},"product":{"type":"string","description":"Product of the protocol","uniqueKey":"protocol.product","typeLabel":"string"},"version":{"type":"string","description":"Version of the protocol","uniqueKey":"protocol.version","typeLabel":"string"},"protocolUrl":{"type":"string","description":"URL of the protocol","uniqueKey":"protocol.protocolUrl","typeLabel":"string"},"description":{"type":"string","description":"Description of the protocol","uniqueKey":"protocol.description","typeLabel":"string"},"protocolLogo":{"type":"string","description":"URL of the protocol logo","uniqueKey":"protocol.protocolLogo","typeLabel":"string"}},"required":["protocolId","name"],"additionalProperties":false,"description":"Protocol details of the vault","isRequired":true,"uniqueKey":"protocol","typeLabel":"object"},"isTransactional":{"type":"boolean","description":"Indicates if the vault supports transactional endpoints","isRequired":true,"uniqueKey":"isTransactional","typeLabel":"boolean"},"isAppFeatured":{"type":"boolean","description":"Indicates if the vault is featured in app.vaults.fyi","isRequired":true,"uniqueKey":"isAppFeatured","typeLabel":"boolean"},"userEventsIndexed":{"type":"boolean","description":"Indicates if user events related to the vault are indexed and available in the API","isRequired":true,"uniqueKey":"userEventsIndexed","typeLabel":"boolean"},"apy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY","isRequired":true,"uniqueKey":"apy.base","typeLabel":"number"},"reward":{"type":"number","description":"Reward APY","isRequired":true,"uniqueKey":"apy.reward","typeLabel":"number"},"total":{"type":"number","description":"Total APY","isRequired":true,"uniqueKey":"apy.total","typeLabel":"number"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY details of the vault","isRequired":true,"uniqueKey":"apy","typeLabel":"object"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset","isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].address","typeLabel":"string"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset","isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].assetCaip","typeLabel":"string"},"name":{"type":"string","description":"Name of the asset","isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].name","typeLabel":"string"},"symbol":{"type":"string","description":"Symbol of the asset","isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].symbol","typeLabel":"string"},"decimals":{"type":"integer","description":"Number of decimals of the asset","isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].decimals","typeLabel":"integer"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER","isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].assetGroup","typeLabel":"string"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision","isRequired":true,"uniqueKey":"additionalAssets.items.[INDEX].balanceNative","typeLabel":"string"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo","uniqueKey":"additionalAssets.items.[INDEX].assetLogo","typeLabel":"string\u003curi>"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD","uniqueKey":"additionalAssets.items.[INDEX].assetPriceInUsd","typeLabel":"string"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available.","uniqueKey":"additionalAssets.items.[INDEX].balanceUsd","typeLabel":"string"},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision","uniqueKey":"additionalAssets.items.[INDEX].unclaimedNative","typeLabel":"string"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd","uniqueKey":"additionalAssets.items.[INDEX].unclaimedUsd","typeLabel":"string"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision","uniqueKey":"additionalAssets.items.[INDEX].positionValueInAsset","typeLabel":"string"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"uniqueKey":"additionalAssets.items.[INDEX]","typeLabel":"object"},"description":"Additional assets of the vault","uniqueKey":"additionalAssets","typeLabel":"object[]"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"lpToken.address","typeLabel":"string"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","isRequired":true,"uniqueKey":"lpToken.tokenCaip","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"lpToken.name","typeLabel":"string"},"symbol":{"type":"string","isRequired":true,"uniqueKey":"lpToken.symbol","typeLabel":"string"},"decimals":{"type":"integer","isRequired":true,"uniqueKey":"lpToken.decimals","typeLabel":"integer"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision","isRequired":true,"uniqueKey":"lpToken.balanceNative","typeLabel":"string"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available.","uniqueKey":"lpToken.balanceUsd","typeLabel":"string"},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision","uniqueKey":"lpToken.unclaimedNative","typeLabel":"string"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd","uniqueKey":"lpToken.unclaimedUsd","typeLabel":"string"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision","uniqueKey":"lpToken.positionValueInAsset","typeLabel":"string"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD","uniqueKey":"lpToken.assetPriceInUsd","typeLabel":"string"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details of the vault","uniqueKey":"lpToken","typeLabel":"object"},"childrenVaults":{"type":"array","items":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the child vault","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].vaultId","typeLabel":"string"},"address":{"type":"string","description":"Address of the child vault","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].address","typeLabel":"string"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset.address","typeLabel":"string"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset.assetCaip","typeLabel":"string"},"name":{"type":"string","description":"Name of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset.name","typeLabel":"string"},"symbol":{"type":"string","description":"Symbol of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset.symbol","typeLabel":"string"},"decimals":{"type":"integer","description":"Number of decimals of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset.decimals","typeLabel":"integer"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset.assetGroup","typeLabel":"string"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset.balanceNative","typeLabel":"string"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo","uniqueKey":"childrenVaults.items.[INDEX].asset.assetLogo","typeLabel":"string\u003curi>"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD","uniqueKey":"childrenVaults.items.[INDEX].asset.assetPriceInUsd","typeLabel":"string"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available.","uniqueKey":"childrenVaults.items.[INDEX].asset.balanceUsd","typeLabel":"string"},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision","uniqueKey":"childrenVaults.items.[INDEX].asset.unclaimedNative","typeLabel":"string"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd","uniqueKey":"childrenVaults.items.[INDEX].asset.unclaimedUsd","typeLabel":"string"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision","uniqueKey":"childrenVaults.items.[INDEX].asset.positionValueInAsset","typeLabel":"string"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"description":"Asset details of the child vault","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].asset","typeLabel":"object"},"lpToken":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].lpToken.address","typeLabel":"string"},"tokenCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].lpToken.tokenCaip","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].lpToken.name","typeLabel":"string"},"symbol":{"type":"string","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].lpToken.symbol","typeLabel":"string"},"decimals":{"type":"integer","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].lpToken.decimals","typeLabel":"integer"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].lpToken.balanceNative","typeLabel":"string"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available.","uniqueKey":"childrenVaults.items.[INDEX].lpToken.balanceUsd","typeLabel":"string"},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision","uniqueKey":"childrenVaults.items.[INDEX].lpToken.unclaimedNative","typeLabel":"string"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd","uniqueKey":"childrenVaults.items.[INDEX].lpToken.unclaimedUsd","typeLabel":"string"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision","uniqueKey":"childrenVaults.items.[INDEX].lpToken.positionValueInAsset","typeLabel":"string"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD","uniqueKey":"childrenVaults.items.[INDEX].lpToken.assetPriceInUsd","typeLabel":"string"}},"required":["address","tokenCaip","name","symbol","decimals","balanceNative"],"additionalProperties":false,"description":"LP token details of the child vault","uniqueKey":"childrenVaults.items.[INDEX].lpToken","typeLabel":"object"},"additionalAssets":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].address","typeLabel":"string"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].assetCaip","typeLabel":"string"},"name":{"type":"string","description":"Name of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].name","typeLabel":"string"},"symbol":{"type":"string","description":"Symbol of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].symbol","typeLabel":"string"},"decimals":{"type":"integer","description":"Number of decimals of the asset","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].decimals","typeLabel":"integer"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].assetGroup","typeLabel":"string"},"balanceNative":{"type":"string","description":"Balance of the asset denominated in asset precision","isRequired":true,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].balanceNative","typeLabel":"string"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo","uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].assetLogo","typeLabel":"string\u003curi>"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD","uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].assetPriceInUsd","typeLabel":"string"},"balanceUsd":{"type":"string","description":"Balance of the asset denominated in usd. Omitted when no price is available.","uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].balanceUsd","typeLabel":"string"},"unclaimedNative":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in asset precision","uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].unclaimedNative","typeLabel":"string"},"unclaimedUsd":{"type":"string","description":"Unclaimed balance of the asset in the position denominated in usd","uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].unclaimedUsd","typeLabel":"string"},"positionValueInAsset":{"type":"string","description":"Position value in asset denominated in asset precision","uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX].positionValueInAsset","typeLabel":"string"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup","balanceNative"],"additionalProperties":false,"uniqueKey":"childrenVaults.items.[INDEX].additionalAssets.items.[INDEX]","typeLabel":"object"},"description":"Additional assets of the child vault","uniqueKey":"childrenVaults.items.[INDEX].additionalAssets","typeLabel":"object[]"}},"required":["vaultId","address","asset"],"additionalProperties":false,"uniqueKey":"childrenVaults.items.[INDEX]","typeLabel":"object"},"description":"List of child vaults","uniqueKey":"childrenVaults","typeLabel":"object[]"},"apyComposite":{"type":"object","properties":{"totalApy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY","isRequired":true,"uniqueKey":"apyComposite.totalApy.base","typeLabel":"number"},"reward":{"type":"number","description":"Reward APY","isRequired":true,"uniqueKey":"apyComposite.totalApy.reward","typeLabel":"number"},"total":{"type":"number","description":"Total APY","isRequired":true,"uniqueKey":"apyComposite.totalApy.total","typeLabel":"number"}},"required":["base","reward","total"],"additionalProperties":false,"description":"Compounded APY combining the vault and its underlying vault","isRequired":true,"uniqueKey":"apyComposite.totalApy","typeLabel":"object"},"intrinsicApy":{"type":"object","properties":{"base":{"type":"number","description":"Base APY","isRequired":true,"uniqueKey":"apyComposite.intrinsicApy.base","typeLabel":"number"},"reward":{"type":"number","description":"Reward APY","isRequired":true,"uniqueKey":"apyComposite.intrinsicApy.reward","typeLabel":"number"},"total":{"type":"number","description":"Total APY","isRequired":true,"uniqueKey":"apyComposite.intrinsicApy.total","typeLabel":"number"}},"required":["base","reward","total"],"additionalProperties":false,"description":"APY of the underlying vault before compounding","isRequired":true,"uniqueKey":"apyComposite.intrinsicApy","typeLabel":"object"},"asset":{"type":"object","properties":{"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the asset","isRequired":true,"uniqueKey":"apyComposite.asset.address","typeLabel":"string"},"assetCaip":{"type":"string","pattern":"^eip155:\\d+\\/(erc20:0x[0-9a-fA-F]{40}|slip44:\\d+)$","description":"CAIP-2 of the asset","isRequired":true,"uniqueKey":"apyComposite.asset.assetCaip","typeLabel":"string"},"name":{"type":"string","description":"Name of the asset","isRequired":true,"uniqueKey":"apyComposite.asset.name","typeLabel":"string"},"symbol":{"type":"string","description":"Symbol of the asset","isRequired":true,"uniqueKey":"apyComposite.asset.symbol","typeLabel":"string"},"decimals":{"type":"integer","description":"Number of decimals of the asset","isRequired":true,"uniqueKey":"apyComposite.asset.decimals","typeLabel":"integer"},"assetGroup":{"type":"string","description":"Group of the asset, e.g., ETH, USD, EURO, BTC, OTHER","isRequired":true,"uniqueKey":"apyComposite.asset.assetGroup","typeLabel":"string"},"assetLogo":{"type":"string","format":"uri","description":"URL of the asset logo","uniqueKey":"apyComposite.asset.assetLogo","typeLabel":"string\u003curi>"},"assetPriceInUsd":{"type":"string","description":"Price of the asset in USD","uniqueKey":"apyComposite.asset.assetPriceInUsd","typeLabel":"string"}},"required":["address","assetCaip","name","symbol","decimals","assetGroup"],"additionalProperties":false,"description":"Asset details of the underlying vault","isRequired":true,"uniqueKey":"apyComposite.asset","typeLabel":"object"},"vault":{"type":"object","properties":{"vaultId":{"type":"string","description":"Vault id of the underlying vault","isRequired":true,"uniqueKey":"apyComposite.vault.vaultId","typeLabel":"string"},"address":{"type":"string","pattern":"^0x[a-fA-F0-9]{40}$","description":"Address of the underlying vault","isRequired":true,"uniqueKey":"apyComposite.vault.address","typeLabel":"string"}},"required":["vaultId","address"],"additionalProperties":false,"isRequired":true,"uniqueKey":"apyComposite.vault","typeLabel":"object"}},"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","uniqueKey":"apyComposite","typeLabel":"object"}},"required":["vaultId","address","network","asset","name","protocol","isTransactional","isAppFeatured","userEventsIndexed","apy"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"vaultId":"\u003cstring>","address":"\u003cstring>","network":{"name":"mainnet","chainId":123,"networkCaip":"\u003cstring>"},"asset":{"address":"\u003cstring>","assetCaip":"\u003cstring>","name":"\u003cstring>","symbol":"\u003cstring>","decimals":123,"assetGroup":"\u003cstring>","balanceNative":"\u003cstring>","assetLogo":"\u003cstring>","assetPriceInUsd":"\u003cstring>","balanceUsd":"\u003cstring>","unclaimedNative":"\u003cstring>","unclaimedUsd":"\u003cstring>","positionValueInAsset":"\u003cstring>"},"name":"\u003cstring>","protocol":{"protocolId":"\u003cstring>","name":"\u003cstring>","displayName":"\u003cstring>","product":"\u003cstring>","version":"\u003cstring>","protocolUrl":"\u003cstring>","description":"\u003cstring>","protocolLogo":"\u003cstring>"},"isTransactional":true,"isAppFeatured":true,"userEventsIndexed":true,"apy":{"base":123,"reward":123,"total":123},"additionalAssets":[{"address":"\u003cstring>","assetCaip":"\u003cstring>","name":"\u003cstring>","symbol":"\u003cstring>","decimals":123,"assetGroup":"\u003cstring>","balanceNative":"\u003cstring>","assetLogo":"\u003cstring>","assetPriceInUsd":"\u003cstring>","balanceUsd":"\u003cstring>","unclaimedNative":"\u003cstring>","unclaimedUsd":"\u003cstring>","positionValueInAsset":"\u003cstring>"}],"lpToken":{"address":"\u003cstring>","tokenCaip":"\u003cstring>","name":"\u003cstring>","symbol":"\u003cstring>","decimals":123,"balanceNative":"\u003cstring>","balanceUsd":"\u003cstring>","unclaimedNative":"\u003cstring>","unclaimedUsd":"\u003cstring>","positionValueInAsset":"\u003cstring>","assetPriceInUsd":"\u003cstring>"},"childrenVaults":[{"vaultId":"\u003cstring>","address":"\u003cstring>","asset":{"address":"\u003cstring>","assetCaip":"\u003cstring>","name":"\u003cstring>","symbol":"\u003cstring>","decimals":123,"assetGroup":"\u003cstring>","balanceNative":"\u003cstring>","assetLogo":"\u003cstring>","assetPriceInUsd":"\u003cstring>","balanceUsd":"\u003cstring>","unclaimedNative":"\u003cstring>","unclaimedUsd":"\u003cstring>","positionValueInAsset":"\u003cstring>"},"lpToken":{"address":"\u003cstring>","tokenCaip":"\u003cstring>","name":"\u003cstring>","symbol":"\u003cstring>","decimals":123,"balanceNative":"\u003cstring>","balanceUsd":"\u003cstring>","unclaimedNative":"\u003cstring>","unclaimedUsd":"\u003cstring>","positionValueInAsset":"\u003cstring>","assetPriceInUsd":"\u003cstring>"},"additionalAssets":[{"address":"\u003cstring>","assetCaip":"\u003cstring>","name":"\u003cstring>","symbol":"\u003cstring>","decimals":123,"assetGroup":"\u003cstring>","balanceNative":"\u003cstring>","assetLogo":"\u003cstring>","assetPriceInUsd":"\u003cstring>","balanceUsd":"\u003cstring>","unclaimedNative":"\u003cstring>","unclaimedUsd":"\u003cstring>","positionValueInAsset":"\u003cstring>"}]}],"apyComposite":{"totalApy":{"base":123,"reward":123,"total":123},"intrinsicApy":{"base":123,"reward":123,"total":123},"asset":{"address":"\u003cstring>","assetCaip":"\u003cstring>","name":"\u003cstring>","symbol":"\u003cstring>","decimals":123,"assetGroup":"\u003cstring>","assetLogo":"\u003cstring>","assetPriceInUsd":"\u003cstring>"},"vault":{"vaultId":"\u003cstring>","address":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"bb1dd400-9351-4209-8167-37ad434d5861":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.statusCode","typeLabel":"number"},"error":{"type":"string","enum":["Bad Request"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"errorId":{"type":"string","uniqueKey":"oneOf.0.errorId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"error":"Bad Request","message":"\u003cstring>","errorId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"be902c47-3ac4-4db1-8256-17f206ed49ff":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","enum":["Unauthorized"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"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."],"isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"enum\u003cstring>"},"errorId":{"type":"string","uniqueKey":"oneOf.0.errorId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","message":"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":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"75c2d8fb-401f-46e0-8cdb-7b2fe33f9fe0":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["x402Version","resource"],"properties":{"x402Version":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.x402Version.oneOf.0","typeLabel":"number"},{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.x402Version.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.0.x402Version","typeLabel":"number | string"},"resource":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.resource.url","typeLabel":"string"},"description":{"type":"string","uniqueKey":"oneOf.0.resource.description","typeLabel":"string"},"mimeType":{"type":"string","uniqueKey":"oneOf.0.resource.mimeType","typeLabel":"string"},"serviceName":{"type":"string","uniqueKey":"oneOf.0.resource.serviceName","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.resource.tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.resource.tags","typeLabel":"string[]"},"iconUrl":{"type":"string","uniqueKey":"oneOf.0.resource.iconUrl","typeLabel":"string"}},"required":["url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.resource","typeLabel":"object"},"error":{"type":"string","uniqueKey":"oneOf.0.error","typeLabel":"string"},"accepts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"scheme":{"type":"string","enum":["exact"],"isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].scheme","typeLabel":"enum\u003cstring>"},"network":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].network","typeLabel":"string"},"amount":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].amount","typeLabel":"string"},"payTo":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].payTo","typeLabel":"string"},"maxTimeoutSeconds":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].maxTimeoutSeconds","typeLabel":"number"},"asset":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].asset","typeLabel":"string"},"extra":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].extra.name","typeLabel":"string"},"version":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].extra.version","typeLabel":"string"}},"required":["name","version"],"additionalProperties":false,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX].extra","typeLabel":"object"}},"required":["scheme","network","amount","payTo","maxTimeoutSeconds","asset"],"additionalProperties":false,"uniqueKey":"oneOf.0.accepts.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.accepts.oneOf.0","typeLabel":"object[]"},{}],"uniqueKey":"oneOf.0.accepts","typeLabel":"object[]"},"extensions":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.extensions.additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0.extensions","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"x402Version":123,"resource":{"url":"\u003cstring>","description":"\u003cstring>","mimeType":"\u003cstring>","serviceName":"\u003cstring>","tags":["\u003cstring>"],"iconUrl":"\u003cstring>"},"error":"\u003cstring>","accepts":[{"scheme":"exact","network":"\u003cstring>","amount":"\u003cstring>","payTo":"\u003cstring>","maxTimeoutSeconds":123,"asset":"\u003cstring>","extra":{"name":"\u003cstring>","version":"\u003cstring>"}}],"extensions":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"4c42869c-d11a-41f6-9f2c-92b4b6faf3f0":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","enum":["Forbidden"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"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"],"isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"enum\u003cstring>"},"errorId":{"type":"string","uniqueKey":"oneOf.0.errorId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Forbidden","message":"This API key has exhausted its available credits. To resume service, please visit https://portal.vaults.fyi/signup to top-up your credits","errorId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5a4d5ddc-0ff0-40fd-a229-8c8c6874e5f6":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","enum":["Not Found"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["error","message"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Not Found","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d148cb51-afcf-4625-bfe8-e93659cbe992":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","uniqueKey":"oneOf.0.message","typeLabel":"string"},"errorId":{"type":"string","uniqueKey":"oneOf.0.errorId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errorId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"cf2c7c99-b4a1-4f2b-9909-a035255f63ea":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.statusCode","typeLabel":"number"},"error":{"type":"string","enum":["Unprocessable Entity"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"errorId":{"type":"string","uniqueKey":"oneOf.0.errorId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"error":"Unprocessable Entity","message":"\u003cstring>","errorId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"49beb33d-c31c-4689-82a5-1a0526f606da":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","enum":["Internal Server Error"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"errorId":{"type":"string","uniqueKey":"oneOf.0.errorId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Internal Server Error","message":"\u003cstring>","errorId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6f40b8eb-ffcd-4bf3-9ae1-3d81b0b23076":{"description":"Default Response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.statusCode","typeLabel":"number"},"error":{"type":"string","enum":["Service Unavailable"],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"errorId":{"type":"string","uniqueKey":"oneOf.0.errorId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"error":"Service Unavailable","message":"\u003cstring>","errorId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f2ba0041-fee6-4b84-ba71-d33f6879f88d":{"apiKey":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"apiKey"}}},"servers":{"20bee595-32b6-49b5-859f-8f62b9ee0c52":{"url":"https://api.vaults.fyi","description":"Vaults.fyi API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"apiKey"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"https://api.vaults.fyi/v2/documentation/json"},"subdomain":"vaultsfyi","siteName":"Vaults.fyi","title":"Get portfolio position - Vaults.fyi","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-25T18:56:42.086Z","originalFileLocation":"api-reference/portfolio/get-portfolio-position.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Gives a detailed view of one specific vault position on a given network.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vaults.fyi\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get portfolio position - Vaults.fyi\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gives a detailed view of one specific vault position on a given network.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vaults.fyi\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vaultsfyi.mintlify.app/_mintlify/api/og/v2?division=Portfolio\u0026amp;title=Get+portfolio+position\u0026amp;description=Gives+a+detailed+view+of+one+specific+vault+position+on+a+given+network.\u0026amp;theme=b4ba67dd4b088a3338b2ae20\u0026amp;signature=ceb734b24777553062de2c93970dc0fde84de9c9b90137561558e7d8d2da3967\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get portfolio position - Vaults.fyi\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gives a detailed view of one specific vault position on a given network.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vaultsfyi.mintlify.app/_mintlify/api/og/v2?division=Portfolio\u0026amp;title=Get+portfolio+position\u0026amp;description=Gives+a+detailed+view+of+one+specific+vault+position+on+a+given+network.\u0026amp;theme=b4ba67dd4b088a3338b2ae20\u0026amp;signature=ceb734b24777553062de2c93970dc0fde84de9c9b90137561558e7d8d2da3967\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vaultsfyi/7hM2popFdZ7XFny9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vaults.fyi\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#18abff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/portfolio/get-portfolio-position.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vaults.fyi/#organization\",\"name\":\"Vaults.fyi\",\"url\":\"https://docs.vaults.fyi\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vaultsfyi/e2nu_rHbR1M8lgfT/images/Logo-384px-black.png?fit=max\u0026auto=format\u0026n=e2nu_rHbR1M8lgfT\u0026q=85\u0026s=ad6b6e6796d582b64af53e9100b8b169\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vaults.fyi#website\",\"name\":\"Vaults.fyi\",\"url\":\"https://docs.vaults.fyi\",\"publisher\":{\"@id\":\"https://docs.vaults.fyi/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position#webpage\",\"url\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position\",\"name\":\"Get portfolio position\",\"description\":\"Gives a detailed view of one specific vault position on a given network.\",\"dateModified\":\"2026-10-25T18:56:42.086Z\",\"isPartOf\":{\"@id\":\"https://docs.vaults.fyi#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.vaults.fyi/api-reference/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Portfolio\",\"item\":\"https://docs.vaults.fyi/api-reference/portfolio/get-best-vault\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get portfolio position\",\"item\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position#apireference\",\"headline\":\"Get portfolio position\",\"name\":\"Get portfolio position\",\"description\":\"Gives a detailed view of one specific vault position on a given network.\",\"url\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vaults.fyi/api-reference/portfolio/get-portfolio-position#webpage\"},\"dateModified\":\"2026-10-25T18:56:42.086Z\",\"publisher\":{\"@id\":\"https://docs.vaults.fyi/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vaults.fyi#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vaults.fyi\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vaults.fyi","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","pages":[{"title":"Vaults.fyi API Overview","sidebarTitle":"Overview","href":"/api-reference/overview"},{"group":"Sections","pages":[{"title":"General","href":"/api-reference/general"},{"title":"Detailed Vaults","href":"/api-reference/detailed-vaults"},{"title":"Historical","href":"/api-reference/historical"},{"title":"Benchmarks","href":"/api-reference/benchmarks"},{"title":"Portfolio","href":"/api-reference/portfolio"},{"title":"Transactions","href":"/api-reference/transactions"},{"title":"Near Real-Time","href":"/api-reference/nrt"},{"title":"Health","href":"/api-reference/health"}]},{"group":"Legacy v1","hidden":true,"pages":[{"title":"Legacy v1 API Endpoints Overview","sidebarTitle":"Overview","href":"/api/legacy/overview"},{"title":"v1 Market Data Endpoints for DeFi Vaults","sidebarTitle":"Market Data","href":"/api/legacy/market-data"},{"title":"v1 Position Tracking Endpoints for DeFi Wallets","sidebarTitle":"Position Tracking","href":"/api/legacy/position-tracking"},{"title":"v1 Generate Payloads: DeFi Transaction Calldata","sidebarTitle":"Generate Payloads","href":"/api/legacy/generate-payloads"},{"title":"v1 Contextual Insights: Wallet-Based Yield Options","sidebarTitle":"Contextual Insights","href":"/api/legacy/contextual-insights"}]},{"group":"Endpoints","pages":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/health","href":"/api-reference/health/health-check"}]},{"group":"General","pages":[{"title":"List vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/vaults","href":"/api-reference/general/list-vaults"},{"title":"List assets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/assets","href":"/api-reference/general/list-assets"},{"title":"List tags","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/tags","href":"/api-reference/general/list-tags"},{"title":"List networks","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/networks","href":"/api-reference/general/list-networks"},{"title":"List curators","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/curators","href":"/api-reference/general/list-curators"},{"title":"List protocols","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/protocols","href":"/api-reference/general/list-protocols"}]},{"group":"Historical","pages":[{"title":"Get vault historical data","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}","href":"/api-reference/historical/get-vault-historical-data"},{"title":"Get historical APY","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}/apy","href":"/api-reference/historical/get-historical-apy"},{"title":"Get historical TVL","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}/tvl","href":"/api-reference/historical/get-historical-tvl"},{"title":"Get historical share price","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}/sharePrice","href":"/api-reference/historical/get-historical-share-price"},{"title":"Get historical asset prices","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/asset-prices/{network}/{assetAddress}","href":"/api-reference/historical/get-historical-asset-prices"}]},{"group":"Detailed Vaults","pages":[{"title":"List detailed vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults","href":"/api-reference/detailed-vaults/list-detailed-vaults"},{"title":"Get vault details","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults/{network}/{vaultId}","href":"/api-reference/detailed-vaults/get-vault-details"},{"title":"Get vault APY","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults/{network}/{vaultId}/apy","href":"/api-reference/detailed-vaults/get-vault-apy"},{"title":"Get vault TVL","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults/{network}/{vaultId}/tvl","href":"/api-reference/detailed-vaults/get-vault-tvl"}]},{"group":"Portfolio","pages":[{"title":"Get best vault","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/best-vault/{userAddress}","href":"/api-reference/portfolio/get-best-vault"},{"title":"List portfolio positions","description":"Provides all vault positions for the user, with optional filters.","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/positions/{userAddress}","href":"/api-reference/portfolio/list-portfolio-positions"},{"title":"Get portfolio position","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/positions/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/get-portfolio-position"},{"title":"Get best deposit options","description":"Analyzes a user's existing wallet balances and recommends optimal vault deposit opportunities based on yield performance, risk parameters, and user-defined criteria.","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/best-deposit-options/{userAddress}","href":"/api-reference/portfolio/get-best-deposit-options"},{"title":"List idle assets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/idle-assets/{userAddress}","href":"/api-reference/portfolio/list-idle-assets"},{"title":"Get total returns","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/total-returns/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/get-total-returns"},{"title":"List position events","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/events/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/list-position-events"}]},{"group":"Transactions","pages":[{"title":"Get transaction context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/context/{userAddress}/{network}/{vaultId}","href":"/api-reference/transactions/get-transaction-context"},{"title":"Get transaction suffix","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/suffix/{userAddress}/{vaultId}","href":"/api-reference/transactions/get-transaction-suffix"},{"title":"Get transaction payload","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/{action}/{userAddress}/{network}/{vaultId}","href":"/api-reference/transactions/get-transaction-payload"},{"title":"Get rewards context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/rewards/context/{userAddress}","href":"/api-reference/transactions/get-rewards-context"},{"title":"Claim rewards","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/rewards/claim/{userAddress}","href":"/api-reference/transactions/claim-rewards"}]},{"group":"Benchmarks","pages":[{"title":"Get benchmark rate","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/benchmarks/{network}","href":"/api-reference/benchmarks/get-benchmark-rate"},{"title":"Get historical benchmarks","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical-benchmarks/{network}","href":"/api-reference/benchmarks/get-historical-benchmarks"}]},{"group":"NRT","pages":[{"title":"Get vault NRT data","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}","href":"/api-reference/nrt/get-vault-nrt-data"},{"title":"Get vault NRT share price","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/sharePrice","href":"/api-reference/nrt/get-vault-nrt-share-price"},{"title":"Get vault NRT total supply","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/totalSupply","href":"/api-reference/nrt/get-vault-nrt-total-supply"},{"title":"Get vault NRT total assets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/totalAssets","href":"/api-reference/nrt/get-vault-nrt-total-assets"},{"title":"Get vault NRT underlying asset price","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/underlyingAssetPrice","href":"/api-reference/nrt/get-vault-nrt-underlying-asset-price"}]}]},{"group":"Beta","pages":[{"title":"Beta","href":"/api-reference/beta"},{"group":"Endpoints","pages":[{"group":"Borrow Markets","pages":[{"title":"Get borrow market transaction context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/markets/transactions/context/{userAddress}/{network}/{marketId}/{assetId}","href":"/api-reference/borrow-markets/get-borrow-market-transaction-context"},{"title":"Create borrow market transaction","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/markets/transactions/{action}/{userAddress}/{network}/{marketId}/{assetId}","href":"/api-reference/borrow-markets/create-borrow-market-transaction"},{"title":"List borrow markets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/markets/","href":"/api-reference/borrow-markets/list-borrow-markets"},{"title":"Get borrow market historical data","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/markets/historical/{network}/{marketId}/{assetId}","href":"/api-reference/borrow-markets/get-borrow-market-historical-data"},{"title":"Get borrow market asset NRT data","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/markets/nrt/{network}/{marketId}/{assetId}","href":"/api-reference/borrow-markets/get-borrow-market-asset-nrt-data"},{"title":"List borrow markets by network","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/markets/{network}","href":"/api-reference/borrow-markets/list-borrow-markets-by-network"},{"title":"Get borrow market","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/markets/{network}/{marketId}","href":"/api-reference/borrow-markets/get-borrow-market"},{"title":"List borrow market events","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/portfolio/events/{userAddress}/{network}/{marketId}/{assetId}","href":"/api-reference/borrow-markets/list-borrow-market-events"},{"title":"List borrow positions","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/portfolio/positions/{userAddress}","href":"/api-reference/borrow-markets/list-borrow-positions"},{"title":"Get borrow market asset position","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/portfolio/positions/{userAddress}/{network}/{marketId}/{assetId}","href":"/api-reference/borrow-markets/get-borrow-market-asset-position"},{"title":"Get borrow market position","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/borrow/portfolio/positions/{userAddress}/{network}/{marketId}","href":"/api-reference/borrow-markets/get-borrow-market-position"}]},{"group":"The Deep","pages":[{"title":"Create Deep deposit transaction","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/amm/deep/deposit/{userAddress}/{network}/{vaultId}","href":"/api-reference/the-deep/create-deep-deposit-transaction"},{"title":"Create Deep withdrawal transaction","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/amm/deep/withdraw/{userAddress}/{network}/{vaultId}","href":"/api-reference/the-deep/create-deep-withdrawal-transaction"},{"title":"Get Deep position","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/amm/deep/positions/{userAddress}/{network}/{vaultId}","href":"/api-reference/the-deep/get-deep-position"},{"title":"List Deep detailed vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/amm/deep/detailed-vaults","href":"/api-reference/the-deep/list-deep-detailed-vaults"}]},{"group":"Fixed Term (Pendle)","pages":[{"title":"List fixed-term Pendle markets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/fixed-term/","href":"/api-reference/fixed-term-pendle/list-fixed-term-pendle-markets"},{"title":"Get fixed-term market","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/fixed-term/detailed/{network}/{vaultId}","href":"/api-reference/fixed-term-pendle/get-fixed-term-market"},{"title":"Create fixed-term transaction","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/fixed-term/transactions/{action}/{userAddress}/{network}/{vaultId}","href":"/api-reference/fixed-term-pendle/create-fixed-term-transaction"},{"title":"Get fixed-term transaction context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/fixed-term/context/{userAddress}/{network}/{vaultId}","href":"/api-reference/fixed-term-pendle/get-fixed-term-transaction-context"}]},{"group":"Portfolio","pages":[{"title":"Get partial returns","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/portfolio/partial-returns/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/get-partial-returns"}]},{"group":"SVM","pages":[{"title":"Get SVM idle asset","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/portfolio/idle-assets/{userAddress}/{assetAddress}","href":"/api-reference/svm/get-svm-idle-asset"},{"title":"List SVM idle assets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/portfolio/idle-assets/{userAddress}","href":"/api-reference/svm/list-svm-idle-assets"},{"title":"List SVM vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/vaults","href":"/api-reference/svm/list-svm-vaults"},{"title":"List SVM detailed vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/detailed-vaults","href":"/api-reference/svm/list-svm-detailed-vaults"},{"title":"Get SVM detailed vault","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/detailed-vaults/{vaultAddress}","href":"/api-reference/svm/get-svm-detailed-vault"},{"title":"List SVM positions","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/portfolio/positions/{userAddress}","href":"/api-reference/svm/list-svm-positions"},{"title":"Create SVM transaction","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/transactions/{action}/{userAddress}/{vaultAddress}","href":"/api-reference/svm/create-svm-transaction"},{"title":"Get SVM transaction context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/transactions/context/{userAddress}/{vaultAddress}","href":"/api-reference/svm/get-svm-transaction-context"},{"title":"List SVM portfolio events across supported vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/portfolio/events/{userAddress}","href":"/api-reference/svm/list-svm-portfolio-events-across-supported-vaults"},{"title":"List SVM position events","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json get /beta/svm/portfolio/events/{userAddress}/{vaultAddress}","href":"/api-reference/svm/list-svm-position-events"}]},{"group":"Advanced Analytics","pages":[{"title":"List advanced vault analytics","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json post /beta/advanced-analytics","href":"/api-reference/advanced-analytics/list-advanced-vault-analytics"},{"title":"Get advanced vault analytics","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/beta/documentation/json post /beta/advanced-analytics/{network}/{vaultId}","href":"/api-reference/advanced-analytics/get-advanced-vault-analytics"}]}]}]},{"group":"Alpha","pages":[{"title":"Alpha","href":"/api-reference/alpha"},{"group":"Endpoints","pages":[{"group":"Holders","pages":[{"title":"List vault holders","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/{network}/{vaultId}/holders","href":"/api-reference/holders/list-vault-holders"}]},{"group":"Historical Positions","pages":[{"title":"List user historical positions","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/historical-positions/{userAddress}","href":"/api-reference/historical-positions/list-user-historical-positions"},{"title":"List user historical balances","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/historical-balances/{userAddress}/{timestamp}","href":"/api-reference/historical-positions/list-user-historical-balances"}]},{"group":"Historical","pages":[{"title":"Get historical daily vault flows","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/historical/{network}/{vaultId}/daily-flows","href":"/api-reference/historical/get-historical-daily-vault-flows"}]},{"group":"Cross Chain","pages":[{"title":"Create transaction intent quote","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json post /alpha/transactions/intent/getQuote","href":"/api-reference/cross-chain/create-transaction-intent-quote"},{"title":"Execute transaction intent","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json post /alpha/transactions/intent/execute","href":"/api-reference/cross-chain/execute-transaction-intent"},{"title":"Get transaction intent status","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/transactions/intent/status","href":"/api-reference/cross-chain/get-transaction-intent-status"}]},{"group":"CCTP Bridge","pages":[{"title":"Get CCTP transaction context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/transactions/cctp/context/{userAddress}/{srcNetwork}/{dstNetwork}/{assetAddress}","href":"/api-reference/cctp-bridge/get-cctp-transaction-context"},{"title":"List CCTP money in transit","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/transactions/cctp/money-in-transit/{userAddress}","href":"/api-reference/cctp-bridge/list-cctp-money-in-transit"},{"title":"Create CCTP transaction","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/transactions/cctp/transactions/{action}/{userAddress}/{srcNetwork}/{dstNetwork}","href":"/api-reference/cctp-bridge/create-cctp-transaction"},{"title":"Get CCTP transaction status","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/alpha/documentation/json get /alpha/transactions/cctp/status","href":"/api-reference/cctp-bridge/get-cctp-transaction-status"}]}]}]}],"groups":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/health","href":"/api-reference/health/health-check"}]},{"group":"General","pages":[{"title":"List vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/vaults","href":"/api-reference/general/list-vaults"},{"title":"List assets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/assets","href":"/api-reference/general/list-assets"},{"title":"List tags","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/tags","href":"/api-reference/general/list-tags"},{"title":"List networks","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/networks","href":"/api-reference/general/list-networks"},{"title":"List curators","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/curators","href":"/api-reference/general/list-curators"},{"title":"List protocols","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/protocols","href":"/api-reference/general/list-protocols"}]},{"group":"Historical","pages":[{"title":"Get vault historical data","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}","href":"/api-reference/historical/get-vault-historical-data"},{"title":"Get historical APY","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}/apy","href":"/api-reference/historical/get-historical-apy"},{"title":"Get historical TVL","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}/tvl","href":"/api-reference/historical/get-historical-tvl"},{"title":"Get historical share price","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/{network}/{vaultId}/sharePrice","href":"/api-reference/historical/get-historical-share-price"},{"title":"Get historical asset prices","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical/asset-prices/{network}/{assetAddress}","href":"/api-reference/historical/get-historical-asset-prices"}]},{"group":"Detailed Vaults","pages":[{"title":"List detailed vaults","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults","href":"/api-reference/detailed-vaults/list-detailed-vaults"},{"title":"Get vault details","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults/{network}/{vaultId}","href":"/api-reference/detailed-vaults/get-vault-details"},{"title":"Get vault APY","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults/{network}/{vaultId}/apy","href":"/api-reference/detailed-vaults/get-vault-apy"},{"title":"Get vault TVL","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/detailed-vaults/{network}/{vaultId}/tvl","href":"/api-reference/detailed-vaults/get-vault-tvl"}]},{"group":"Portfolio","pages":[{"title":"Get best vault","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/best-vault/{userAddress}","href":"/api-reference/portfolio/get-best-vault"},{"title":"List portfolio positions","description":"Provides all vault positions for the user, with optional filters.","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/positions/{userAddress}","href":"/api-reference/portfolio/list-portfolio-positions"},{"title":"Get portfolio position","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/positions/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/get-portfolio-position"},{"title":"Get best deposit options","description":"Analyzes a user's existing wallet balances and recommends optimal vault deposit opportunities based on yield performance, risk parameters, and user-defined criteria.","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/best-deposit-options/{userAddress}","href":"/api-reference/portfolio/get-best-deposit-options"},{"title":"List idle assets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/idle-assets/{userAddress}","href":"/api-reference/portfolio/list-idle-assets"},{"title":"Get total returns","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/total-returns/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/get-total-returns"},{"title":"List position events","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/portfolio/events/{userAddress}/{network}/{vaultId}","href":"/api-reference/portfolio/list-position-events"}]},{"group":"Transactions","pages":[{"title":"Get transaction context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/context/{userAddress}/{network}/{vaultId}","href":"/api-reference/transactions/get-transaction-context"},{"title":"Get transaction suffix","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/suffix/{userAddress}/{vaultId}","href":"/api-reference/transactions/get-transaction-suffix"},{"title":"Get transaction payload","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/{action}/{userAddress}/{network}/{vaultId}","href":"/api-reference/transactions/get-transaction-payload"},{"title":"Get rewards context","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/rewards/context/{userAddress}","href":"/api-reference/transactions/get-rewards-context"},{"title":"Claim rewards","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/transactions/rewards/claim/{userAddress}","href":"/api-reference/transactions/claim-rewards"}]},{"group":"Benchmarks","pages":[{"title":"Get benchmark rate","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/benchmarks/{network}","href":"/api-reference/benchmarks/get-benchmark-rate"},{"title":"Get historical benchmarks","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/historical-benchmarks/{network}","href":"/api-reference/benchmarks/get-historical-benchmarks"}]},{"group":"NRT","pages":[{"title":"Get vault NRT data","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}","href":"/api-reference/nrt/get-vault-nrt-data"},{"title":"Get vault NRT share price","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/sharePrice","href":"/api-reference/nrt/get-vault-nrt-share-price"},{"title":"Get vault NRT total supply","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/totalSupply","href":"/api-reference/nrt/get-vault-nrt-total-supply"},{"title":"Get vault NRT total assets","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/totalAssets","href":"/api-reference/nrt/get-vault-nrt-total-assets"},{"title":"Get vault NRT underlying asset price","deprecated":null,"version":null,"openapi":"https://api.vaults.fyi/v2/documentation/json get /v2/nrt/vault/{network}/{vaultId}/underlyingAssetPrice","href":"/api-reference/nrt/get-vault-nrt-underlying-asset-price"}]}]}]},"basePath":"","title":"Get portfolio position - Vaults.fyi","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}