gmo-fx 0.1.0__py3-none-any.whl

gmo_fx/__init__.py

@@ -0,0 +1,8 @@
+from .errors import *
+from .klines import *
+from .response import *
+from .status import *
+from .symbols import *
+from .ticker import *
+
+__version__ = "0.1.0"

gmo_fx/errors.py

@@ -0,0 +1,76 @@
+from typing import Optional
+
+
+class ApiError(Exception):
+    error_code: str
+
+    __ERR_MAP = {
+        "ERR-143": "規制中のため取引できません。",
+        "ERR-148": "IFD、IFDOCO注文において決済注文数量が新規注文数量を超えています。",
+        "ERR-189": "決済注文において、決済可能保有数量を超えての数量は注文できません。",
+        "ERR-200": "すでに有効注文があり、注文数量が発注可能な数量を超えています。決済注文を行いたい場合は、注文数量を変更するか、有効注文を取消したうえで、再度注文をしてください。",
+        "ERR-201": "取引余力が不足しています。",
+        "ERR-254": "指定された建玉が存在しません。",
+        "ERR-414": "決済注文において指定した銘柄と指定した建玉IDの銘柄が異なっています。",
+        "ERR-423": "決済注文において注文数量が(指定した建玉、もしくは指定銘柄の建玉の)総建玉数量よりも大きい、もしくは総有効注文数量との合計が総建玉数量よりも大きいです。",
+        "ERR-512": "決済注文において同じ建玉IDが2つ以上指定されました。",
+        "ERR-542": "OCO注文変更においてOCO注文以外の親注文IDや顧客注文IDが指定されました。",
+        "ERR-595": "IFD、IFDOCO注文変更においてIFD、IFDOCO注文以外の親注文IDや顧客注文IDが指定されました。",
+        "ERR-635": "有効注文の件数が上限に達しています。新規の注文をするためには、有効注文を取消したうえで、再度注文をしてください。",
+        "ERR-759": "建玉の件数が上限に達している場合、新規注文は行えません。",
+        "ERR-760": "注文変更において変更前と後で注文レートが同じです。",
+        "ERR-761": "指定可能な注文レートの範囲を超えています。",
+        "ERR-769": "注文変更において変更元となる注文の有効期限が切れています。",
+        "ERR-786": "設定した顧客注文IDがご自身の他の有効注文に使用されています。",
+        "ERR-5003": "API呼出上限を越えています。",
+        "ERR-5008": "リクエストヘッダーに設定されているAPI-TIMESTAMPが公開APIのシステム時刻より遅いです。システム時間の更新をお試しください。",
+        "ERR-5009": "リクエストヘッダーに設定されているAPI-TIMESTAMPが公開APIのシステム時刻より早いです。システム時間の更新をお試しください。",
+        "ERR-5010": "リクエストヘッダーに指定されているAPI-SIGN（Signature）に不正があります。認証情報についてご確認ください。",
+        "ERR-5011": "リクエストヘッダーにAPI-KEYが設定されていません。認証情報についてご確認ください。",
+        "ERR-5012": "API-KEYの認証エラーが発生しました。",
+        "ERR-5014": "お客様のご確認、ご同意が必要な処理を実行する際に、お客様に未確認・未同意事項がありました。",
+        "ERR-5106": "パラメーターが不正です。",
+        "ERR-5114": "注文レートが呼値の単位を超えています。取引ルールの呼値をご確認ください。取引ルールは以下よりご確認いただけます。\nhttps://coin.z.com/jp/corp/product/info/fx/?=rule",
+        "ERR-5122": "指定された注文がすでに変更中、取消中、取消済、全量約定、失効のいずれかの状態であるため、注文の変更や取消ができません。",
+        "ERR-5123": "指定された注文番号が存在しません。",
+        "ERR-5125": "APIの取引規制がかかっています。",
+        "ERR-5126": "1回あたりの最大注文数量を超えているもしくは最小注文数量を下回っている、または最大建玉数量を超過しています。以下より取引ルールをご確認ください。\nhttps://coin.z.com/jp/corp/product/info/fx/?=rule",
+        "ERR-5130": "注文情報取得もしくは約定情報取得において指定した注文IDもしくは親注文IDが最大指定数量を超えています。",
+        "ERR-5132": "約定情報取得において指定した約定IDが最大指定数量を超えています。",
+        "ERR-5201": "定期メンテナンス中です。",
+        "ERR-5202": "緊急メンテナンス中です。",
+        "ERR-5204": "APIのURLが不正です。",
+        "ERR-5206": "注文変更を実行時に注文毎の変更可能回数が上限に達しています。上限に達して更に注文変更を行いたい場合は、1度注文キャンセルをしてから新規に注文をしていただくようにお願い致します。",
+        "ERR-5207": "リクエストボディに指定されているsymbol、intervalまたはdateが不正です。",
+        "ERR-5208": "約定情報取得において、orderId/executionIdが両方設定されました。",
+        "ERR-5209": "注文情報取得において、orderId/rootOrderIdが両方設定されました。",
+        "ERR-5210": "注文タイプと limitPrice/stopPriceが一致しません。",
+        "ERR-5211": "売買区分と一致しない lowerBound/upperBound が指定された、もしくは指値や逆指値注文に lowerBound/upperBound が指定されました。",
+        "ERR-5213": "注文IDもしくは親注文IDと顧客注文IDどちらか一方を指定する箇所でどちらも指定されました。",
+        "ERR-5214": "決済注文において、建玉IDを指定している場合に注文数量が指定されました。",
+        "ERR-5218": "取引時間外のため注文が行えません。",
+        "ERR-5219": "注文変更において通常注文以外の注文IDもしくは、顧客注文IDが指定されました。",
+        "ERR-5220": "IFD注文において1次注文レートを2次注文レートより低く設定しなければなりません。",
+        "ERR-5221": "IFD注文において1次注文レートを2次注文レートより高く設定しなければなりません。",
+        "ERR-5222": "IFDOCO注文において1次注文レートを2次指値注文レートより低く設定しなければなりません。",
+        "ERR-5223": "IFDOCO注文において1次注文レートを2次指値注文レートより高く設定しなければなりません。",
+        "ERR-5224": "IFDOCO注文において1次注文レートを2次逆指値注文レートより高く設定しなければなりません。",
+        "ERR-5225": "IFDOCO注文において1次注文レートを2次逆指値注文レートより低く設定しなければなりません。",
+        "ERR-5226": "逆指値の買い注文において、注文レートが現在レートより低いです。",
+        "ERR-5227": "逆指値の売り注文において、注文レートが現在レートより高いです。",
+        "ERR-5228": "OCO売り注文において逆指値注文レートが指値注文レートを超えています。",
+        "ERR-5229": "OCO買い注文において逆指値注文レートが指値注文レートを下回っています。",
+    }
+
+    def __init__(
+        self, error_code: str, *args: object, message: Optional[str] = None
+    ) -> None:
+        super().__init__(*args)
+        self.error_code = error_code
+        self.message = message
+
+    def __str__(self):
+        message = self.__ERR_MAP[self.error_code]
+        if self.message:
+            message += f"\nmessage: {self.message}"
+        return message

