compass_api_sdk 2.2.119__tar.gz → 2.2.120__tar.gz

{compass_api_sdk-2.2.119 → compass_api_sdk-2.2.120}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.119
+Version: 2.2.120
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10
@@ -242,8 +242,9 @@ with CompassAPI(
 * [credit_positions](docs/sdks/credit/README.md#credit_positions) - List credit positions
 * [credit_balances](docs/sdks/credit/README.md#credit_balances) - Get credit account token balances
 * [credit_looped_positions](docs/sdks/credit/README.md#credit_looped_positions) - List looped (leveraged) credit positions
-* [credit_euler_markets](docs/sdks/credit/README.md#credit_euler_markets) - List curated Euler markets
-* [credit_morpho_markets](docs/sdks/credit/README.md#credit_morpho_markets) - List curated Morpho markets
+* [credit_euler_markets](docs/sdks/credit/README.md#credit_euler_markets) - List Euler markets
+* [credit_morpho_markets](docs/sdks/credit/README.md#credit_morpho_markets) - List Morpho markets
+* [credit_aave_markets](docs/sdks/credit/README.md#credit_aave_markets) - List Aave markets
 * [credit_create_account](docs/sdks/credit/README.md#credit_create_account) - Create credit account
 * [credit_borrow](docs/sdks/credit/README.md#credit_borrow) - Borrow against collateral
 * [credit_loop](docs/sdks/credit/README.md#credit_loop) - Open a leveraged loop
@@ -510,8 +511,8 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 141 methods.*
-* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 141 methods.*
+* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 142 methods.*
+* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 142 methods.*
 * [`ResponseValidationError`](./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>

{compass_api_sdk-2.2.119 → compass_api_sdk-2.2.120}/README-PYPI.md

@@ -223,8 +223,9 @@ with CompassAPI(
 * [credit_positions](docs/sdks/credit/README.md#credit_positions) - List credit positions
 * [credit_balances](docs/sdks/credit/README.md#credit_balances) - Get credit account token balances
 * [credit_looped_positions](docs/sdks/credit/README.md#credit_looped_positions) - List looped (leveraged) credit positions
-* [credit_euler_markets](docs/sdks/credit/README.md#credit_euler_markets) - List curated Euler markets
-* [credit_morpho_markets](docs/sdks/credit/README.md#credit_morpho_markets) - List curated Morpho markets
+* [credit_euler_markets](docs/sdks/credit/README.md#credit_euler_markets) - List Euler markets
+* [credit_morpho_markets](docs/sdks/credit/README.md#credit_morpho_markets) - List Morpho markets
+* [credit_aave_markets](docs/sdks/credit/README.md#credit_aave_markets) - List Aave markets
 * [credit_create_account](docs/sdks/credit/README.md#credit_create_account) - Create credit account
 * [credit_borrow](docs/sdks/credit/README.md#credit_borrow) - Borrow against collateral
 * [credit_loop](docs/sdks/credit/README.md#credit_loop) - Open a leveraged loop
@@ -491,8 +492,8 @@ with CompassAPI(
 
 
 **Inherit from [`CompassAPIError`](./src/compass_api_sdk/errors/compassapierror.py)**:
-* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 141 methods.*
-* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 141 methods.*
+* [`TokenizedAssetsErrorResponse`](./src/compass_api_sdk/errors/tokenizedassetserrorresponse.py): Standard error envelope returned by every non-2xx response.  Surfaced in OpenAPI ``responses`` declarations so SDK consumers can decode failures uniformly without inspecting per-status-code shapes. Applicable to 12 of 142 methods.*
+* [`MintPrepareNotFoundResponseError`](./src/compass_api_sdk/errors/mintpreparenotfoundresponseerror.py): Response when the burn event has not been found yet.  This means the burn transaction hasn't been confirmed on-chain yet, or the user hasn't broadcast the burn transaction. Status code `404`. Applicable to 1 of 142 methods.*
 * [`ResponseValidationError`](./src/compass_api_sdk/errors/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
 
 </details>

{compass_api_sdk-2.2.119 → compass_api_sdk-2.2.120}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.119"
+version = "2.2.120"
 description = "Compass API SDK."
 authors = [{ name = "royalnine" },]
 readme = "README-PYPI.md"
@@ -14,7 +14,7 @@ dependencies = [
 
 [tool.poetry]
 name = "compass_api_sdk"
-version = "2.2.119"
+version = "2.2.120"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.119 → compass_api_sdk-2.2.120}/src/compass_api_sdk/credit.py

@@ -608,7 +608,7 @@ class Credit(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.EulerMarketsResponse:
-        r"""List curated Euler markets
+        r"""List Euler markets
 
         List curated Euler V2 credit markets for a chain.
 
@@ -703,7 +703,7 @@ class Credit(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.EulerMarketsResponse:
-        r"""List curated Euler markets
+        r"""List Euler markets
 
         List curated Euler V2 credit markets for a chain.
 
@@ -802,7 +802,7 @@ class Credit(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.MorphoMarketsResponse:
-        r"""List curated Morpho markets
+        r"""List Morpho markets
 
         List curated Morpho Blue lending markets for a chain.
 
@@ -909,7 +909,7 @@ class Credit(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.MorphoMarketsResponse:
-        r"""List curated Morpho markets
+        r"""List Morpho markets
 
         List curated Morpho Blue lending markets for a chain.
 
@@ -1003,6 +1003,204 @@ class Credit(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def credit_aave_markets(
+        self,
+        *,
+        chain: OptionalNullable[models.Chain] = UNSET,
+        days: Optional[int] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.ListAaveMarketsResponse:
+        r"""List Aave markets
+
+        List Aave lending markets with supply and borrow rates.
+
+        Returns rates organized by token symbol, with chain-specific data for each token. Each token includes rates for all chains where it's available, plus information about which chain offers the highest supply APY.
+
+        APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with zero APY on both supply and borrow are excluded.
+
+        Same data as `/v2/earn/aave_markets`. To borrow from an Aave market, use the [borrow endpoint](https://docs.compasslabs.ai/v2/api-reference/credit/borrow-against-collateral) (`protocol` defaults to `AAVE`).
+
+        :param chain: Optional chain filter. If not provided, returns rates for all chains.
+        :param days: Window in days used to compute `supply_apy_avg` / `borrow_apy_avg`. Mirrors the `days` parameter of the v1 `/v1/aave/avg_rate` endpoint.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.V2CreditAaveMarketsRequest(
+            chain=chain,
+            days=days,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v2/credit/aave_markets",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = self.do_request(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="v2_credit_aave_markets",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+                tags=["Credit"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.ListAaveMarketsResponse, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = utils.stream_to_text(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
+    async def credit_aave_markets_async(
+        self,
+        *,
+        chain: OptionalNullable[models.Chain] = UNSET,
+        days: Optional[int] = None,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.ListAaveMarketsResponse:
+        r"""List Aave markets
+
+        List Aave lending markets with supply and borrow rates.
+
+        Returns rates organized by token symbol, with chain-specific data for each token. Each token includes rates for all chains where it's available, plus information about which chain offers the highest supply APY.
+
+        APY values are returned in percentage format (e.g., 4.5 means 4.5%). Tokens with zero APY on both supply and borrow are excluded.
+
+        Same data as `/v2/earn/aave_markets`. To borrow from an Aave market, use the [borrow endpoint](https://docs.compasslabs.ai/v2/api-reference/credit/borrow-against-collateral) (`protocol` defaults to `AAVE`).
+
+        :param chain: Optional chain filter. If not provided, returns rates for all chains.
+        :param days: Window in days used to compute `supply_apy_avg` / `borrow_apy_avg`. Mirrors the `days` parameter of the v1 `/v1/aave/avg_rate` endpoint.
+        :param retries: Override the default retry configuration for this method
+        :param server_url: Override the default server URL for this method
+        :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
+        :param http_headers: Additional headers to set or replace on requests.
+        """
+        base_url = None
+        url_variables = None
+        if timeout_ms is None:
+            timeout_ms = self.sdk_configuration.timeout_ms
+
+        if server_url is not None:
+            base_url = server_url
+        else:
+            base_url = self._get_url(base_url, url_variables)
+
+        request = models.V2CreditAaveMarketsRequest(
+            chain=chain,
+            days=days,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v2/credit/aave_markets",
+            base_url=base_url,
+            url_variables=url_variables,
+            request=request,
+            request_body_required=False,
+            request_has_path_params=False,
+            request_has_query_params=True,
+            user_agent_header="user-agent",
+            accept_header_value="application/json",
+            http_headers=http_headers,
+            security=self.sdk_configuration.security,
+            allow_empty_value=None,
+            timeout_ms=timeout_ms,
+        )
+
+        if retries == UNSET:
+            if self.sdk_configuration.retry_config is not UNSET:
+                retries = self.sdk_configuration.retry_config
+
+        retry_config = None
+        if isinstance(retries, utils.RetryConfig):
+            retry_config = (retries, ["429", "500", "502", "503", "504"])
+
+        http_res = await self.do_request_async(
+            hook_ctx=HookContext(
+                config=self.sdk_configuration,
+                base_url=base_url or "",
+                operation_id="v2_credit_aave_markets",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+                tags=["Credit"],
+                extensions=None,
+            ),
+            request=req,
+            is_error_status_code=lambda c: utils.match_status_codes(["4XX", "5XX"], c),
+            retry_config=retry_config,
+        )
+
+        response_data: Any = None
+        if utils.match_response(http_res, "200", "application/json"):
+            return unmarshal_json_response(models.ListAaveMarketsResponse, http_res)
+        if utils.match_response(http_res, "422", "application/json"):
+            response_data = unmarshal_json_response(
+                errors.HTTPValidationErrorData, http_res
+            )
+            raise errors.HTTPValidationError(response_data, http_res)
+        if utils.match_response(http_res, "4XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+        if utils.match_response(http_res, "5XX", "*"):
+            http_res_text = await utils.stream_to_text_async(http_res)
+            raise errors.APIError("API error occurred", http_res, http_res_text)
+
+        raise errors.APIError("Unexpected response received", http_res)
+
     def credit_create_account(
         self,
         *,

{compass_api_sdk-2.2.119 → compass_api_sdk-2.2.120}/src/compass_api_sdk/models/__init__.py

@@ -1813,6 +1813,10 @@ if TYPE_CHECKING:
         V2CctpMintResponse,
         V2CctpMintResponseTypedDict,
     )
+    from .v2_credit_aave_marketsop import (
+        V2CreditAaveMarketsRequest,
+        V2CreditAaveMarketsRequestTypedDict,
+    )
     from .v2_credit_balancesop import (
         V2CreditBalancesChain,
         V2CreditBalancesRequest,
@@ -3322,6 +3326,8 @@ __all__ = [
     "V2BundleResponseTypedDict",
     "V2CctpMintResponse",
     "V2CctpMintResponseTypedDict",
+    "V2CreditAaveMarketsRequest",
+    "V2CreditAaveMarketsRequestTypedDict",
     "V2CreditBalancesChain",
     "V2CreditBalancesRequest",
     "V2CreditBalancesRequestTypedDict",
@@ -4738,6 +4744,8 @@ _dynamic_imports: dict[str, str] = {
     "Response200V2CctpMintTypedDict": ".v2_cctp_mintop",
     "V2CctpMintResponse": ".v2_cctp_mintop",
     "V2CctpMintResponseTypedDict": ".v2_cctp_mintop",
+    "V2CreditAaveMarketsRequest": ".v2_credit_aave_marketsop",
+    "V2CreditAaveMarketsRequestTypedDict": ".v2_credit_aave_marketsop",
     "V2CreditBalancesChain": ".v2_credit_balancesop",
     "V2CreditBalancesRequest": ".v2_credit_balancesop",
     "V2CreditBalancesRequestTypedDict": ".v2_credit_balancesop",

compass_api_sdk-2.2.120/src/compass_api_sdk/models/v2_credit_aave_marketsop.py

@@ -0,0 +1,61 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .chain import Chain
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class V2CreditAaveMarketsRequestTypedDict(TypedDict):
+    chain: NotRequired[Nullable[Chain]]
+    r"""Optional chain filter. If not provided, returns rates for all chains."""
+    days: NotRequired[int]
+    r"""Window in days used to compute `supply_apy_avg` / `borrow_apy_avg`. Mirrors the `days` parameter of the v1 `/v1/aave/avg_rate` endpoint."""
+
+
+class V2CreditAaveMarketsRequest(BaseModel):
+    chain: Annotated[
+        OptionalNullable[Chain],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Optional chain filter. If not provided, returns rates for all chains."""
+
+    days: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Window in days used to compute `supply_apy_avg` / `borrow_apy_avg`. Mirrors the `days` parameter of the v1 `/v1/aave/avg_rate` endpoint."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["chain", "days"])
+        nullable_fields = set(["chain"])
+        serialized = handler(self)
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k, serialized.get(n))
+            is_nullable_and_explicitly_set = (
+                k in nullable_fields
+                and (self.__pydantic_fields_set__.intersection({n}))  # pylint: disable=no-member
+            )
+
+            if val != UNSET_SENTINEL:
+                if (
+                    val is not None
+                    or k not in optional_fields
+                    or is_nullable_and_explicitly_set
+                ):
+                    m[k] = val
+
+        return m