Models

class gmocoin_client.models.APIBaseModel(**extra_data)[source]

Bases: BaseModel

Base model for API payloads.

API用のベースモデル

Parameters:

extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.APIErrorMessage(*, message_code=None, message_string=None, **extra_data)[source]

Bases: APIBaseModel

API error message entry.

エラーメッセージ1件

Parameters:

  • message_code (str | None)

  • message_string (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.APIResponse(*, status, data=None, messages=None, responsetime=None, **extra_data)[source]

Bases: APIBaseModel, Generic[T]

API wrapper response.

messages is populated on error responses when raise_on_error is False.

Parameters:

  • status (int)

  • data (T | None)

  • messages (list[APIErrorMessage] | None)

  • responsetime (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.Pagination(*, currentPage=None, count=None, **extra_data)[source]

Bases: APIBaseModel

Pagination metadata.

ページ情報

Parameters:

  • currentPage (int | None)

  • count (int | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.ServiceStatusData(*, status, **extra_data)[source]

Bases: APIBaseModel

Service status payload.

サービスステータス

Parameters:

  • status (Literal['MAINTENANCE', 'PREOPEN', 'OPEN'])

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.TickerItem(*, ask=None, bid=None, high=None, last=None, low=None, symbol=None, timestamp=None, volume=None, **extra_data)[source]

Bases: APIBaseModel

Ticker entry.

ティッカー情報

Parameters:

  • ask (str | None)

  • bid (str | None)

  • high (str | None)

  • last (str | None)

  • low (str | None)

  • symbol (str | None)

  • timestamp (str | None)

  • volume (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.OrderbookLevel(*, price=None, size=None, **extra_data)[source]

Bases: APIBaseModel

Order book level.

板の価格レベル

Parameters:

  • price (str | None)

  • size (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.OrderbookData(*, asks=None, bids=None, symbol=None, **extra_data)[source]

Bases: APIBaseModel

Order book snapshot.

板スナップショット

Parameters:
model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.TradeItem(*, price=None, side=None, size=None, timestamp=None, **extra_data)[source]

Bases: APIBaseModel

Trade entry.

約定情報

Parameters:

  • price (str | None)

  • side (Literal['BUY', 'SELL'] | None)

  • size (str | None)

  • timestamp (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.TradesData(*, pagination=None, list=None, **extra_data)[source]

Bases: APIBaseModel

Trades response payload.

約定一覧データ

Parameters:
model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.KlineItem(*, openTime=None, open=None, high=None, low=None, close=None, volume=None, **extra_data)[source]

Bases: APIBaseModel

Kline entry.

ローソク足データ

Parameters:

  • openTime (str | None)

  • open (str | None)

  • high (str | None)

  • low (str | None)

  • close (str | None)

  • volume (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.SymbolRule(*, symbol=None, minOrderSize=None, maxOrderSize=None, sizeStep=None, tickSize=None, takerFee=None, makerFee=None, **extra_data)[source]

Bases: APIBaseModel

Symbol rule entry.

銘柄の取引ルール

Parameters:

  • symbol (str | None)

  • minOrderSize (str | None)

  • maxOrderSize (str | None)

  • sizeStep (str | None)

  • tickSize (str | None)

  • takerFee (str | None)

  • makerFee (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.MarginData(*, actualProfitLoss=None, availableAmount=None, margin=None, marginCallStatus=None, marginRatio=None, profitLoss=None, transferableAmount=None, **extra_data)[source]

Bases: APIBaseModel

Margin summary.

証拠金サマリー

Parameters:

  • actualProfitLoss (str | None)

  • availableAmount (str | None)

  • margin (str | None)

  • marginCallStatus (Literal['NORMAL', 'MARGIN_CALL', 'LOSSCUT'] | None)

  • marginRatio (str | None)

  • profitLoss (str | None)

  • transferableAmount (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.AssetItem(*, amount=None, available=None, conversionRate=None, symbol=None, **extra_data)[source]

Bases: APIBaseModel

Asset balance entry.

資産残高

Parameters:

  • amount (str | None)

  • available (str | None)

  • conversionRate (str | None)

  • symbol (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.TradingVolumeLimit(*, symbol=None, todayLimitOpenSize=None, todayLimitBuySize=None, todayLimitSellSize=None, takerFee=None, makerFee=None, **extra_data)[source]

Bases: APIBaseModel

Trading volume limit entry.

取引量の制限

Parameters:

  • symbol (str | None)

  • todayLimitOpenSize (str | None)

  • todayLimitBuySize (str | None)

  • todayLimitSellSize (str | None)

  • takerFee (str | None)

  • makerFee (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.TradingVolumeData(*, jpyVolume=None, tierLevel=None, limit=None, **extra_data)[source]

Bases: APIBaseModel

Trading volume payload.

取引量データ

Parameters:

  • jpyVolume (str | None)

  • tierLevel (int | None)

  • limit (list[TradingVolumeLimit] | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.FiatHistoryItem(*, amount=None, fee=None, status=None, symbol=None, timestamp=None, **extra_data)[source]

Bases: APIBaseModel

Fiat history entry.

法定通貨の履歴

Parameters:

  • amount (str | None)

  • fee (str | None)

  • status (Literal['EXECUTED'] | None)

  • symbol (str | None)

  • timestamp (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.CryptoHistoryItem(*, address=None, amount=None, fee=None, status=None, symbol=None, timestamp=None, txHash=None, **extra_data)[source]

Bases: APIBaseModel

Crypto history entry.

暗号資産の履歴

Parameters:

  • address (str | None)

  • amount (str | None)

  • fee (str | None)

  • status (Literal['EXECUTED'] | None)

  • symbol (str | None)

  • timestamp (str | None)

  • txHash (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.OrderItem(*, rootOrderId=None, orderId=None, symbol=None, side=None, orderType=None, executionType=None, settleType=None, size=None, executedSize=None, price=None, losscutPrice=None, status=None, cancelType=None, timeInForce=None, timestamp=None, **extra_data)[source]

Bases: APIBaseModel

Order entry.

注文情報

Parameters:

  • rootOrderId (int | None)

  • orderId (int | None)

  • symbol (str | None)

  • side (Literal['BUY', 'SELL'] | None)

  • orderType (Literal['NORMAL', 'LOSSCUT'] | None)

  • executionType (Literal['MARKET', 'LIMIT', 'STOP'] | None)

  • settleType (Literal['OPEN', 'CLOSE'] | None)

  • size (str | None)

  • executedSize (str | None)

  • price (str | None)

  • losscutPrice (str | None)

  • status (Literal['WAITING', 'ORDERED', 'MODIFYING', 'CANCELLING', 'CANCELED', 'EXECUTED', 'EXPIRED'] | None)

  • cancelType (Literal['USER', 'POSITION_LOSSCUT', 'INSUFFICIENT_BALANCE', 'INSUFFICIENT_MARGIN', 'ACCOUNT_LOSSCUT', 'MARGIN_CALL', 'MARGIN_CALL_LOSSCUT', 'EXPIRED_FAK', 'EXPIRED_FOK', 'EXPIRED_SOK', 'EXPIRED_SELFTRADE'] | None)

  • timeInForce (Literal['FAK', 'FAS', 'FOK', 'SOK'] | None)

  • timestamp (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.OrdersData(*, list=None, **extra_data)[source]

Bases: APIBaseModel

Orders list payload.

注文一覧データ

Parameters:

  • list (List[OrderItem] | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.ActiveOrdersData(*, pagination=None, list=None, **extra_data)[source]

Bases: APIBaseModel

Active orders payload.

注文中一覧データ

Parameters:
model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.ExecutionItem(*, executionId=None, orderId=None, positionId=None, symbol=None, side=None, settleType=None, size=None, price=None, lossGain=None, fee=None, timestamp=None, **extra_data)[source]

Bases: APIBaseModel

Execution entry.

約定情報

Parameters:

  • executionId (int | None)

  • orderId (int | None)

  • positionId (int | None)

  • symbol (str | None)

  • side (Literal['BUY', 'SELL'] | None)

  • settleType (Literal['OPEN', 'CLOSE'] | None)

  • size (str | None)

  • price (str | None)

  • lossGain (str | None)

  • fee (str | None)

  • timestamp (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.ExecutionsData(*, list=None, **extra_data)[source]

Bases: APIBaseModel

Executions list payload.

約定一覧データ

Parameters:
model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.LatestExecutionsData(*, pagination=None, list=None, **extra_data)[source]

Bases: APIBaseModel

Latest executions payload.

最新約定データ

Parameters:
model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.PositionItem(*, positionId=None, symbol=None, side=None, size=None, orderdSize=None, price=None, lossGain=None, leverage=None, losscutPrice=None, timestamp=None, **extra_data)[source]

Bases: APIBaseModel

Position entry.

建玉情報

Parameters:

  • positionId (int | None)

  • symbol (str | None)

  • side (Literal['BUY', 'SELL'] | None)

  • size (str | None)

  • orderdSize (str | None)

  • price (str | None)

  • lossGain (str | None)

  • leverage (str | None)

  • losscutPrice (str | None)

  • timestamp (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.OpenPositionsData(*, pagination=None, list=None, **extra_data)[source]

Bases: APIBaseModel

Open positions payload.

建玉一覧データ

Parameters:
model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.PositionSummaryItem(*, averagePositionRate=None, positionLossGain=None, side=None, sumOrderQuantity=None, sumPositionQuantity=None, symbol=None, **extra_data)[source]

Bases: APIBaseModel

Position summary entry.

ポジションサマリー

Parameters:

  • averagePositionRate (str | None)

  • positionLossGain (str | None)

  • side (Literal['BUY', 'SELL'] | None)

  • sumOrderQuantity (str | None)

  • sumPositionQuantity (str | None)

  • symbol (str | None)

  • extra_data (Any)

model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gmocoin_client.models.PositionSummaryData(*, list=None, **extra_data)[source]

Bases: APIBaseModel

Position summary payload.

ポジションサマリー一覧データ

Parameters:
model_config = {'extra': 'allow'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].