gmo_fx/klines.py

@@ -0,0 +1,87 @@
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import Literal
+from requests import get, Response
+from gmo_fx.response import Response as ResponseBase
+from gmo_fx.symbols import Symbol
+from gmo_fx.urls import BASE_URL_PUBLIC
+
+
+class KlineInterval(Enum):
+    Min1 = "1min"
+    Min5 = "5min"
+    Min10 = "10min"
+    Min15 = "15min"
+    Min30 = "30min"
+    H1 = "1hour"
+    H4 = "4hour"
+    H8 = "8hour"
+    H12 = "12hour"
+    D1 = "1day"
+    W1 = "1week"
+    M1 = "1month"
+
+
+@dataclass
+class Kline:
+    open_time: datetime
+    open: float
+    high: float
+    low: float
+    close: float
+
+
+class KlinesResponse(ResponseBase):
+    klines: list[Kline]
+
+    def __init__(self, response: dict):
+        super().__init__(response)
+        self.klines = []
+
+        data = response["data"]
+        self.klines = [
+            Kline(
+                open=float(d["open"]),
+                high=float(d["high"]),
+                low=float(d["low"]),
+                close=float(d["close"]),
+                open_time=datetime.fromtimestamp(int(d["openTime"]) / 1000),
+            )
+            for d in data
+        ]
+
+
+def get_klines(
+    symbol: Symbol,
+    price_type: Literal["BID", "ASK"],
+    interval: KlineInterval,
+    date: datetime,
+) -> KlinesResponse:
+    date_str = f"{date.year:04}"
+    if interval in (
+        KlineInterval.Min1,
+        KlineInterval.Min5,
+        KlineInterval.Min10,
+        KlineInterval.Min15,
+        KlineInterval.Min30,
+        KlineInterval.H1,
+    ):
+        date_str += f"{date.month:02}{date.day:02}"
+    base_url = f"{BASE_URL_PUBLIC}/klines"
+    response: Response = get(
+        f"{base_url}?"
+        f"symbol={symbol.value}"
+        f"&priceType={price_type}"
+        f"&interval={interval.value}"
+        f"&date={date_str}"
+    )
+    if response.status_code == 200:
+        response_json = response.json()
+        return KlinesResponse(response_json)
+
+    raise RuntimeError(
+        "Klineが取得できませんでした。\n"
+        f"status code: {response.status_code}\n"
+        f"response: {response.text}"
+    )

