kalshi-python-async 3.0.0__py3-none-any.whl

kalshi_python_async/models/market_candlesticks_response.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from kalshi_python_async.models.market_candlestick import MarketCandlestick
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MarketCandlesticksResponse(BaseModel):
+    """
+    MarketCandlesticksResponse
+    """ # noqa: E501
+    market_ticker: StrictStr = Field(description="Market ticker string (e.g., 'INXD-24JAN01').")
+    candlesticks: List[MarketCandlestick] = Field(description="Array of candlestick data points for the market. Includes an initial data point at the start timestamp when available.")
+    __properties: ClassVar[List[str]] = ["market_ticker", "candlesticks"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MarketCandlesticksResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in candlesticks (list)
+        _items = []
+        if self.candlesticks:
+            for _item_candlesticks in self.candlesticks:
+                if _item_candlesticks:
+                    _items.append(_item_candlesticks.to_dict())
+            _dict['candlesticks'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MarketCandlesticksResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "market_ticker": obj.get("market_ticker"),
+            "candlesticks": [MarketCandlestick.from_dict(_item) for _item in obj["candlesticks"]] if obj.get("candlesticks") is not None else None
+        })
+        return _obj
+
+

kalshi_python_async/models/market_metadata.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MarketMetadata(BaseModel):
+    """
+    MarketMetadata
+    """ # noqa: E501
+    market_ticker: StrictStr = Field(description="The ticker of the market.")
+    image_url: StrictStr = Field(description="A path to an image that represents this market.")
+    color_code: StrictStr = Field(description="The color code for the market.")
+    __properties: ClassVar[List[str]] = ["market_ticker", "image_url", "color_code"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MarketMetadata from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MarketMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "market_ticker": obj.get("market_ticker"),
+            "image_url": obj.get("image_url"),
+            "color_code": obj.get("color_code")
+        })
+        return _obj
+
+

kalshi_python_async/models/market_position.py

