mt5api 0.2.0__tar.gz → 0.3.0__tar.gz

{mt5api-0.2.0 → mt5api-0.3.0}/.github/workflows/claude.yml

@@ -26,7 +26,7 @@ jobs:
   claude-code-review:
     if: >
       github.event_name == 'pull_request'
-      && github.event.pull_request.draft == false
+      && (! github.event.pull_request.draft)
       && (! startsWith(github.head_ref, 'dependabot/'))
       && (! startsWith(github.head_ref, 'renovate/'))
     permissions:
@@ -37,7 +37,7 @@ jobs:
       actions: read
     uses: dceoy/gh-actions-for-devops/.github/workflows/claude-code-review.yml@main  # zizmor: ignore[unpinned-uses]
     secrets:
-      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}   # zizmor: ignore[secrets-outside-env]
+      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}  # zizmor: ignore[secrets-outside-env]
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   claude-code-bot:
     if: >
@@ -53,5 +53,5 @@ jobs:
       actions: read
     uses: dceoy/gh-actions-for-devops/.github/workflows/claude-code-bot.yml@main  # zizmor: ignore[unpinned-uses]
     secrets:
-      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}   # zizmor: ignore[secrets-outside-env]
+      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}  # zizmor: ignore[secrets-outside-env]
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{mt5api-0.2.0 → mt5api-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mt5api
-Version: 0.2.0
+Version: 0.3.0
 Summary: MetaTrader 5 REST API
 Project-URL: Repository, https://github.com/dceoy/mt5api.git
 Author-email: dceoy <dceoy@users.noreply.github.com>
@@ -18,11 +18,8 @@ Classifier: Topic :: Office/Business :: Financial :: Investment
 Requires-Python: <3.14,>=3.11
 Requires-Dist: fastapi>=0.115.0
 Requires-Dist: httpx>=0.27.0
-Requires-Dist: metatrader5>=5.0.4424; sys_platform == 'win32'
-Requires-Dist: passlib[bcrypt]>=1.7.4
-Requires-Dist: pdmt5>=0.2.1
+Requires-Dist: pdmt5>=0.3.0
 Requires-Dist: pyarrow>=18.0.0
-Requires-Dist: python-jose[cryptography]>=3.3.0
 Requires-Dist: python-multipart>=0.0.9
 Requires-Dist: uvicorn[standard]>=0.32.0
 Description-Content-Type: text/markdown
@@ -34,14 +31,18 @@ MetaTrader 5 REST API
 [![CI/CD](https://github.com/dceoy/mt5api/actions/workflows/ci.yml/badge.svg)](https://github.com/dceoy/mt5api/actions/workflows/ci.yml)
 
 mt5api exposes MT5 market data, account info, trading history, and trading
-operations over HTTP. It uses the [`pdmt5`](https://github.com/dceoy/pdmt5)
-client internally and adds optional API-key auth and JSON/Parquet response
-formatting.
+operations over HTTP. It is a FastAPI/HTTP adapter over
+[`pdmt5`](https://github.com/dceoy/pdmt5), which provides the core MT5 client,
+dataframe/trading primitives, and canonical MT5 constant parsing. mt5api adds
+optional API-key auth and JSON/Parquet response formatting.
 
-The API server must run on Windows. The `MetaTrader5` Python package used by
-`pdmt5` is supported only on Windows, so you must host `mt5api` on a Windows
-machine with a logged-in MetaTrader 5 terminal. HTTP clients can connect from
-any operating system.
+[`mt5cli`](https://github.com/dceoy/mt5cli) is a sibling CLI/batch adapter for
+the same pdmt5 stack; it is not a dependency of mt5api.
+
+The API server must run on Windows. pdmt5 connects through the MetaTrader 5
+Python API, which is supported only on Windows, so you must host `mt5api` on a
+Windows machine with a logged-in MetaTrader 5 terminal. HTTP clients can connect
+from any operating system.
 
 ## Architecture
 
@@ -61,7 +62,7 @@ graph TB
             Formatters --> Middleware
         end
 
-        Deps --> pdmt5["pdmt5<br/>MT5 Client Library"]
+        Deps --> pdmt5["pdmt5<br/>MT5 Client · Constants · Dataframes"]
         pdmt5 --> MT5["MetaTrader 5<br/>Terminal"]
     end
 
@@ -162,9 +163,9 @@ curl -H "X-API-Key: your-secret-api-key" "http://windows-host:8000/symbols?group
 curl -H "X-API-Key: your-secret-api-key" -H "Accept: application/parquet" "http://windows-host:8000/rates/from?symbol=EURUSD&timeframe=TIMEFRAME_M1&date_from=2024-01-01T00:00:00Z&count=100"
 ```
 
-Market-data and calculation endpoints accept MetaTrader 5 constants either by
-official name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`) or by their
-integer value.
+Market-data and calculation endpoints accept MetaTrader 5 constants by official
+name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`), short alias (`M1`,
+`ALL`, `BUY`), or integer value.
 
 ## Endpoints
 

{mt5api-0.2.0 → mt5api-0.3.0}/README.md

@@ -5,14 +5,18 @@ MetaTrader 5 REST API
 [![CI/CD](https://github.com/dceoy/mt5api/actions/workflows/ci.yml/badge.svg)](https://github.com/dceoy/mt5api/actions/workflows/ci.yml)
 
 mt5api exposes MT5 market data, account info, trading history, and trading
-operations over HTTP. It uses the [`pdmt5`](https://github.com/dceoy/pdmt5)
-client internally and adds optional API-key auth and JSON/Parquet response
-formatting.
+operations over HTTP. It is a FastAPI/HTTP adapter over
+[`pdmt5`](https://github.com/dceoy/pdmt5), which provides the core MT5 client,
+dataframe/trading primitives, and canonical MT5 constant parsing. mt5api adds
+optional API-key auth and JSON/Parquet response formatting.
 
-The API server must run on Windows. The `MetaTrader5` Python package used by
-`pdmt5` is supported only on Windows, so you must host `mt5api` on a Windows
-machine with a logged-in MetaTrader 5 terminal. HTTP clients can connect from
-any operating system.
+[`mt5cli`](https://github.com/dceoy/mt5cli) is a sibling CLI/batch adapter for
+the same pdmt5 stack; it is not a dependency of mt5api.
+
+The API server must run on Windows. pdmt5 connects through the MetaTrader 5
+Python API, which is supported only on Windows, so you must host `mt5api` on a
+Windows machine with a logged-in MetaTrader 5 terminal. HTTP clients can connect
+from any operating system.
 
 ## Architecture
 
@@ -32,7 +36,7 @@ graph TB
             Formatters --> Middleware
         end
 
-        Deps --> pdmt5["pdmt5<br/>MT5 Client Library"]
+        Deps --> pdmt5["pdmt5<br/>MT5 Client · Constants · Dataframes"]
         pdmt5 --> MT5["MetaTrader 5<br/>Terminal"]
     end
 
@@ -133,9 +137,9 @@ curl -H "X-API-Key: your-secret-api-key" "http://windows-host:8000/symbols?group
 curl -H "X-API-Key: your-secret-api-key" -H "Accept: application/parquet" "http://windows-host:8000/rates/from?symbol=EURUSD&timeframe=TIMEFRAME_M1&date_from=2024-01-01T00:00:00Z&count=100"
 ```
 
-Market-data and calculation endpoints accept MetaTrader 5 constants either by
-official name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`) or by their
-integer value.
+Market-data and calculation endpoints accept MetaTrader 5 constants by official
+name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`), short alias (`M1`,
+`ALL`, `BUY`), or integer value.
 
 ## Endpoints
 

{mt5api-0.2.0 → mt5api-0.3.0}/docs/api/rest-api.md

@@ -108,9 +108,9 @@ If `MT5API_ROUTER_PREFIX` is configured, prepend it to each API route below.
 
 ### Market Data
 
-- `timeframe` and `flags` accept either the official MetaTrader 5 constant
-  name (for example `TIMEFRAME_M1`, `COPY_TICKS_ALL`) or the equivalent integer
-  value.
+- `timeframe` and `flags` accept the official MetaTrader 5 constant name (for
+  example `TIMEFRAME_M1`, `COPY_TICKS_ALL`), a short alias (for example `M1`,
+  `ALL`), or the equivalent integer value.
 - `GET /rates/from` (`symbol`, `timeframe`, `date_from`, `count`, `format`)
 - `GET /rates/from-pos` (`symbol`, `timeframe`, `start_pos`, `count`, `format`)
 - `GET /rates/range` (`symbol`, `timeframe`, `date_from`, `date_to`, `format`)
@@ -122,8 +122,9 @@ If `MT5API_ROUTER_PREFIX` is configured, prepend it to each API route below.
 
 ### Calculations
 
-- `action` accepts either the official MetaTrader 5 constant name (for example
-  `ORDER_TYPE_BUY`) or the equivalent integer value.
+- `action` accepts the official MetaTrader 5 constant name (for example
+  `ORDER_TYPE_BUY`), a short alias (for example `BUY`), or the equivalent
+  integer value.
 - `GET /calc/margin` (`action`, `symbol`, `volume`, `price`, `format`) —
   Calculate required margin in account currency
 - `GET /calc/profit` (`action`, `symbol`, `volume`, `price_open`,

{mt5api-0.2.0 → mt5api-0.3.0}/docs/index.md

@@ -5,14 +5,18 @@ trading operations.
 
 ## Overview
 
-mt5api exposes MT5 data and trading operations over HTTP using FastAPI. It
-relies on the underlying MT5 client library for connectivity and adds optional
-authentication and response formatting suitable for analytics
-workflows.
-
-The API server must run on Windows because the `MetaTrader5` Python package is
-Windows-only. Run `mt5api` on a Windows host with MetaTrader 5 installed and
-logged in. API clients can connect from any operating system.
+mt5api is a FastAPI/HTTP adapter over
+[`pdmt5`](https://github.com/dceoy/pdmt5). pdmt5 provides the core MT5 client,
+dataframe/trading primitives, and canonical MT5 constant parsing. mt5api adds
+optional authentication, response formatting, and OpenAPI documentation.
+
+[`mt5cli`](https://github.com/dceoy/mt5cli) is a sibling CLI/batch adapter for
+the same pdmt5 stack; it is not a dependency of mt5api.
+
+The API server must run on Windows because pdmt5 connects through the MetaTrader
+5 Python API, which is Windows-only. Run `mt5api` on a Windows host with
+MetaTrader 5 installed and logged in. API clients can connect from any operating
+system.
 
 ## Features
 

{mt5api-0.2.0 → mt5api-0.3.0}/mt5api/models.py

@@ -2,13 +2,11 @@
 
 from __future__ import annotations
 
-from dataclasses import dataclass
 from datetime import datetime  # noqa: TC003
 from enum import StrEnum
-from functools import cache, cached_property
-from typing import TYPE_CHECKING, Annotated, Any, LiteralString, Self, TypeAlias, cast
+from typing import Annotated, Any, Self, TypeAlias
 
-from pdmt5.mt5 import Mt5Client
+import pdmt5
 from pydantic import (
     BaseModel,
     BeforeValidator,
@@ -18,23 +16,10 @@ from pydantic import (
     WithJsonSchema,
     model_validator,
 )
-from pydantic_core import PydanticCustomError
-
-if TYPE_CHECKING:
-    from collections.abc import Callable
-    from types import ModuleType
-
-
-class ResponseFormat(StrEnum):
-    """Response format enumeration."""
-
-    JSON = "json"
-    PARQUET = "parquet"
-
 
 _TIMEFRAME_DESCRIPTION = (
     "MetaTrader5 TIMEFRAME constant. Accepts a constant name such as "
-    "TIMEFRAME_M1 or the corresponding integer value."
+    "TIMEFRAME_M1, short aliases such as M1, or the corresponding integer value."
 )
 _TIMEFRAME_EXAMPLE_NAMES = (
     "TIMEFRAME_M1",
@@ -49,142 +34,22 @@ _TIMEFRAME_EXAMPLE_NAMES = (
 )
 _COPY_TICKS_DESCRIPTION = (
     "MetaTrader5 COPY_TICKS constant. Accepts COPY_TICKS_INFO, "
-    "COPY_TICKS_TRADE, COPY_TICKS_ALL, or the corresponding integer value."
+    "COPY_TICKS_TRADE, COPY_TICKS_ALL, short aliases such as ALL, "
+    "or the corresponding integer value."
 )
-_COPY_TICKS_NAMES = (
+_COPY_TICKS_EXAMPLE_NAMES = (
     "COPY_TICKS_INFO",
     "COPY_TICKS_TRADE",
     "COPY_TICKS_ALL",
 )
 _ORDER_TYPE_DESCRIPTION = (
     "MetaTrader5 ORDER_TYPE constant. Accepts a constant name such as "
-    "ORDER_TYPE_BUY or the corresponding integer value."
+    "ORDER_TYPE_BUY, short aliases such as BUY, or the corresponding integer value."
 )
 _ORDER_TYPE_EXAMPLE_NAMES = (
     "ORDER_TYPE_BUY",
     "ORDER_TYPE_SELL",
 )
-_ORDER_TYPE_VALIDATION_DESCRIPTION = "MetaTrader5 ORDER_TYPE constant"
-_TIMEFRAME_VALIDATION_DESCRIPTION = "MetaTrader5 TIMEFRAME constant"
-_COPY_TICKS_VALIDATION_DESCRIPTION = "MetaTrader5 COPY_TICKS constant"
-
-
-@dataclass(frozen=True)
-class Mt5ConstantSpec:
-    """Metadata and cached values for an MT5 constant family."""
-
-    validation_description: str
-    schema_description: str
-    prefix: str = ""
-    names: tuple[str, ...] = ()
-    example_names: tuple[str, ...] = ()
-
-    @cached_property
-    def members(self) -> dict[str, int]:
-        """Return MT5 constant names and values from the pdmt5 MT5 module copy."""
-        mt5 = _get_mt5_module()
-        if self.names:
-            return {name: int(getattr(mt5, name)) for name in self.names}
-        return {
-            name: int(getattr(mt5, name))
-            for name in dir(mt5)
-            if name.startswith(self.prefix) and isinstance(getattr(mt5, name), int)
-        }
-
-    @cached_property
-    def sorted_names(self) -> tuple[str, ...]:
-        """Return sorted MT5 constant names."""
-        return tuple(sorted(self.members))
-
-    @cached_property
-    def sorted_values(self) -> tuple[int, ...]:
-        """Return sorted MT5 constant values."""
-        return tuple(sorted(self.members.values()))
-
-    @cached_property
-    def example_values(self) -> list[int]:
-        """Return MT5 constant value examples."""
-        return [self.members[name] for name in self.example_names]
-
-    @cached_property
-    def example_name_list(self) -> list[str]:
-        """Return MT5 constant name examples."""
-        return list(self.example_names)
-
-
-@cache
-def _get_mt5_module() -> ModuleType:
-    """Return the MetaTrader5 module used by pdmt5."""
-    factory = cast(
-        "Callable[[], ModuleType]", Mt5Client.model_fields["mt5"].default_factory
-    )
-    return factory()
-
-
-_TIMEFRAME_SPEC = Mt5ConstantSpec(
-    validation_description=_TIMEFRAME_VALIDATION_DESCRIPTION,
-    schema_description=_TIMEFRAME_DESCRIPTION,
-    prefix="TIMEFRAME_",
-    example_names=_TIMEFRAME_EXAMPLE_NAMES,
-)
-_COPY_TICKS_SPEC = Mt5ConstantSpec(
-    validation_description=_COPY_TICKS_VALIDATION_DESCRIPTION,
-    schema_description=_COPY_TICKS_DESCRIPTION,
-    names=_COPY_TICKS_NAMES,
-    example_names=_COPY_TICKS_NAMES,
-)
-_ORDER_TYPE_SPEC = Mt5ConstantSpec(
-    validation_description=_ORDER_TYPE_VALIDATION_DESCRIPTION,
-    schema_description=_ORDER_TYPE_DESCRIPTION,
-    prefix="ORDER_TYPE_",
-    example_names=_ORDER_TYPE_EXAMPLE_NAMES,
-)
-
-
-def _parse_mt5_constant(
-    value: object,
-    *,
-    spec: Mt5ConstantSpec,
-) -> int:
-    """Parse an MT5 constant name or integer value.
-
-    Returns:
-        The validated integer constant value.
-
-    Raises:
-        PydanticCustomError: If the value type is not supported.
-        ValueError: If the value is not a supported constant name or integer.
-    """
-    type_error_code = "mt5_constant_type"
-    type_error_template: LiteralString = (
-        "{description} must be specified by constant name or integer value"
-    )
-    type_error_context = {"description": spec.validation_description}
-    type_error_message = type_error_template.format(**type_error_context)
-    if isinstance(value, str):
-        if value in spec.members:
-            return spec.members[value]
-        try:
-            value = int(value)
-        except ValueError as error:
-            raise ValueError(type_error_message) from error
-
-    if isinstance(value, bool) or not isinstance(value, int):
-        raise PydanticCustomError(
-            type_error_code,
-            type_error_template,
-            type_error_context,
-        )
-
-    parsed_value = value
-
-    if parsed_value not in spec.members.values():
-        error_message = (
-            f"Unsupported {spec.validation_description.lower()} value: {parsed_value}"
-        )
-        raise ValueError(error_message)
-
-    return parsed_value
 
 
 def _build_mt5_constant_json_schema(
@@ -210,43 +75,43 @@ def _build_mt5_constant_json_schema(
 
 
 def get_mt5_timeframe_values() -> tuple[int, ...]:
-    """Return all available MT5 timeframe values from the pdmt5 MT5 module copy."""
-    return _TIMEFRAME_SPEC.sorted_values
+    """Return all available MT5 timeframe values from pdmt5."""
+    return tuple(pdmt5.list_timeframe_values())
 
 
 def get_mt5_timeframe_names() -> tuple[str, ...]:
-    """Return all available MT5 timeframe names from the pdmt5 MT5 module copy."""
-    return _TIMEFRAME_SPEC.sorted_names
+    """Return all available MT5 timeframe names from pdmt5."""
+    return tuple(pdmt5.list_timeframe_names())
 
 
 def get_mt5_timeframe_examples() -> list[int]:
-    """Return common MT5 timeframe examples from the pdmt5 MT5 module copy."""
-    return _TIMEFRAME_SPEC.example_values
+    """Return common MT5 timeframe examples from pdmt5."""
+    return [pdmt5.TIMEFRAME_MAP[name] for name in _TIMEFRAME_EXAMPLE_NAMES]
 
 
 def get_mt5_timeframe_example_names() -> list[str]:
     """Return common MT5 timeframe example names."""
-    return _TIMEFRAME_SPEC.example_name_list
+    return list(_TIMEFRAME_EXAMPLE_NAMES)
 
 
 def get_mt5_copy_ticks_values() -> tuple[int, ...]:
-    """Return all MT5 COPY_TICKS values from the pdmt5 MT5 module copy."""
-    return _COPY_TICKS_SPEC.sorted_values
+    """Return all MT5 COPY_TICKS values from pdmt5."""
+    return tuple(pdmt5.list_copy_ticks_values())
 
 
 def get_mt5_copy_ticks_names() -> tuple[str, ...]:
-    """Return all MT5 COPY_TICKS names from the pdmt5 MT5 module copy."""
-    return _COPY_TICKS_SPEC.sorted_names
+    """Return all MT5 COPY_TICKS names from pdmt5."""
+    return tuple(pdmt5.list_copy_ticks_names())
 
 
 def get_mt5_copy_ticks_examples() -> list[int]:
     """Return common MT5 COPY_TICKS integer examples."""
-    return _COPY_TICKS_SPEC.example_values
+    return [pdmt5.COPY_TICKS_MAP[name] for name in _COPY_TICKS_EXAMPLE_NAMES]
 
 
 def get_mt5_copy_ticks_example_names() -> list[str]:
     """Return common MT5 COPY_TICKS example names."""
-    return _COPY_TICKS_SPEC.example_name_list
+    return list(_COPY_TICKS_EXAMPLE_NAMES)
 
 
 def _validate_mt5_timeframe(value: object) -> int:
@@ -255,7 +120,7 @@ def _validate_mt5_timeframe(value: object) -> int:
     Returns:
         The validated integer timeframe value.
     """
-    return _parse_mt5_constant(value, spec=_TIMEFRAME_SPEC)
+    return pdmt5.parse_timeframe(value)
 
 
 def _validate_mt5_copy_ticks(value: object) -> int:
@@ -264,27 +129,27 @@ def _validate_mt5_copy_ticks(value: object) -> int:
     Returns:
         The validated integer COPY_TICKS value.
     """
-    return _parse_mt5_constant(value, spec=_COPY_TICKS_SPEC)
+    return pdmt5.parse_copy_ticks(value)
 
 
 def get_mt5_order_type_values() -> tuple[int, ...]:
-    """Return all available MT5 ORDER_TYPE values from the pdmt5 MT5 module copy."""
-    return _ORDER_TYPE_SPEC.sorted_values
+    """Return all available MT5 ORDER_TYPE values from pdmt5."""
+    return tuple(pdmt5.list_order_type_values())
 
 
 def get_mt5_order_type_names() -> tuple[str, ...]:
-    """Return all available MT5 ORDER_TYPE names from the pdmt5 MT5 module copy."""
-    return _ORDER_TYPE_SPEC.sorted_names
+    """Return all available MT5 ORDER_TYPE names from pdmt5."""
+    return tuple(pdmt5.list_order_type_names())
 
 
 def get_mt5_order_type_examples() -> list[int]:
     """Return common MT5 ORDER_TYPE integer examples."""
-    return _ORDER_TYPE_SPEC.example_values
+    return [pdmt5.ORDER_TYPE_MAP[name] for name in _ORDER_TYPE_EXAMPLE_NAMES]
 
 
 def get_mt5_order_type_example_names() -> list[str]:
     """Return common MT5 ORDER_TYPE example names."""
-    return _ORDER_TYPE_SPEC.example_name_list
+    return list(_ORDER_TYPE_EXAMPLE_NAMES)
 
 
 def _validate_mt5_order_type(value: object) -> int:
@@ -293,7 +158,7 @@ def _validate_mt5_order_type(value: object) -> int:
     Returns:
         The validated integer ORDER_TYPE value.
     """
-    return _parse_mt5_constant(value, spec=_ORDER_TYPE_SPEC)
+    return pdmt5.parse_order_type(value)
 
 
 Mt5Timeframe: TypeAlias = Annotated[
@@ -301,7 +166,7 @@ Mt5Timeframe: TypeAlias = Annotated[
     BeforeValidator(_validate_mt5_timeframe),
     WithJsonSchema(
         _build_mt5_constant_json_schema(
-            description=_TIMEFRAME_SPEC.schema_description,
+            description=_TIMEFRAME_DESCRIPTION,
             names=get_mt5_timeframe_names(),
             values=get_mt5_timeframe_values(),
             examples=get_mt5_timeframe_example_names(),
@@ -316,7 +181,7 @@ Mt5CopyTicks: TypeAlias = Annotated[
     BeforeValidator(_validate_mt5_copy_ticks),
     WithJsonSchema(
         _build_mt5_constant_json_schema(
-            description=_COPY_TICKS_SPEC.schema_description,
+            description=_COPY_TICKS_DESCRIPTION,
             names=get_mt5_copy_ticks_names(),
             values=get_mt5_copy_ticks_values(),
             examples=get_mt5_copy_ticks_example_names(),
@@ -331,7 +196,7 @@ Mt5OrderType: TypeAlias = Annotated[
     BeforeValidator(_validate_mt5_order_type),
     WithJsonSchema(
         _build_mt5_constant_json_schema(
-            description=_ORDER_TYPE_SPEC.schema_description,
+            description=_ORDER_TYPE_DESCRIPTION,
             names=get_mt5_order_type_names(),
             values=get_mt5_order_type_values(),
             examples=get_mt5_order_type_example_names(),
@@ -341,6 +206,13 @@ Mt5OrderType: TypeAlias = Annotated[
 ]
 
 
+class ResponseFormat(StrEnum):
+    """Response format enumeration."""
+
+    JSON = "json"
+    PARQUET = "parquet"
+
+
 class ErrorResponse(BaseModel):
     """RFC 7807 Problem Details error response model."""
 
@@ -532,7 +404,7 @@ class TicksFromRequest(BaseModel):
         le=100000,
     )
     flags: Mt5CopyTicks = Field(
-        default=_COPY_TICKS_SPEC.members["COPY_TICKS_ALL"],
+        default=pdmt5.COPY_TICKS_MAP["COPY_TICKS_ALL"],
         description=_COPY_TICKS_DESCRIPTION,
     )
     format: ResponseFormat | None = Field(default=None)
@@ -545,7 +417,7 @@ class TicksRangeRequest(BaseModel):
     date_from: datetime = Field(..., description="Start date (ISO 8601)")
     date_to: datetime = Field(..., description="End date (ISO 8601)")
     flags: Mt5CopyTicks = Field(
-        default=_COPY_TICKS_SPEC.members["COPY_TICKS_ALL"],
+        default=pdmt5.COPY_TICKS_MAP["COPY_TICKS_ALL"],
         description=_COPY_TICKS_DESCRIPTION,
     )
     format: ResponseFormat | None = Field(default=None)

{mt5api-0.2.0 → mt5api-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mt5api"
-version = "0.2.0"
+version = "0.3.0"
 description = "MetaTrader 5 REST API"
 authors = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]
 maintainers = [{name = "dceoy", email = "dceoy@users.noreply.github.com"}]
@@ -9,14 +9,11 @@ license-files = ["LICENSE"]
 readme = "README.md"
 requires-python = ">= 3.11, < 3.14"
 dependencies = [
-  "MetaTrader5 >= 5.0.4424; sys_platform == 'win32'",
-  "pdmt5 >= 0.2.1",
+  "pdmt5 >= 0.3.0",
   "fastapi >= 0.115.0",
   "uvicorn[standard] >= 0.32.0",
   "pyarrow >= 18.0.0",
   "python-multipart >= 0.0.9",
-  "python-jose[cryptography] >= 3.3.0",
-  "passlib[bcrypt] >= 1.7.4",
   "httpx >= 0.27.0",
 ]
 classifiers = [

{mt5api-0.2.0 → mt5api-0.3.0}/tests/mt5_constants.py

@@ -36,7 +36,7 @@ class Mt5CopyTicks(IntEnum):
 
     COPY_TICKS_INFO = 1
     COPY_TICKS_TRADE = 2
-    COPY_TICKS_ALL = 3
+    COPY_TICKS_ALL = -1
 
 
 class Mt5BookType(IntEnum):

mt5api-0.3.0/tests/openapi_mt5_constants.py

@@ -0,0 +1,34 @@
+"""Shared OpenAPI schema assertions for MT5 constant metadata."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from mt5api.models import (
+    get_mt5_order_type_example_names,
+    get_mt5_order_type_names,
+    get_mt5_order_type_values,
+)
+
+ORDER_TYPE_DESCRIPTION = (
+    "MetaTrader5 ORDER_TYPE constant. Accepts a constant name such as "
+    "ORDER_TYPE_BUY, short aliases such as BUY, or the corresponding integer value."
+)
+VALID_ORDER_TYPE_NAMES = list(get_mt5_order_type_names())
+VALID_ORDER_TYPE_VALUES = list(get_mt5_order_type_values())
+ORDER_TYPE_EXAMPLES = get_mt5_order_type_example_names()
+
+
+def assert_openapi_mt5_order_type_schema(schema: dict[str, Any]) -> None:
+    """Assert an OpenAPI schema documents ORDER_TYPE names, values, and examples."""
+    string_schema = next(
+        member for member in schema["anyOf"] if member["type"] == "string"
+    )
+    integer_schema = next(
+        member for member in schema["anyOf"] if member["type"] == "integer"
+    )
+
+    assert sorted(string_schema["enum"]) == sorted(VALID_ORDER_TYPE_NAMES)
+    assert sorted(integer_schema["enum"]) == sorted(VALID_ORDER_TYPE_VALUES)
+    assert schema["examples"] == ORDER_TYPE_EXAMPLES
+    assert schema["description"] == ORDER_TYPE_DESCRIPTION

{mt5api-0.2.0 → mt5api-0.3.0}/tests/test_calc.py

@@ -8,6 +8,7 @@ import pytest
 from pdmt5.mt5 import Mt5RuntimeError
 
 from tests.mt5_constants import Mt5OrderType
+from tests.openapi_mt5_constants import assert_openapi_mt5_order_type_schema
 
 if TYPE_CHECKING:
     from unittest.mock import Mock
@@ -294,3 +295,18 @@ def test_get_calc_profit_returns_service_unavailable_on_mt5_error(
     payload = response.json()
     assert payload["title"] == "MT5 Terminal Error"
     assert "order_calc_profit returned None" in payload["detail"]
+
+
+def test_openapi_documents_mt5_order_type_consistently(
+    client: TestClient,
+) -> None:
+    """Calc endpoints should expose MT5 ORDER_TYPE names and integer values."""
+    openapi = client.get("/openapi.json").json()
+    paths = ("/calc/margin", "/calc/profit")
+
+    for path in paths:
+        parameters = openapi["paths"][path]["get"]["parameters"]
+        action_parameter = next(
+            parameter for parameter in parameters if parameter["name"] == "action"
+        )
+        assert_openapi_mt5_order_type_schema(action_parameter["schema"])