gmo_fx/response.py

@@ -0,0 +1,17 @@
+from datetime import datetime
+from gmo_fx.errors import ApiError
+
+
+class Response:
+    response_status: int
+    response_time: datetime
+
+    def __init__(self, response: dict):
+        self.response_status = response["status"]
+        self.response_time = datetime.strptime(
+            response["responsetime"], "%Y-%m-%dT%H:%M:%S.%fZ"
+        )
+        if self.response_status != 0:
+            err_code = response["messages"][0]["message_code"]
+            message = response["messages"][0]["message_string"]
+            raise ApiError(err_code, message=message)

gmo_fx/status.py

@@ -0,0 +1,47 @@
+from enum import auto, Enum
+from typing import Type
+from requests import get, Response
+from gmo_fx.response import Response as ResponseBase
+from gmo_fx.urls import BASE_URL_PUBLIC
+
+
+class Status(Enum):
+    """
+    外国為替FXの稼動状態
+    """
+
+    OPEN = auto()  # オープン
+    CLOSE = auto()  # クローズ
+    MAINTENANCE = auto()  # メンテナンス
+
+    @classmethod
+    def from_str(cls, text: str) -> Type["Status"]:
+        match text:
+            case "OPEN":
+                return cls.OPEN
+            case "CLOSE":
+                return cls.CLOSE
+            case "MAINTENANCE":
+                return cls.MAINTENANCE
+        raise ValueError(f"不明なステータスです。: {text}")
+
+
+class StatusResponse(ResponseBase):
+    status: Status
+
+    def __init__(self, response: dict):
+        super().__init__(response)
+        self.status = Status.from_str(response["data"]["status"])
+
+
+def get_status() -> StatusResponse:
+    response: Response = get(f"{BASE_URL_PUBLIC}/status")
+    if response.status_code == 200:
+        response_json = response.json()
+        return StatusResponse(response_json)
+
+    raise RuntimeError(
+        "ステータスが取得できませんでした。\n"
+        f"status code: {response.status_code}\n"
+        f"response: {response.text}"
+    )

gmo_fx/symbols.py

@@ -0,0 +1,64 @@
+from dataclasses import dataclass
+from enum import Enum
+from gmo_fx.response import Response as ResponseBase
+from requests import get, Response
+from gmo_fx.urls import BASE_URL_PUBLIC
+
+
+class Symbol(Enum):
+    USD_JPY = "USD_JPY"
+    EUR_JPY = "EUR_JPY"
+    GBP_JPY = "GBP_JPY"
+    AUD_JPY = "AUD_JPY"
+    NZD_JPY = "NZD_JPY"
+    CAD_JPY = "CAD_JPY"
+    CHF_JPY = "CHF_JPY"
+    TRY_JPY = "TRY_JPY"
+    ZAR_JPY = "ZAR_JPY"
+    MXN_JPY = "MXN_JPY"
+    EUR_USD = "EUR_USD"
+    GBP_USD = "GBP_USD"
+    AUD_USD = "AUD_USD"
+    NZD_USD = "NZD_USD"
+
+
+@dataclass
+class Rule:
+    symbol: Symbol
+    min_open_order_size: int
+    max_order_size: int
+    size_step: int
+    tick_size: float
+
+
+class SymbolsResponse(ResponseBase):
+    rules: list[Rule]
+
+    def __init__(self, response: dict):
+        super().__init__(response)
+        self.rules = []
+
+        data = response["data"]
+        self.rules = [
+            Rule(
+                symbol=Symbol(d["symbol"]),
+                min_open_order_size=int(d["minOpenOrderSize"]),
+                max_order_size=int(d["maxOrderSize"]),
+                size_step=int(d["sizeStep"]),
+                tick_size=float(d["tickSize"]),
+            )
+            for d in data
+        ]
+
+
+def get_symbols() -> SymbolsResponse:
+    response: Response = get(f"{BASE_URL_PUBLIC}/symbols")
+    if response.status_code == 200:
+        response_json = response.json()
+        return SymbolsResponse(response_json)
+
+    raise RuntimeError(
+        "取引ルールが取得できませんでした。\n"
+        f"status code: {response.status_code}\n"
+        f"response: {response.text}"
+    )

