compass_api_sdk 2.2.53rc2__tar.gz → 2.2.54__tar.gz

{compass_api_sdk-2.2.53rc2 → compass_api_sdk-2.2.54}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compass_api_sdk
-Version: 2.2.53rc2
+Version: 2.2.54
 Summary: Compass API SDK.
 Author: royalnine
 Requires-Python: >=3.10
@@ -282,6 +282,7 @@ with CompassAPI(
 
 * [global_markets_perps_opportunities](docs/sdks/globalmarketsperps/README.md#global_markets_perps_opportunities) - List global markets perps markets
 * [global_markets_perps_positions](docs/sdks/globalmarketsperps/README.md#global_markets_perps_positions) - List global markets perps positions
+* [global_markets_perps_candles](docs/sdks/globalmarketsperps/README.md#global_markets_perps_candles) - Get OHLCV candles
 * [global_markets_perps_activity](docs/sdks/globalmarketsperps/README.md#global_markets_perps_activity) - Aggregated Hyperliquid activity for a user
 * [global_markets_perps_deposit](docs/sdks/globalmarketsperps/README.md#global_markets_perps_deposit) - Deposit USDC to global markets perps account
 * [global_markets_perps_withdraw](docs/sdks/globalmarketsperps/README.md#global_markets_perps_withdraw) - Withdraw USDC from global markets perps account
@@ -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 8 of 123 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 123 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 8 of 124 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 124 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.53rc2 → compass_api_sdk-2.2.54}/README-PYPI.md

@@ -264,6 +264,7 @@ with CompassAPI(
 
 * [global_markets_perps_opportunities](docs/sdks/globalmarketsperps/README.md#global_markets_perps_opportunities) - List global markets perps markets
 * [global_markets_perps_positions](docs/sdks/globalmarketsperps/README.md#global_markets_perps_positions) - List global markets perps positions
+* [global_markets_perps_candles](docs/sdks/globalmarketsperps/README.md#global_markets_perps_candles) - Get OHLCV candles
 * [global_markets_perps_activity](docs/sdks/globalmarketsperps/README.md#global_markets_perps_activity) - Aggregated Hyperliquid activity for a user
 * [global_markets_perps_deposit](docs/sdks/globalmarketsperps/README.md#global_markets_perps_deposit) - Deposit USDC to global markets perps account
 * [global_markets_perps_withdraw](docs/sdks/globalmarketsperps/README.md#global_markets_perps_withdraw) - Withdraw USDC from global markets perps account
@@ -473,8 +474,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 8 of 123 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 123 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 8 of 124 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 124 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.53rc2 → compass_api_sdk-2.2.54}/pyproject.toml

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

{compass_api_sdk-2.2.53rc2 → compass_api_sdk-2.2.54}/src/compass_api_sdk/_version.py

@@ -5,8 +5,8 @@ import importlib.metadata
 __title__: str = "compass_api_sdk"
 __version__: str = "2.0.0"
 __openapi_doc_version__: str = "0.0.1"
-__gen_version__: str = "2.884.4"
-__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.884.4 0.0.1 compass_api_sdk"
+__gen_version__: str = "2.884.7"
+__user_agent__: str = "speakeasy-sdk/python 2.0.0 2.884.7 0.0.1 compass_api_sdk"
 
 try:
     if __package__ is not None:

{compass_api_sdk-2.2.53rc2 → compass_api_sdk-2.2.54}/src/compass_api_sdk/global_markets_perps.py

@@ -419,6 +419,220 @@ class GlobalMarketsPerps(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
+    def global_markets_perps_candles(
+        self,
+        *,
+        symbol: str,
+        interval: models.CandleInterval,
+        limit: Optional[int] = None,
+        start_time: OptionalNullable[int] = UNSET,
+        end_time: OptionalNullable[int] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GlobalMarketsPerpsCandlesResponse:
+        r"""Get OHLCV candles
+
+        Return OHLCV candles for a single asset and interval.
+
+        Wraps Hyperliquid's ``candleSnapshot`` info type and adds the xyz: HIP-3 DEX
+        prefix server-side so the SDK only needs the bare ticker (e.g. ``AAPL``).
+        Candle ``time`` is returned in unix seconds, ready for TradingView
+        lightweight-charts. Cached for 15 seconds per (symbol, interval, window).
+
+        :param symbol: Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present.
+        :param interval: Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
+        :param limit: Number of candles to return (max 5000, capped by Hyperliquid).
+        :param start_time: Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval.
+        :param end_time: Optional end of the candle window in unix milliseconds. Defaults to now.
+        :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.V2GlobalMarketsPerpsCandlesRequest(
+            symbol=symbol,
+            interval=interval,
+            limit=limit,
+            start_time=start_time,
+            end_time=end_time,
+        )
+
+        req = self._build_request(
+            method="GET",
+            path="/v2/global_markets_perps/candles",
+            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_global_markets_perps_candles",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+            ),
+            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.GlobalMarketsPerpsCandlesResponse, 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 global_markets_perps_candles_async(
+        self,
+        *,
+        symbol: str,
+        interval: models.CandleInterval,
+        limit: Optional[int] = None,
+        start_time: OptionalNullable[int] = UNSET,
+        end_time: OptionalNullable[int] = UNSET,
+        retries: OptionalNullable[utils.RetryConfig] = UNSET,
+        server_url: Optional[str] = None,
+        timeout_ms: Optional[int] = None,
+        http_headers: Optional[Mapping[str, str]] = None,
+    ) -> models.GlobalMarketsPerpsCandlesResponse:
+        r"""Get OHLCV candles
+
+        Return OHLCV candles for a single asset and interval.
+
+        Wraps Hyperliquid's ``candleSnapshot`` info type and adds the xyz: HIP-3 DEX
+        prefix server-side so the SDK only needs the bare ticker (e.g. ``AAPL``).
+        Candle ``time`` is returned in unix seconds, ready for TradingView
+        lightweight-charts. Cached for 15 seconds per (symbol, interval, window).
+
+        :param symbol: Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present.
+        :param interval: Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w
+        :param limit: Number of candles to return (max 5000, capped by Hyperliquid).
+        :param start_time: Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval.
+        :param end_time: Optional end of the candle window in unix milliseconds. Defaults to now.
+        :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.V2GlobalMarketsPerpsCandlesRequest(
+            symbol=symbol,
+            interval=interval,
+            limit=limit,
+            start_time=start_time,
+            end_time=end_time,
+        )
+
+        req = self._build_request_async(
+            method="GET",
+            path="/v2/global_markets_perps/candles",
+            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_global_markets_perps_candles",
+                oauth2_scopes=None,
+                security_source=self.sdk_configuration.security,
+            ),
+            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.GlobalMarketsPerpsCandlesResponse, 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 global_markets_perps_activity(
         self,
         *,

{compass_api_sdk-2.2.53rc2 → compass_api_sdk-2.2.54}/src/compass_api_sdk/models/__init__.py

@@ -265,6 +265,7 @@ if TYPE_CHECKING:
         BundlerTransactionResponse,
         BundlerTransactionResponseTypedDict,
     )
+    from .candle import Candle, CandleTypedDict
     from .chain import Chain
     from .chaininfo import ChainInfo, ChainInfoTypedDict
     from .chainmarketinfo import ChainMarketInfo, ChainMarketInfoTypedDict
@@ -679,6 +680,10 @@ if TYPE_CHECKING:
         GlobalMarketsPerpsCancelOrderRequest,
         GlobalMarketsPerpsCancelOrderRequestTypedDict,
     )
+    from .globalmarketsperpscandlesresponse import (
+        GlobalMarketsPerpsCandlesResponse,
+        GlobalMarketsPerpsCandlesResponseTypedDict,
+    )
     from .globalmarketsperpscategory import GlobalMarketsPerpsCategory
     from .globalmarketsperpsdepositrequest import (
         GlobalMarketsPerpsDepositRequest,
@@ -1625,6 +1630,11 @@ if TYPE_CHECKING:
         V2GlobalMarketsPerpsActivityRequest,
         V2GlobalMarketsPerpsActivityRequestTypedDict,
     )
+    from .v2_global_markets_perps_candlesop import (
+        CandleInterval,
+        V2GlobalMarketsPerpsCandlesRequest,
+        V2GlobalMarketsPerpsCandlesRequestTypedDict,
+    )
     from .v2_global_markets_perps_opportunitiesop import (
         GlobalMarketsPerpsSortBy,
         GlobalMarketsPerpsSortOrder,
@@ -1904,6 +1914,9 @@ __all__ = [
     "BuilderTypedDict",
     "BundlerTransactionResponse",
     "BundlerTransactionResponseTypedDict",
+    "Candle",
+    "CandleInterval",
+    "CandleTypedDict",
     "Chain",
     "ChainInfo",
     "ChainInfoTypedDict",
@@ -2177,6 +2190,8 @@ __all__ = [
     "GlobalMarketsPerpsBuilderApprovalTypedDict",
     "GlobalMarketsPerpsCancelOrderRequest",
     "GlobalMarketsPerpsCancelOrderRequestTypedDict",
+    "GlobalMarketsPerpsCandlesResponse",
+    "GlobalMarketsPerpsCandlesResponseTypedDict",
     "GlobalMarketsPerpsCategory",
     "GlobalMarketsPerpsDepositRequest",
     "GlobalMarketsPerpsDepositRequestTypedDict",
@@ -2866,6 +2881,8 @@ __all__ = [
     "V2EarnVaultsRequestTypedDict",
     "V2GlobalMarketsPerpsActivityRequest",
     "V2GlobalMarketsPerpsActivityRequestTypedDict",
+    "V2GlobalMarketsPerpsCandlesRequest",
+    "V2GlobalMarketsPerpsCandlesRequestTypedDict",
     "V2GlobalMarketsPerpsOpportunitiesRequest",
     "V2GlobalMarketsPerpsOpportunitiesRequestTypedDict",
     "V2GlobalMarketsPerpsPositionsRequest",
@@ -3125,6 +3142,8 @@ _dynamic_imports: dict[str, str] = {
     "BuilderTypedDict": ".builder",
     "BundlerTransactionResponse": ".bundlertransactionresponse",
     "BundlerTransactionResponseTypedDict": ".bundlertransactionresponse",
+    "Candle": ".candle",
+    "CandleTypedDict": ".candle",
     "Chain": ".chain",
     "ChainInfo": ".chaininfo",
     "ChainInfoTypedDict": ".chaininfo",
@@ -3404,6 +3423,8 @@ _dynamic_imports: dict[str, str] = {
     "GlobalMarketsPerpsBuilderApprovalTypedDict": ".globalmarketsperpsbuilderapproval",
     "GlobalMarketsPerpsCancelOrderRequest": ".globalmarketsperpscancelorderrequest",
     "GlobalMarketsPerpsCancelOrderRequestTypedDict": ".globalmarketsperpscancelorderrequest",
+    "GlobalMarketsPerpsCandlesResponse": ".globalmarketsperpscandlesresponse",
+    "GlobalMarketsPerpsCandlesResponseTypedDict": ".globalmarketsperpscandlesresponse",
     "GlobalMarketsPerpsCategory": ".globalmarketsperpscategory",
     "GlobalMarketsPerpsDepositRequest": ".globalmarketsperpsdepositrequest",
     "GlobalMarketsPerpsDepositRequestTypedDict": ".globalmarketsperpsdepositrequest",
@@ -4075,6 +4096,9 @@ _dynamic_imports: dict[str, str] = {
     "V2EarnVaultsRequestTypedDict": ".v2_earn_vaultsop",
     "V2GlobalMarketsPerpsActivityRequest": ".v2_global_markets_perps_activityop",
     "V2GlobalMarketsPerpsActivityRequestTypedDict": ".v2_global_markets_perps_activityop",
+    "CandleInterval": ".v2_global_markets_perps_candlesop",
+    "V2GlobalMarketsPerpsCandlesRequest": ".v2_global_markets_perps_candlesop",
+    "V2GlobalMarketsPerpsCandlesRequestTypedDict": ".v2_global_markets_perps_candlesop",
     "GlobalMarketsPerpsSortBy": ".v2_global_markets_perps_opportunitiesop",
     "GlobalMarketsPerpsSortOrder": ".v2_global_markets_perps_opportunitiesop",
     "V2GlobalMarketsPerpsOpportunitiesRequest": ".v2_global_markets_perps_opportunitiesop",

compass_api_sdk-2.2.54/src/compass_api_sdk/models/candle.py

@@ -0,0 +1,49 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import BaseModel
+from typing_extensions import TypedDict
+
+
+class CandleTypedDict(TypedDict):
+    r"""A single OHLCV candle."""
+
+    time: int
+    r"""Candle open time as unix seconds (already converted from Hyperliquid's milliseconds — drop-in compatible with TradingView lightweight-charts)."""
+    open: str
+    r"""Open price"""
+    high: str
+    r"""High price"""
+    low: str
+    r"""Low price"""
+    close: str
+    r"""Close price"""
+    volume: str
+    r"""Volume in base asset units"""
+    trades: int
+    r"""Number of trades in this candle"""
+
+
+class Candle(BaseModel):
+    r"""A single OHLCV candle."""
+
+    time: int
+    r"""Candle open time as unix seconds (already converted from Hyperliquid's milliseconds — drop-in compatible with TradingView lightweight-charts)."""
+
+    open: str
+    r"""Open price"""
+
+    high: str
+    r"""High price"""
+
+    low: str
+    r"""Low price"""
+
+    close: str
+    r"""Close price"""
+
+    volume: str
+    r"""Volume in base asset units"""
+
+    trades: int
+    r"""Number of trades in this candle"""

compass_api_sdk-2.2.54/src/compass_api_sdk/models/globalmarketsperpscandlesresponse.py

@@ -0,0 +1,31 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .candle import Candle, CandleTypedDict
+from compass_api_sdk.types import BaseModel
+from typing import List
+from typing_extensions import TypedDict
+
+
+class GlobalMarketsPerpsCandlesResponseTypedDict(TypedDict):
+    r"""OHLCV candle series for a single asset/interval."""
+
+    symbol: str
+    r"""Asset ticker the candles are for (without DEX prefix)"""
+    interval: str
+    r"""Candle interval that was requested"""
+    candles: List[CandleTypedDict]
+    r"""Candles ordered oldest → newest"""
+
+
+class GlobalMarketsPerpsCandlesResponse(BaseModel):
+    r"""OHLCV candle series for a single asset/interval."""
+
+    symbol: str
+    r"""Asset ticker the candles are for (without DEX prefix)"""
+
+    interval: str
+    r"""Candle interval that was requested"""
+
+    candles: List[Candle]
+    r"""Candles ordered oldest → newest"""

compass_api_sdk-2.2.54/src/compass_api_sdk/models/v2_global_markets_perps_candlesop.py

@@ -0,0 +1,96 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from compass_api_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from compass_api_sdk.utils import FieldMetadata, QueryParamMetadata
+from enum import Enum
+from pydantic import model_serializer
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class CandleInterval(str, Enum):
+    r"""Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w"""
+
+    ONEM = "1m"
+    FIVEM = "5m"
+    FIFTEENM = "15m"
+    ONEH = "1h"
+    FOURH = "4h"
+    ONED = "1d"
+    ONEW = "1w"
+
+
+class V2GlobalMarketsPerpsCandlesRequestTypedDict(TypedDict):
+    symbol: str
+    r"""Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present."""
+    interval: CandleInterval
+    r"""Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w"""
+    limit: NotRequired[int]
+    r"""Number of candles to return (max 5000, capped by Hyperliquid)."""
+    start_time: NotRequired[Nullable[int]]
+    r"""Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval."""
+    end_time: NotRequired[Nullable[int]]
+    r"""Optional end of the candle window in unix milliseconds. Defaults to now."""
+
+
+class V2GlobalMarketsPerpsCandlesRequest(BaseModel):
+    symbol: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]
+    r"""Asset ticker (e.g. AAPL, GOLD, EUR). The xyz: HIP-3 DEX prefix is added server-side if not already present."""
+
+    interval: Annotated[
+        CandleInterval,
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ]
+    r"""Candle interval: 1m, 5m, 15m, 1h, 4h, 1d, 1w"""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Number of candles to return (max 5000, capped by Hyperliquid)."""
+
+    start_time: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Optional start of the candle window in unix milliseconds. If omitted, computed as end_time - limit * interval."""
+
+    end_time: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""Optional end of the candle window in unix milliseconds. Defaults to now."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = set(["limit", "start_time", "end_time"])
+        nullable_fields = set(["start_time", "end_time"])
+        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