# Getting Started with the SDK

The simplest way to start using the vaults.fyi API is with our SDK. 

See below for installation instructions and find additional detailed documentation here: [sdk-reference](https://docs.vaults.fyi/api/getting-started-with-the-sdk/sdk-reference "mention")

***

1. #### Start by installing our SDK package:

{% tabs %}
{% tab title="Javascript" %}
Using npm

```
npm install @vaultsfyi/sdk
```

\
Using Yarn

```
yarn add @vaultsfyi/sdk

```

Using pnpm

```
pnpm add @vaultsfyi/sdk

```

Using Bun

```
bun add @vaultsfyi/sdk

```

Using jspm

```
jspm install @vaultsfyi/sdk
```

{% endtab %}

{% tab title="Python" %}
Using PIP

```
pip install vaultsfyi
```

Using Poetry

```
poetry add vaultsfyi
```

{% endtab %}
{% endtabs %}

2. #### Set your API key as an environment variable:

```
export VAULTS_FYI_API_KEY="your_api_key_here"
```

{% hint style="warning" %}
To start using the SDK you'll need to obtain an API key. The fastest way is to fill [this form](https://vaultsfyi.fillout.com/t/tLA9t6HyAFus). 
{% endhint %}

3. #### Initialize the SDK:

{% tabs %}
{% tab title="Javascript" %}

```javascript
import pkg from '@vaultsfyi/sdk';
const { VaultsSdk } = pkg;

const vaultsFyi = new VaultsSdk({
  apiKey: process.env.VAULTS_FYI_API_KEY,
});
```

{% endtab %}

{% tab title="Python" %}

```python
from vaultsfyi import VaultsSdk

api_key = os.getenv("VAULTS_FYI_API_KEY")
client = VaultsSdk(api_key=api_key)
```

{% endtab %}
{% endtabs %}

4. #### To take it for a spin, use one of the SDK functions: 
   * example: `getDepositOptions` to get multiple relevant yield opportunities for a specific blockchain address.
   * Find more in [sdk-reference](https://docs.vaults.fyi/api/getting-started-with-the-sdk/sdk-reference "mention")

{% tabs %}
{% tab title="Javascript" %}

```javascript
 const depositOptions = await vaultsFyi.getDepositOptions({
      path: { userAddress: '0xdB79e7E9e1412457528e40db9fCDBe69f558777d' },
      query: { allowedAssets: ['USDC', 'USDS'] }
    });
```

{% endtab %}

{% tab title="Python" %}

```python
user_address = "0xdB79e7E9e1412457528e40db9fCDBe69f558777d"
deposit_options = client.get_deposit_options(
            user_address, 
            allowed_assets=["USDC", "USDS"]
        )
```

{% endtab %}
{% endtabs %}

\
For more detailed example implementation check out our lightning tutorials (<5 mins!)&#x20;

<table data-view="cards"><thead><tr><th data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="getting-started-with-the-sdk/tutorials/wallet-integration">wallet-integration</a></td><td><a href="https://3226304686-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEkGaXDNnZOBpJqpoGvSf%2Fuploads%2FjtYyzFgh5hmhEjr8nUS3%2FScreenshot%202025-06-02%20at%2010.25.20.png?alt=media&#x26;token=cf38d989-999d-4dc7-89eb-cf60f901e6ee">Screenshot 2025-06-02 at 10.25.20.png</a></td></tr><tr><td><a href="getting-started-with-the-sdk/tutorials/data-analytics">data-analytics</a></td><td><a href="https://3226304686-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEkGaXDNnZOBpJqpoGvSf%2Fuploads%2F3yfHwkN2Xcw0q3acr05V%2FScreenshot%202025-06-02%20at%2010.26.40.png?alt=media&#x26;token=973d37e8-a563-4430-bb87-b161063a2bde">Screenshot 2025-06-02 at 10.26.40.png</a></td></tr></tbody></table>