compass_api_sdk 2.2.116__tar.gz → 2.2.117__tar.gz

{compass_api_sdk-2.2.116 → compass_api_sdk-2.2.117}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.116
+Version: 2.2.117
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10

{compass_api_sdk-2.2.116 → compass_api_sdk-2.2.117}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "compass_api_sdk"
-version = "2.2.116"
+version = "2.2.117"
 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.116"
+version = "2.2.117"
 description = "Compass API SDK."
 authors = ["Compass Labs"]
 repository = "https://github.com/CompassLabs/mono.git"

{compass_api_sdk-2.2.116 → compass_api_sdk-2.2.117}/src/compass_api_sdk/earn.py

@@ -406,11 +406,11 @@ class Earn(BaseSDK):
     def earn_vaults(
         self,
         *,
-        order_by: str,
         direction: Optional[models.V2EarnVaultsDirection] = None,
         offset: Optional[int] = None,
         limit: Optional[int] = None,
         chain: OptionalNullable[models.Chain] = UNSET,
+        order_by: Optional[str] = None,
         asset_symbol: OptionalNullable[str] = UNSET,
         min_tvl_usd: OptionalNullable[
             Union[models.V2EarnVaultsMinTvlUsd, models.V2EarnVaultsMinTvlUsdTypedDict]
@@ -436,11 +436,11 @@ class Earn(BaseSDK):
 
         To deposit into a vault, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=VAULTS`.
 
-        :param order_by: The field to order the results by.
         :param direction: The direction to order the results by.
         :param offset: The offset of the first item to return.
         :param limit: The number of items to return.
         :param chain: Optional chain filter. If not provided, returns vaults for all chains.
+        :param order_by: Field to order the vaults by. One of: tvl_usd, liquidity_usd, deposit_cap_usd, apy_7d, apy_30d, apy_90d. Defaults to tvl_usd; unknown values also fall back to tvl_usd.
         :param asset_symbol: Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').
         :param min_tvl_usd: Minimum TVL in USD. Vaults with TVL below this value will be excluded.
         :param min_liquidity_usd: Minimum available liquidity in USD. Vaults below this are excluded.
@@ -461,11 +461,11 @@ class Earn(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.V2EarnVaultsRequest(
-            order_by=order_by,
             direction=direction,
             offset=offset,
             limit=limit,
             chain=chain,
+            order_by=order_by,
             asset_symbol=asset_symbol,
             min_tvl_usd=min_tvl_usd,
             min_liquidity_usd=min_liquidity_usd,
@@ -532,11 +532,11 @@ class Earn(BaseSDK):
     async def earn_vaults_async(
         self,
         *,
-        order_by: str,
         direction: Optional[models.V2EarnVaultsDirection] = None,
         offset: Optional[int] = None,
         limit: Optional[int] = None,
         chain: OptionalNullable[models.Chain] = UNSET,
+        order_by: Optional[str] = None,
         asset_symbol: OptionalNullable[str] = UNSET,
         min_tvl_usd: OptionalNullable[
             Union[models.V2EarnVaultsMinTvlUsd, models.V2EarnVaultsMinTvlUsdTypedDict]
@@ -562,11 +562,11 @@ class Earn(BaseSDK):
 
         To deposit into a vault, use the [manage endpoint](https://docs.compasslabs.ai/v2/api-reference/earn/manage-earn-position) with `venue_type=VAULTS`.
 
-        :param order_by: The field to order the results by.
         :param direction: The direction to order the results by.
         :param offset: The offset of the first item to return.
         :param limit: The number of items to return.
         :param chain: Optional chain filter. If not provided, returns vaults for all chains.
+        :param order_by: Field to order the vaults by. One of: tvl_usd, liquidity_usd, deposit_cap_usd, apy_7d, apy_30d, apy_90d. Defaults to tvl_usd; unknown values also fall back to tvl_usd.
         :param asset_symbol: Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH').
         :param min_tvl_usd: Minimum TVL in USD. Vaults with TVL below this value will be excluded.
         :param min_liquidity_usd: Minimum available liquidity in USD. Vaults below this are excluded.
@@ -587,11 +587,11 @@ class Earn(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.V2EarnVaultsRequest(
-            order_by=order_by,
             direction=direction,
             offset=offset,
             limit=limit,
             chain=chain,
+            order_by=order_by,
             asset_symbol=asset_symbol,
             min_tvl_usd=min_tvl_usd,
             min_liquidity_usd=min_liquidity_usd,
@@ -856,11 +856,11 @@ class Earn(BaseSDK):
     def earn_pendle_markets(
         self,
         *,
-        order_by: str,
         direction: Optional[models.V2EarnPendleMarketsDirection] = None,
         offset: Optional[int] = None,
         limit: Optional[int] = None,
         chain: OptionalNullable[models.Chain] = UNSET,
+        order_by: Optional[str] = None,
         underlying_symbol: OptionalNullable[str] = UNSET,
         min_tvl_usd: OptionalNullable[
             Union[
@@ -886,11 +886,11 @@ class Earn(BaseSDK):
         APY values are returned in percentage format (e.g., 5.25 means 5.25%). Markets
         without complete metadata or statistics are excluded.
 
-        :param order_by: The field to order the results by.
         :param direction: The direction to order the results by.
         :param offset: The offset of the first item to return.
         :param limit: The number of items to return.
         :param chain: Optional chain filter. If not provided, returns markets for all chains.
+        :param order_by: Field to order the markets by. One of: tvl_usd, implied_apy. Defaults to tvl_usd; unknown values also fall back to tvl_usd.
         :param underlying_symbol: Filter markets by underlying asset symbol (e.g., 'USDC', 'WETH').
         :param min_tvl_usd: Minimum TVL in USD. Markets with TVL below this value will be excluded.
         :param retries: Override the default retry configuration for this method
@@ -909,11 +909,11 @@ class Earn(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.V2EarnPendleMarketsRequest(
-            order_by=order_by,
             direction=direction,
             offset=offset,
             limit=limit,
             chain=chain,
+            order_by=order_by,
             underlying_symbol=underlying_symbol,
             min_tvl_usd=min_tvl_usd,
         )
@@ -978,11 +978,11 @@ class Earn(BaseSDK):
     async def earn_pendle_markets_async(
         self,
         *,
-        order_by: str,
         direction: Optional[models.V2EarnPendleMarketsDirection] = None,
         offset: Optional[int] = None,
         limit: Optional[int] = None,
         chain: OptionalNullable[models.Chain] = UNSET,
+        order_by: Optional[str] = None,
         underlying_symbol: OptionalNullable[str] = UNSET,
         min_tvl_usd: OptionalNullable[
             Union[
@@ -1008,11 +1008,11 @@ class Earn(BaseSDK):
         APY values are returned in percentage format (e.g., 5.25 means 5.25%). Markets
         without complete metadata or statistics are excluded.
 
-        :param order_by: The field to order the results by.
         :param direction: The direction to order the results by.
         :param offset: The offset of the first item to return.
         :param limit: The number of items to return.
         :param chain: Optional chain filter. If not provided, returns markets for all chains.
+        :param order_by: Field to order the markets by. One of: tvl_usd, implied_apy. Defaults to tvl_usd; unknown values also fall back to tvl_usd.
         :param underlying_symbol: Filter markets by underlying asset symbol (e.g., 'USDC', 'WETH').
         :param min_tvl_usd: Minimum TVL in USD. Markets with TVL below this value will be excluded.
         :param retries: Override the default retry configuration for this method
@@ -1031,11 +1031,11 @@ class Earn(BaseSDK):
             base_url = self._get_url(base_url, url_variables)
 
         request = models.V2EarnPendleMarketsRequest(
-            order_by=order_by,
             direction=direction,
             offset=offset,
             limit=limit,
             chain=chain,
+            order_by=order_by,
             underlying_symbol=underlying_symbol,
             min_tvl_usd=min_tvl_usd,
         )

{compass_api_sdk-2.2.116 → compass_api_sdk-2.2.117}/src/compass_api_sdk/models/marketallocation.py

@@ -22,11 +22,13 @@ class MarketAllocationTypedDict(TypedDict):
     collateral_token: str
     r"""Address of the collateral token accepted by this market."""
     lltv: str
-    r"""Liquidation Loan-To-Value ratio as a raw uint256 string. Divide by 1e18 to get the decimal ratio (e.g., '860000000000000000' = 86%)."""
+    r"""Liquidation Loan-To-Value ratio as a raw uint256 string scaled by 1e18 (e.g., '860000000000000000' = 86%). Kept for backward compatibility; prefer `lltv_percent`."""
     loan_token_symbol: NotRequired[Nullable[str]]
     r"""Symbol of the loan token (e.g., 'USDC')."""
     collateral_token_symbol: NotRequired[Nullable[str]]
     r"""Symbol of the collateral token (e.g., 'WETH')."""
+    lltv_percent: NotRequired[Nullable[str]]
+    r"""Liquidation Loan-To-Value in percent (e.g. 86 means a position is liquidatable once debt exceeds 86% of collateral value). Same scale as `lltv` on /v2/credit/morpho_markets."""
     supply_cap: NotRequired[Nullable[str]]
     r"""Maximum amount the vault is allowed to supply to this market, as a raw uint184 string in the smallest token unit."""
     supply_assets: NotRequired[Nullable[str]]
@@ -48,7 +50,7 @@ class MarketAllocation(BaseModel):
     r"""Address of the collateral token accepted by this market."""
 
     lltv: str
-    r"""Liquidation Loan-To-Value ratio as a raw uint256 string. Divide by 1e18 to get the decimal ratio (e.g., '860000000000000000' = 86%)."""
+    r"""Liquidation Loan-To-Value ratio as a raw uint256 string scaled by 1e18 (e.g., '860000000000000000' = 86%). Kept for backward compatibility; prefer `lltv_percent`."""
 
     loan_token_symbol: OptionalNullable[str] = UNSET
     r"""Symbol of the loan token (e.g., 'USDC')."""
@@ -56,6 +58,9 @@ class MarketAllocation(BaseModel):
     collateral_token_symbol: OptionalNullable[str] = UNSET
     r"""Symbol of the collateral token (e.g., 'WETH')."""
 
+    lltv_percent: OptionalNullable[str] = UNSET
+    r"""Liquidation Loan-To-Value in percent (e.g. 86 means a position is liquidatable once debt exceeds 86% of collateral value). Same scale as `lltv` on /v2/credit/morpho_markets."""
+
     supply_cap: OptionalNullable[str] = UNSET
     r"""Maximum amount the vault is allowed to supply to this market, as a raw uint184 string in the smallest token unit."""
 
@@ -71,6 +76,7 @@ class MarketAllocation(BaseModel):
             [
                 "loan_token_symbol",
                 "collateral_token_symbol",
+                "lltv_percent",
                 "supply_cap",
                 "supply_assets",
                 "allocation_pct",
@@ -80,6 +86,7 @@ class MarketAllocation(BaseModel):
             [
                 "loan_token_symbol",
                 "collateral_token_symbol",
+                "lltv_percent",
                 "supply_cap",
                 "supply_assets",
                 "allocation_pct",

{compass_api_sdk-2.2.116 → compass_api_sdk-2.2.117}/src/compass_api_sdk/models/v2_earn_pendle_marketsop.py

@@ -36,8 +36,6 @@ r"""Minimum TVL in USD. Markets with TVL below this value will be excluded."""
 
 
 class V2EarnPendleMarketsRequestTypedDict(TypedDict):
-    order_by: str
-    r"""The field to order the results by."""
     direction: NotRequired[V2EarnPendleMarketsDirection]
     r"""The direction to order the results by."""
     offset: NotRequired[int]
@@ -46,6 +44,8 @@ class V2EarnPendleMarketsRequestTypedDict(TypedDict):
     r"""The number of items to return."""
     chain: NotRequired[Nullable[Chain]]
     r"""Optional chain filter. If not provided, returns markets for all chains."""
+    order_by: NotRequired[str]
+    r"""Field to order the markets by. One of: tvl_usd, implied_apy. Defaults to tvl_usd; unknown values also fall back to tvl_usd."""
     underlying_symbol: NotRequired[Nullable[str]]
     r"""Filter markets by underlying asset symbol (e.g., 'USDC', 'WETH')."""
     min_tvl_usd: NotRequired[Nullable[V2EarnPendleMarketsMinTvlUsdTypedDict]]
@@ -53,11 +53,6 @@ class V2EarnPendleMarketsRequestTypedDict(TypedDict):
 
 
 class V2EarnPendleMarketsRequest(BaseModel):
-    order_by: Annotated[
-        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
-    ]
-    r"""The field to order the results by."""
-
     direction: Annotated[
         Optional[V2EarnPendleMarketsDirection],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -82,6 +77,12 @@ class V2EarnPendleMarketsRequest(BaseModel):
     ] = UNSET
     r"""Optional chain filter. If not provided, returns markets for all chains."""
 
+    order_by: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Field to order the markets by. One of: tvl_usd, implied_apy. Defaults to tvl_usd; unknown values also fall back to tvl_usd."""
+
     underlying_symbol: Annotated[
         OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -102,6 +103,7 @@ class V2EarnPendleMarketsRequest(BaseModel):
                 "offset",
                 "limit",
                 "chain",
+                "order_by",
                 "underlying_symbol",
                 "min_tvl_usd",
             ]

{compass_api_sdk-2.2.116 → compass_api_sdk-2.2.117}/src/compass_api_sdk/models/v2_earn_vaultsop.py

@@ -52,8 +52,6 @@ r"""Minimum deposit capacity in USD. Vaults below this are excluded. Set to 0 to
 
 
 class V2EarnVaultsRequestTypedDict(TypedDict):
-    order_by: str
-    r"""The field to order the results by."""
     direction: NotRequired[V2EarnVaultsDirection]
     r"""The direction to order the results by."""
     offset: NotRequired[int]
@@ -62,6 +60,8 @@ class V2EarnVaultsRequestTypedDict(TypedDict):
     r"""The number of items to return."""
     chain: NotRequired[Nullable[Chain]]
     r"""Optional chain filter. If not provided, returns vaults for all chains."""
+    order_by: NotRequired[str]
+    r"""Field to order the vaults by. One of: tvl_usd, liquidity_usd, deposit_cap_usd, apy_7d, apy_30d, apy_90d. Defaults to tvl_usd; unknown values also fall back to tvl_usd."""
     asset_symbol: NotRequired[Nullable[str]]
     r"""Filter vaults by underlying asset symbol (e.g., 'USDC', 'WETH')."""
     min_tvl_usd: NotRequired[Nullable[V2EarnVaultsMinTvlUsdTypedDict]]
@@ -73,11 +73,6 @@ class V2EarnVaultsRequestTypedDict(TypedDict):
 
 
 class V2EarnVaultsRequest(BaseModel):
-    order_by: Annotated[
-        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
-    ]
-    r"""The field to order the results by."""
-
     direction: Annotated[
         Optional[V2EarnVaultsDirection],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -102,6 +97,12 @@ class V2EarnVaultsRequest(BaseModel):
     ] = UNSET
     r"""Optional chain filter. If not provided, returns vaults for all chains."""
 
+    order_by: Annotated[
+        Optional[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Field to order the vaults by. One of: tvl_usd, liquidity_usd, deposit_cap_usd, apy_7d, apy_30d, apy_90d. Defaults to tvl_usd; unknown values also fall back to tvl_usd."""
+
     asset_symbol: Annotated[
         OptionalNullable[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
@@ -134,6 +135,7 @@ class V2EarnVaultsRequest(BaseModel):
                 "offset",
                 "limit",
                 "chain",
+                "order_by",
                 "asset_symbol",
                 "min_tvl_usd",
                 "min_liquidity_usd",