@@ -0,0 +1,110 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MarketPosition(BaseModel):
+    """
+    MarketPosition
+    """ # noqa: E501
+    ticker: StrictStr = Field(description="Unique identifier for the market")
+    total_traded: StrictInt = Field(description="Total spent on this market in cents")
+    total_traded_dollars: StrictStr = Field(description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    position: StrictInt = Field(description="Number of contracts bought in this market. Negative means NO contracts and positive means YES contracts")
+    market_exposure: StrictInt = Field(description="Cost of the aggregate market position in cents")
+    market_exposure_dollars: StrictStr = Field(description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    realized_pnl: StrictInt = Field(description="Locked in profit and loss, in cents")
+    realized_pnl_dollars: StrictStr = Field(description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    resting_orders_count: StrictInt = Field(description="[DEPRECATED] Aggregate size of resting orders in contract units")
+    fees_paid: StrictInt = Field(description="Fees paid on fill orders, in cents")
+    fees_paid_dollars: StrictStr = Field(description="US dollar amount as a fixed-point decimal string with exactly 4 decimal places")
+    last_updated_ts: Optional[datetime] = Field(default=None, description="Last time the position is updated")
+    __properties: ClassVar[List[str]] = ["ticker", "total_traded", "total_traded_dollars", "position", "market_exposure", "market_exposure_dollars", "realized_pnl", "realized_pnl_dollars", "resting_orders_count", "fees_paid", "fees_paid_dollars", "last_updated_ts"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MarketPosition from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MarketPosition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ticker": obj.get("ticker"),
+            "total_traded": obj.get("total_traded"),
+            "total_traded_dollars": obj.get("total_traded_dollars"),
+            "position": obj.get("position"),
+            "market_exposure": obj.get("market_exposure"),
+            "market_exposure_dollars": obj.get("market_exposure_dollars"),
+            "realized_pnl": obj.get("realized_pnl"),
+            "realized_pnl_dollars": obj.get("realized_pnl_dollars"),
+            "resting_orders_count": obj.get("resting_orders_count"),
+            "fees_paid": obj.get("fees_paid"),
+            "fees_paid_dollars": obj.get("fees_paid_dollars"),
+            "last_updated_ts": obj.get("last_updated_ts")
+        })
+        return _obj
+
+

kalshi_python_async/models/milestone.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Milestone(BaseModel):
+    """
+    Milestone
+    """ # noqa: E501
+    id: StrictStr = Field(description="Unique identifier for the milestone.")
+    category: StrictStr = Field(description="Category of the milestone.")
+    type: StrictStr = Field(description="Type of the milestone.")
+    start_date: datetime = Field(description="Start date of the milestone.")
+    end_date: Optional[datetime] = Field(default=None, description="End date of the milestone, if any.")
+    related_event_tickers: List[StrictStr] = Field(description="List of event tickers related to this milestone.")
+    title: StrictStr = Field(description="Title of the milestone.")
+    notification_message: StrictStr = Field(description="Notification message for the milestone.")
+    source_id: Optional[StrictStr] = Field(default=None, description="Source id of milestone if available.")
+    details: Dict[str, Any] = Field(description="Additional details about the milestone.")
+    primary_event_tickers: List[StrictStr] = Field(description="List of event tickers directly related to the outcome of this milestone.")
+    last_updated_ts: datetime = Field(description="Last time this structured target was updated.")
+    __properties: ClassVar[List[str]] = ["id", "category", "type", "start_date", "end_date", "related_event_tickers", "title", "notification_message", "source_id", "details", "primary_event_tickers", "last_updated_ts"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Milestone from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if end_date (nullable) is None
+        # and model_fields_set contains the field
+        if self.end_date is None and "end_date" in self.model_fields_set:
+            _dict['end_date'] = None
+
+        # set to None if source_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.source_id is None and "source_id" in self.model_fields_set:
+            _dict['source_id'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Milestone from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "category": obj.get("category"),
+            "type": obj.get("type"),
+            "start_date": obj.get("start_date"),
+            "end_date": obj.get("end_date"),
+            "related_event_tickers": obj.get("related_event_tickers"),
+            "title": obj.get("title"),
+            "notification_message": obj.get("notification_message"),
+            "source_id": obj.get("source_id"),
+            "details": obj.get("details"),
+            "primary_event_tickers": obj.get("primary_event_tickers"),
+            "last_updated_ts": obj.get("last_updated_ts")
+        })
+        return _obj
+
+

kalshi_python_async/models/multivariate_event_collection.py

@@ -0,0 +1,122 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from kalshi_python_async.models.associated_event import AssociatedEvent
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MultivariateEventCollection(BaseModel):
+    """
+    MultivariateEventCollection
+    """ # noqa: E501
+    collection_ticker: StrictStr = Field(description="Unique identifier for the collection.")
+    series_ticker: StrictStr = Field(description="Series associated with the collection. Events produced in the collection will be associated with this series.")
+    title: StrictStr = Field(description="Title of the collection.")
+    description: StrictStr = Field(description="Short description of the collection.")
+    open_date: datetime = Field(description="The open date of the collection. Before this time, the collection cannot be interacted with.")
+    close_date: datetime = Field(description="The close date of the collection. After this time, the collection cannot be interacted with.")
+    associated_events: List[AssociatedEvent] = Field(description="List of events with their individual configuration.")
+    associated_event_tickers: List[StrictStr] = Field(description="[DEPRECATED - Use associated_events instead] A list of events associated with the collection. Markets in these events can be passed as inputs to the Lookup and Create endpoints.")
+    is_ordered: StrictBool = Field(description="Whether the collection is ordered. If true, the order of markets passed into Lookup/Create affects the output. If false, the order does not matter.")
+    is_single_market_per_event: StrictBool = Field(description="[DEPRECATED - Use associated_events instead] Whether the collection accepts multiple markets from the same event passed into Lookup/Create.")
+    is_all_yes: StrictBool = Field(description="[DEPRECATED - Use associated_events instead] Whether the collection requires that only the market side of 'yes' may be used.")
+    size_min: StrictInt = Field(description="The minimum number of markets that must be passed into Lookup/Create (inclusive).")
+    size_max: StrictInt = Field(description="The maximum number of markets that must be passed into Lookup/Create (inclusive).")
+    functional_description: StrictStr = Field(description="A functional description of the collection describing how inputs affect the output.")
+    __properties: ClassVar[List[str]] = ["collection_ticker", "series_ticker", "title", "description", "open_date", "close_date", "associated_events", "associated_event_tickers", "is_ordered", "is_single_market_per_event", "is_all_yes", "size_min", "size_max", "functional_description"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MultivariateEventCollection from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in associated_events (list)
+        _items = []
+        if self.associated_events:
+            for _item_associated_events in self.associated_events:
+                if _item_associated_events:
+                    _items.append(_item_associated_events.to_dict())
+            _dict['associated_events'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MultivariateEventCollection from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "collection_ticker": obj.get("collection_ticker"),
+            "series_ticker": obj.get("series_ticker"),
+            "title": obj.get("title"),
+            "description": obj.get("description"),
+            "open_date": obj.get("open_date"),
+            "close_date": obj.get("close_date"),
+            "associated_events": [AssociatedEvent.from_dict(_item) for _item in obj["associated_events"]] if obj.get("associated_events") is not None else None,
+            "associated_event_tickers": obj.get("associated_event_tickers"),
+            "is_ordered": obj.get("is_ordered"),
+            "is_single_market_per_event": obj.get("is_single_market_per_event"),
+            "is_all_yes": obj.get("is_all_yes"),
+            "size_min": obj.get("size_min"),
+            "size_max": obj.get("size_max"),
+            "functional_description": obj.get("functional_description")
+        })
+        return _obj
+
+

kalshi_python_async/models/mve_selected_leg.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    Kalshi Trade API Manual Endpoints
+
+    Manually defined OpenAPI spec for endpoints being migrated to spec-first approach
+
+    The version of the OpenAPI document: 3.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MveSelectedLeg(BaseModel):
+    """
+    MveSelectedLeg
+    """ # noqa: E501
+    event_ticker: Optional[StrictStr] = Field(default=None, description="Unique identifier for the selected event")
+    market_ticker: Optional[StrictStr] = Field(default=None, description="Unique identifier for the selected market")
+    side: Optional[StrictStr] = Field(default=None, description="The side of the selected market")
+    __properties: ClassVar[List[str]] = ["event_ticker", "market_ticker", "side"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of MveSelectedLeg from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MveSelectedLeg from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "event_ticker": obj.get("event_ticker"),
+            "market_ticker": obj.get("market_ticker"),
+            "side": obj.get("side")
+        })
+        return _obj
+
+