# Get a vault

`GET /api/vaults/{vault}`

## Authorization



## Parameters

- path: vault (string; required). 

Type: string

Example: "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660"

## Example · cURL

```bash
curl --request GET 'https://api.storm.tg/api/vaults/{vault}' \
  --header 'Accept: application/json'
```

## Example · JavaScript

```javascript
const response = await fetch("https://api.storm.tg/api/vaults/{vault}", {
  method: "GET",
  headers: {
    "Accept": "application/json"
  },
});
console.log(response.status, await response.text());
```

## Example · Python

```python
import requests

response = requests.request(
    "GET",
    "https://api.storm.tg/api/vaults/{vault}",
    headers={"Accept":"application/json"},
    timeout=30,
)
print(response.status_code, response.text)
```

## Response 200 · Data.VaultResponse

**200** application/json — Response

Schema: Data.VaultResponse

Type: object

Required fields: address, rate, lockedBalance, freeBalance, predictedRoi, apr, config

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)

- address (string; required)

address example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

address.Type: string

- rate (string · int64; required)

rate example: 0

rate.Type: string · int64

rate.format: int64

rate.pattern: ^(0|-?[1-9][0-9]*)$

- lockedBalance (string · int64; required)

lockedBalance example: 0

lockedBalance.Type: string · int64

lockedBalance.format: int64

lockedBalance.pattern: ^(0|-?[1-9][0-9]*)$

- freeBalance (string · int64; required)

freeBalance example: 0

freeBalance.Type: string · int64

freeBalance.format: int64

freeBalance.pattern: ^(0|-?[1-9][0-9]*)$

- predictedRoi (string · int64; required)

predictedRoi example: 0

predictedRoi.Type: string · int64

predictedRoi.format: int64

predictedRoi.pattern: ^(0|-?[1-9][0-9]*)$

- apr (object; required)

apr example: {
  "week": "0",
  "month": "0",
  "year": "0"
}

apr.Type: object

apr.Required fields: week, month, year

apr.Required field types: week (string · int64; required), month (string · int64; required), year (string · int64; required)

- apr.week (string · int64; required)

apr.week example: 0

apr.week.Type: string · int64

apr.week.format: int64

apr.week.pattern: ^(0|-?[1-9][0-9]*)$

- apr.month (string · int64; required)

apr.month example: 0

apr.month.Type: string · int64

apr.month.format: int64

apr.month.pattern: ^(0|-?[1-9][0-9]*)$

- apr.year (string · int64; required)

apr.year example: 0

apr.year.Type: string · int64

apr.year.format: int64

apr.year.pattern: ^(0|-?[1-9][0-9]*)$

- config (object; required)

config example: {
  "asset": {
    "name": "NOT",
    "decimals": 9,
    "assetId": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660"
  },
  "vaultAddress": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "quoteAssetId": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "lpJettonMaster": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660"
}

config.Type: object

config.Required fields: asset, vaultAddress, quoteAssetId

config.Required field types: asset (object; required), vaultAddress (string; required), quoteAssetId (string; required)

- config.asset (object; required)

config.asset example: {
  "name": "NOT",
  "decimals": 9,
  "assetId": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660"
}

config.asset.Type: object

config.asset.Required fields: name, decimals, assetId

config.asset.Required field types: name (string; required), decimals (number; required), assetId (string; required)

- config.asset.name (string; required)

config.asset.name example: NOT

config.asset.name.Type: string

- config.asset.decimals (number; required)

config.asset.decimals example: 9

config.asset.decimals.Type: number

- config.asset.assetId (string; required)

config.asset.assetId example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

config.asset.assetId.Type: string

- config.vaultAddress (string; required)

config.vaultAddress example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

config.vaultAddress.Type: string

- config.quoteAssetId (string; required)

config.quoteAssetId example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

config.quoteAssetId.Type: string

- config.lpJettonMaster (string; optional)

config.lpJettonMaster example: 0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660

config.lpJettonMaster.Type: string

Example



```json
{
  "address": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
  "rate": "0",
  "lockedBalance": "0",
  "freeBalance": "0",
  "predictedRoi": "0",
  "apr": {
    "week": "0",
    "month": "0",
    "year": "0"
  },
  "config": {
    "asset": {
      "name": "NOT",
      "decimals": 9,
      "assetId": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660"
    },
    "vaultAddress": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
    "quoteAssetId": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660",
    "lpJettonMaster": "0:72c310c83de5060d21674d58379b9a153854338a63d82588f8d912f83a3f8660"
  }
}
```