{"format":"opendoc-document","version":1,"url":"https://docs.storm.tg/developers/operations/listvaults","title":"List vaults","description":"GET /api/vaults: List vaults","kind":"api-operation","locale":"en","inLanguage":"en","lastModified":"2026-10-09T14:26:32+03:00","revision":"d36475e7b456c737fae6933fa27b7e1bc2687f2c19291b05725ab2c4e8f79d7a","section":{"title":"For Developers","url":"https://docs.storm.tg/developers"},"representations":{"html":"https://docs.storm.tg/developers/operations/listvaults","markdown":"https://docs.storm.tg/developers/operations/listvaults.md","json":"https://docs.storm.tg/developers/operations/listvaults.json"},"translations":{"en":"https://docs.storm.tg/developers/operations/listvaults"},"operation":{"id":"ListVaults","method":"GET","path":"/api/vaults","summary":"List vaults","tags":["Vaults and liquidity"],"deprecated":false,"parameters":[],"bodies":[],"responses":[{"status":"200","description":"Response","mediaType":"application/json","properties":[],"schema":{"type":"object[]","types":["array"],"nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"items":{"type":"object","types":["object"],"reference":"#/components/schemas/Data.VaultResponse","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[{"name":"address","type":"string","required":true,"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","schema":{"type":"string","types":["string"],"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"variants":[]}},{"name":"rate","type":"string · int64","required":true,"example":"0","schema":{"type":"string · int64","types":["string"],"example":"0","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{"format":"int64","pattern":"^(0|-?[1-9][0-9]*)$"},"properties":[],"variants":[]}},{"name":"lockedBalance","type":"string · int64","required":true,"example":"0","schema":{"type":"string · int64","types":["string"],"example":"0","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{"format":"int64","pattern":"^(0|-?[1-9][0-9]*)$"},"properties":[],"variants":[]}},{"name":"freeBalance","type":"string · int64","required":true,"example":"0","schema":{"type":"string · int64","types":["string"],"example":"0","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{"format":"int64","pattern":"^(0|-?[1-9][0-9]*)$"},"properties":[],"variants":[]}},{"name":"predictedRoi","type":"string · int64","required":true,"example":"0","schema":{"type":"string · int64","types":["string"],"example":"0","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{"format":"int64","pattern":"^(0|-?[1-9][0-9]*)$"},"properties":[],"variants":[]}},{"name":"apr","type":"object","required":true,"example":"{\n  \"week\": \"0\",\n  \"month\": \"0\",\n  \"year\": \"0\"\n}","schema":{"type":"object","types":["object"],"nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[{"name":"week","type":"string · int64","required":true,"example":"0","schema":{"type":"string · int64","types":["string"],"example":"0","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{"format":"int64","pattern":"^(0|-?[1-9][0-9]*)$"},"properties":[],"variants":[]}},{"name":"month","type":"string · int64","required":true,"example":"0","schema":{"type":"string · int64","types":["string"],"example":"0","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{"format":"int64","pattern":"^(0|-?[1-9][0-9]*)$"},"properties":[],"variants":[]}},{"name":"year","type":"string · int64","required":true,"example":"0","schema":{"type":"string · int64","types":["string"],"example":"0","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{"format":"int64","pattern":"^(0|-?[1-9][0-9]*)$"},"properties":[],"variants":[]}}],"variants":[]}},{"name":"config","type":"object","required":true,"example":"{\n  \"asset\": {\n    \"name\": \"NOT\",\n    \"decimals\": 9,\n    \"assetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n  },\n  \"vaultAddress\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n  \"quoteAssetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n  \"lpJettonMaster\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n}","schema":{"type":"object","types":["object"],"title":"LiquiditySourceResponse","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[{"name":"asset","type":"object","required":true,"example":"{\n  \"name\": \"NOT\",\n  \"decimals\": 9,\n  \"assetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n}","schema":{"type":"object","types":["object"],"nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[{"name":"name","type":"string","required":true,"example":"NOT","schema":{"type":"string","types":["string"],"example":"NOT","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"variants":[]}},{"name":"decimals","type":"number","required":true,"example":"9","schema":{"type":"number","types":["number"],"example":9,"nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"variants":[]}},{"name":"assetId","type":"string","required":true,"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","schema":{"type":"string","types":["string"],"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"variants":[]}}],"variants":[]}},{"name":"vaultAddress","type":"string","required":true,"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","schema":{"type":"string","types":["string"],"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"variants":[]}},{"name":"quoteAssetId","type":"string","required":true,"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","schema":{"type":"string","types":["string"],"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"variants":[]}},{"name":"lpJettonMaster","type":"string","required":false,"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","schema":{"type":"string","types":["string"],"example":"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660","nullable":false,"readOnly":false,"writeOnly":false,"constraints":{},"properties":[],"variants":[]}}],"variants":[]}}],"variants":[]},"variants":[]},"example":"[\n  {\n    \"address\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n    \"rate\": \"0\",\n    \"lockedBalance\": \"0\",\n    \"freeBalance\": \"0\",\n    \"predictedRoi\": \"0\",\n    \"apr\": {\n      \"week\": \"0\",\n      \"month\": \"0\",\n      \"year\": \"0\"\n    },\n    \"config\": {\n      \"asset\": {\n        \"name\": \"NOT\",\n        \"decimals\": 9,\n        \"assetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n      },\n      \"vaultAddress\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n      \"quoteAssetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n      \"lpJettonMaster\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n    }\n  }\n]","headers":[]}],"security":[],"codeSamples":[{"label":"cURL","language":"bash","source":"curl --request GET 'https://api.storm.tg/api/vaults' \\\n  --header 'Accept: application/json'"},{"label":"JavaScript","language":"javascript","source":"const response = await fetch(\"https://api.storm.tg/api/vaults\", {\n  method: \"GET\",\n  headers: {\n    \"Accept\": \"application/json\"\n  },\n});\nconsole.log(response.status, await response.text());"},{"label":"Python","language":"python","source":"import requests\n\nresponse = requests.request(\n    \"GET\",\n    \"https://api.storm.tg/api/vaults\",\n    headers={\"Accept\":\"application/json\"},\n    timeout=30,\n)\nprint(response.status_code, response.text)"}]},"breadcrumbs":[{"title":"⚡ About Storm Trade","url":"https://docs.storm.tg"},{"title":"For Developers","url":"https://docs.storm.tg/developers"},{"title":"List vaults","url":"https://docs.storm.tg/developers/operations/listvaults"}],"headings":[{"depth":2,"id":"examples","title":"Examples"},{"depth":2,"id":"responses","title":"Responses"}],"markdown":"# List vaults\n\n`GET /api/vaults`\n\n## Authorization\n\n\n\n## Parameters\n\n\n\n## Example · cURL\n\n```bash\ncurl --request GET 'https://api.storm.tg/api/vaults' \\\n  --header 'Accept: application/json'\n```\n\n## Example · JavaScript\n\n```javascript\nconst response = await fetch(\"https://api.storm.tg/api/vaults\", {\n  method: \"GET\",\n  headers: {\n    \"Accept\": \"application/json\"\n  },\n});\nconsole.log(response.status, await response.text());\n```\n\n## Example · Python\n\n```python\nimport requests\n\nresponse = requests.request(\n    \"GET\",\n    \"https://api.storm.tg/api/vaults\",\n    headers={\"Accept\":\"application/json\"},\n    timeout=30,\n)\nprint(response.status_code, response.text)\n```\n\n## Response 200 · Data.VaultResponse\n\n**200** application/json — Response\n\nType: object[]\n\n[]Schema: Data.VaultResponse\n\n[]Type: object\n\n[]Required fields: address, rate, lockedBalance, freeBalance, predictedRoi, apr, config\n\n[]Required field types: address (string; required), rate (string · int64; required), lockedBalance (string · int64; required), freeBalance (string · int64; required), predictedRoi (string · int64; required), apr (object; required), config (object; required)\n\n- []address (string; required)\n\n[]address example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\n\n[]address.Type: string\n\n- []rate (string · int64; required)\n\n[]rate example: 0\n\n[]rate.Type: string · int64\n\n[]rate.format: int64\n\n[]rate.pattern: ^(0|-?[1-9][0-9]*)$\n\n- []lockedBalance (string · int64; required)\n\n[]lockedBalance example: 0\n\n[]lockedBalance.Type: string · int64\n\n[]lockedBalance.format: int64\n\n[]lockedBalance.pattern: ^(0|-?[1-9][0-9]*)$\n\n- []freeBalance (string · int64; required)\n\n[]freeBalance example: 0\n\n[]freeBalance.Type: string · int64\n\n[]freeBalance.format: int64\n\n[]freeBalance.pattern: ^(0|-?[1-9][0-9]*)$\n\n- []predictedRoi (string · int64; required)\n\n[]predictedRoi example: 0\n\n[]predictedRoi.Type: string · int64\n\n[]predictedRoi.format: int64\n\n[]predictedRoi.pattern: ^(0|-?[1-9][0-9]*)$\n\n- []apr (object; required)\n\n[]apr example: {\n  \"week\": \"0\",\n  \"month\": \"0\",\n  \"year\": \"0\"\n}\n\n[]apr.Type: object\n\n[]apr.Required fields: week, month, year\n\n[]apr.Required field types: week (string · int64; required), month (string · int64; required), year (string · int64; required)\n\n- []apr.week (string · int64; required)\n\n[]apr.week example: 0\n\n[]apr.week.Type: string · int64\n\n[]apr.week.format: int64\n\n[]apr.week.pattern: ^(0|-?[1-9][0-9]*)$\n\n- []apr.month (string · int64; required)\n\n[]apr.month example: 0\n\n[]apr.month.Type: string · int64\n\n[]apr.month.format: int64\n\n[]apr.month.pattern: ^(0|-?[1-9][0-9]*)$\n\n- []apr.year (string · int64; required)\n\n[]apr.year example: 0\n\n[]apr.year.Type: string · int64\n\n[]apr.year.format: int64\n\n[]apr.year.pattern: ^(0|-?[1-9][0-9]*)$\n\n- []config (object; required)\n\n[]config example: {\n  \"asset\": {\n    \"name\": \"NOT\",\n    \"decimals\": 9,\n    \"assetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n  },\n  \"vaultAddress\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n  \"quoteAssetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n  \"lpJettonMaster\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n}\n\n[]config.Type: object\n\n[]config.Required fields: asset, vaultAddress, quoteAssetId\n\n[]config.Required field types: asset (object; required), vaultAddress (string; required), quoteAssetId (string; required)\n\n- []config.asset (object; required)\n\n[]config.asset example: {\n  \"name\": \"NOT\",\n  \"decimals\": 9,\n  \"assetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n}\n\n[]config.asset.Type: object\n\n[]config.asset.Required fields: name, decimals, assetId\n\n[]config.asset.Required field types: name (string; required), decimals (number; required), assetId (string; required)\n\n- []config.asset.name (string; required)\n\n[]config.asset.name example: NOT\n\n[]config.asset.name.Type: string\n\n- []config.asset.decimals (number; required)\n\n[]config.asset.decimals example: 9\n\n[]config.asset.decimals.Type: number\n\n- []config.asset.assetId (string; required)\n\n[]config.asset.assetId example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\n\n[]config.asset.assetId.Type: string\n\n- []config.vaultAddress (string; required)\n\n[]config.vaultAddress example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\n\n[]config.vaultAddress.Type: string\n\n- []config.quoteAssetId (string; required)\n\n[]config.quoteAssetId example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\n\n[]config.quoteAssetId.Type: string\n\n- []config.lpJettonMaster (string; optional)\n\n[]config.lpJettonMaster example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\n\n[]config.lpJettonMaster.Type: string\n\nExample\n\n\n\n```json\n[\n  {\n    \"address\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n    \"rate\": \"0\",\n    \"lockedBalance\": \"0\",\n    \"freeBalance\": \"0\",\n    \"predictedRoi\": \"0\",\n    \"apr\": {\n      \"week\": \"0\",\n      \"month\": \"0\",\n      \"year\": \"0\"\n    },\n    \"config\": {\n      \"asset\": {\n        \"name\": \"NOT\",\n        \"decimals\": 9,\n        \"assetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n      },\n      \"vaultAddress\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n      \"quoteAssetId\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\",\n      \"lpJettonMaster\": \"0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660\"\n    }\n  }\n]\n```","text":"List vaults GET /api/vaults Vaults and liquidity 200 Response","api":{"title":"Storm API reference","version":"3.0","documentation":"https://docs.storm.tg/developers/overview","playgroundServer":"https://api.storm.tg"}}