> ## Documentation Index
> Fetch the complete documentation index at: https://docs.compasslabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start Guide

> Get started with Compass API. Create your free API key, install the SDKs, and make your first DeFi request in minutes.

## What You'll Do

In this guide, you'll make your first API call to explore yield opportunities across DeFi protocols. Get your free API key, install the SDK, and fetch vault data with APY and performance metrics.

***

<Steps>
  <Step title="Get your free Compass API key ">
    Get your [free API key](https://www.compasslabs.ai/login) and get instant access to every endpoint.
  </Step>

  <Step title="Install the Compass SDK">
    Check the [API reference](https://docs.compasslabs.ai/v2/api-reference/earn/list-earn-positions) for all available endpoints. Use familiar TypeScript / Python wrappers, or hit pure REST.

    * [Python SDK](https://pypi.org/project/compass_api_sdk/)

    ```bash theme={"system"}
    pip install compass_api_sdk
    ```

    * [TypeScript SDK ](https://www.npmjs.com/package/@compass-labs/api-sdk)

    ```bash theme={"system"}
    npm install @compass-labs/api-sdk
    ```
  </Step>

  <Step title="Explore yield opportunities">
    Get the lifetime return for 3 Morpho vaults on Ethereum. No wallet setup needed.

    <CodeGroup>
      ```Python Python (SDK) theme={"system"}
      from compass_api_sdk import CompassAPI, models

      with CompassAPI(api_key_auth="<YOUR_API_KEY_HERE>") as compass_api:
          result = compass_api.earn.earn_vaults(
              chain=models.V2EarnVaultsChain.ETHEREUM,
              order_by="lifetime_return",
              direction=models.Direction.DESC,
              limit=50
          )

          morpho_vaults = [v for v in result.vaults if v.protocol == "Morpho"][:3]
          for vault in morpho_vaults:
              lifetime_return = float(vault.lifetime_return or 0) * 100
              print(f"{vault.name}: {lifetime_return:.2f}% lifetime return")
      ```

      ```Typescript Typescript (SDK) theme={"system"}
      import { CompassApiSDK } from "@compass-labs/api-sdk";

      const compassApiSDK = new CompassApiSDK({
        apiKeyAuth: "<YOUR_API_KEY_HERE>",
      });

      async function run() {
        const result = await compassApiSDK.earn.earnVaults({
          chain: "ethereum",
          orderBy: "lifetime_return",
          direction: "desc",
          limit: 50,
        });

        const morphoVaults = result.vaults.filter(v => v.protocol === "Morpho").slice(0, 3);
        for (const vault of morphoVaults) {
          const lifetimeReturn = Number(vault.lifetimeReturn ?? 0) * 100;
          console.log(`${vault.name}: ${lifetimeReturn.toFixed(2)}% lifetime return`);
        }
      }

      run();
      ```
    </CodeGroup>

    **Example output:**

    | Vault Name         | Protocol | Lifetime Return |
    | ------------------ | -------- | --------------- |
    | Gauntlet USDC Core | Morpho   | 12.96%          |
    | Smokehouse USDC    | Morpho   | 8.29%           |
    | IMF USDS           | Morpho   | 7.64%           |
  </Step>
</Steps>

## Next Steps

Now that you've seen an example of vaults and information available, learn how to:

<CardGroup cols={3}>
  <Card title="Create Product Accounts" icon="wallet" href="/v2/Products/Accounts">
    Set up isolated accounts for Earn, Borrow, and Trade products. Enable bundling without approvals.
  </Card>

  <Card title="Earn" icon="chart-line" href="/v2/Products/Earn">
    Start earning yield by depositing into DeFi vaults and managing positions across protocols.
  </Card>

  <Card title="Add Embedded Fees" icon="money-bill" href="/v2/Products/Embedded-fees">
    Monetize your integration by embedding fees directly in transactions to generate revenue.
  </Card>
</CardGroup>

### Ready to test it yourself?

> Get your free API key [**here**](https://compasslabs.ai/login) and start building!

Need help? Ping us in on [Discord](http://discord.gg/ujetyJJPYr) or email [**contact@compasslabs.ai**](mailto:support@compasslabs.ai).