gmo_fx/ticker.py

@@ -0,0 +1,48 @@
+from dataclasses import dataclass
+from datetime import datetime
+from requests import get, Response
+from gmo_fx.response import Response as ResponseBase
+from gmo_fx.symbols import Symbol
+from gmo_fx.urls import BASE_URL_PUBLIC
+
+
+@dataclass
+class Ticker:
+    symbol: Symbol
+    ask: float
+    bid: float
+    timestamp: datetime
+    status: str
+
+
+class TickerResponse(ResponseBase):
+    tickers: list[Ticker]
+
+    def __init__(self, response: dict):
+        super().__init__(response)
+        self.tickers = []
+
+        data = response["data"]
+        self.tickers = [
+            Ticker(
+                symbol=Symbol(d["symbol"]),
+                ask=d["ask"],
+                bid=d["bid"],
+                status=d["status"],
+                timestamp=datetime.strptime(d["timestamp"], "%Y-%m-%dT%H:%M:%S.%fZ"),
+            )
+            for d in data
+        ]
+
+
+def get_ticker() -> TickerResponse:
+    response: Response = get(f"{BASE_URL_PUBLIC}/ticker")
+    if response.status_code == 200:
+        response_json = response.json()
+        return TickerResponse(response_json)
+
+    raise RuntimeError(
+        "最新レートが取得できませんでした。\n"
+        f"status code: {response.status_code}\n"
+        f"response: {response.text}"
+    )

gmo_fx/urls.py

@@ -0,0 +1 @@
+BASE_URL_PUBLIC = "https://forex-api.coin.z.com/public/v1"

gmo_fx-0.1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 RikitoNoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gmo_fx-0.1.0.dist-info/METADATA

@@ -0,0 +1,13 @@
+Metadata-Version: 2.1
+Name: gmo_fx
+Version: 0.1.0
+Summary: GMO社のFX API用Pythonライブラリ
+Home-page: https://github.com/RikitoNoto/gmo-fx-py
+Download-URL: https://github.com/RikitoNoto/gmo-fx-py
+Author: Rikito Noto
+Author-email: rikitonoto@gmail.com
+License: MIT
+License-File: LICENSE
+Requires-Dist: requests >=2.31.0
+
+# gmo-fx-py

gmo_fx-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+gmo_fx/__init__.py,sha256=mFJeTwvSwYlA9ucCVITWFhL_Ll8eQurdD4HBpJ99COE,158
+gmo_fx/errors.py,sha256=2FwfVaRiMHmiVRT9QxwQHuVqiUh2fdWxX_wBIWXJ6u0,7751
+gmo_fx/klines.py,sha256=wNAOXXRbpnp0gwki8lX4qwCQ32aMcpNbS04T4CdHjNQ,2114
+gmo_fx/response.py,sha256=1pXN57X7StpFSCyBwk5Ykegvwz9CYKznYcWchh020Js,566
+gmo_fx/status.py,sha256=lKiDtDmgTgaxNlzalsOKWqAuUbXzKWPSEChx_11Q2dM,1314
+gmo_fx/symbols.py,sha256=-X7k8_NUV-X1Sg4Klog-jeu-BTD8IIUSsNXkz-VPdvg,1623
+gmo_fx/ticker.py,sha256=9tF8mpHqOkeKYqRJoHaebLL2n1F4aKFx3EIEQs0cD_0,1260
+gmo_fx/urls.py,sha256=PAUzpnoD_5MNeW36pMg-m7H7zbP4zxFqRUFPmeHftqI,59
+gmo_fx-0.1.0.dist-info/LICENSE,sha256=E0OTq-yBYiEdz67sZVyselIpZTwiWvQZXIwYe0pghqQ,1067
+gmo_fx-0.1.0.dist-info/METADATA,sha256=_hDC6OcQTV7nT7RSfX6L6P1u2XsvEFJqgeOR6T-9tzw,340
+gmo_fx-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+gmo_fx-0.1.0.dist-info/top_level.txt,sha256=adYIVHWAgwdd8W9iLSy8SwXTu5ixgOktevt6AHxsOh0,7
+gmo_fx-0.1.0.dist-info/RECORD,,

gmo_fx-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gmo_fx-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gmo_fx