compass_api_sdk 0.9.33

Compass API SDK.

compass_api_sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage compass_api_sdk API.

Summary

Compass API: Compass Labs DeFi API

Table of Contents

• compass_api_sdk
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install compass_api_sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add compass_api_sdk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from compass_api_sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "compass_api_sdk",
# ]
# ///

from compass_api_sdk import CompassAPI

sdk = CompassAPI(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from compass_api_sdk import CompassAPI, models

async def main():

    async with CompassAPI(
        api_key_auth="<YOUR_API_KEY_HERE>",
    ) as compass_api:

        res = await compass_api.aave_v3.rate_async(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
api_key_auth	apiKey	API key

To authenticate with the API the api_key_auth parameter must be set when initializing the SDK client instance. For example:

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)

    # Handle response
    print(res)

Available Resources and Operations

Available methods

aave_v3

• rate - Interest Rates
• avg_rate - Interest Rates: Time Average
• std_rate - Interest Rates: Standard Deviation
• reserve_overview - Reserve Overview
• token_price - Token Prices
• liquidity_change - Liquidity Index
• user_position_summary - Positions - Total
• user_position_per_token - Positions - per Token
• historical_transactions - Historical Transactions
• supply - Supply/Lend
• borrow - Borrow
• repay - Repay Loans
• withdraw - Unstake

aerodrome_slipstream

• slipstream_liquidity_provision_positions - List LP Positions
• slipstream_pool_price - Pool Price
• slipstream_swap_sell_exactly - Swap - from Specified Amount
• slipstream_swap_buy_exactly - Swap - into Specified Amount
• slipstream_liquidity_provision_mint - Open a New LP Position
• slipstream_liquidity_provision_increase - Increase an LP Position
• slipstream_liquidity_provision_withdraw - Withdraw an LP Position

erc_4626_vaults

• vault - Get Vault & User Position
• deposit - Deposit to Vault
• withdraw - Withdraw from Vault

morpho

• vaults - Get Vaults
• vault - Get Vault
• vault_position - Check Vault Position
• markets - Get Markets
• market - Get Market
• market_position - Check Market Position
• user_position - Check User Position
• deposit - Deposit to Vault
• withdraw - Withdraw from Vault
• supply_collateral - Supply Collateral to Market
• withdraw_collateral - Withdraw Collateral from Market
• borrow - Borrow from Market
• repay - Repay to Market

pendle

• position - Check User's Market Position
• positions - List User's Market Positions
• market - Get Market Data
• markets - List Market Data
• buy_pt - Buy Principal Token (PT)
• sell_pt - Sell Principal Token (PT)
• buy_yt - Buy Yield Token (YT)
• sell_yt - Sell Yield Token (YT)
• redeem_yield - Redeem Claimable Yield
• add_liquidity - Add Liquidity
• remove_liquidity - Remove Liquidity

sky

• position - Check USDS Position
• buy - Buy USDS
• sell - Sell USDS
• deposit - Deposit USDS
• withdraw - Withdraw USDS

smart_account

• account_batched_user_operations - Get Smart Account Batched User Operations

token

• address - Token Address
• price - Token Price
• balance - Token Balance
• transfer - Transfer ETH or ERC20 Tokens

transaction_bundler

• bundler_authorization - Enable Transaction Bundling
• bundler_execute - Construct Bundled Transaction
• bundler_aave_loop - AAVE Leverage Long/Short

uniswap_v3

• quote_buy_exactly - Get Quote - to Specified Amount
• quote_sell_exactly - Get quote - From Specified Amount
• pool_price - Pool Price
• liquidity_provision_in_range - Check if LP is Active.
• liquidity_provision_positions - List LP
• swap_buy_exactly - Buy exact amount
• swap_sell_exactly - Sell exact amount
• liquidity_provision_mint - Open a new LP position
• liquidity_provision_increase - Increase an LP position
• liquidity_provision_withdraw - Withdraw an LP position

universal

• portfolio - List User Portfolio
• visualize_portfolio - Visualize User Portfolio
• supported_tokens - List Supported Tokens
• allowance - Get Allowance
• ens - Resolve ENS
• wrap_eth - Wrap ETH
• unwrap_weth - Unwrap WETH
• allowance_set - Set Allowance

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from compass_api_sdk import CompassAPI, models
from compass_api_sdk.utils import BackoffStrategy, RetryConfig


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from compass_api_sdk import CompassAPI, models
from compass_api_sdk.utils import BackoffStrategy, RetryConfig


with CompassAPI(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)

    # Handle response
    print(res)

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a errors.APIError exception, which has the following properties:

Property	Type	Description
.status_code	int	The HTTP status code
.message	str	The error message
.raw_response	httpx.Response	The raw HTTP response
.body	str	The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the rate_async method may raise the following exceptions:

Error Type	Status Code	Content Type
errors.HTTPValidationError	422	application/json
errors.APIError	4XX, 5XX	*/*

Example

from compass_api_sdk import CompassAPI, errors, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:
    res = None
    try:

        res = compass_api.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)

        # Handle response
        print(res)

    except errors.HTTPValidationError as e:
        # handle e.data: errors.HTTPValidationErrorData
        raise(e)
    except errors.APIError as e:
        # handle exception
        raise(e)

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from compass_api_sdk import CompassAPI, models


with CompassAPI(
    server_url="https://api.compasslabs.ai",
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aave_v3.rate(chain=models.AaveRateChain.ARBITRUM_MAINNET, token=models.AaveRateToken.USDC)

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from compass_api_sdk import CompassAPI
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = CompassAPI(client=http_client)

or you could wrap the client with your own custom logic:

from compass_api_sdk import CompassAPI
from compass_api_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = CompassAPI(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The CompassAPI class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from compass_api_sdk import CompassAPI
def main():

    with CompassAPI(
        api_key_auth="<YOUR_API_KEY_HERE>",
    ) as compass_api:
        # Rest of application here...


# Or when using async:
async def amain():

    async with CompassAPI(
        api_key_auth="<YOUR_API_KEY_HERE>",
    ) as compass_api:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from compass_api_sdk import CompassAPI
import logging

logging.basicConfig(level=logging.DEBUG)
s = CompassAPI(debug_logger=logging.getLogger("compass_api_sdk"))

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.