gmocoin.public package

Submodules

gmocoin.public.api module

class gmocoin.public.api.Client

ベースクラス: object

GMOCoinのパブリックAPIクライアントクラスです。

get_orderbooks(symbol: gmocoin.common.dto.Symbol) → gmocoin.public.dto.GetOrderBooksRes

指定した銘柄の板情報(snapshot)を取得します。

パラメータ

symbol -- BTC ETH BCH LTC XRP BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY

戻り値

GetOrderBooksRes

get_status() → gmocoin.public.dto.GetStatusRes

取引所の稼動状態を取得します。

パラメータ

なし --

戻り値

GetStatusRes

get_ticker(symbol: gmocoin.common.dto.Symbol = None) → gmocoin.public.dto.GetTickerRes

指定した銘柄の最新レートを取得します。 全銘柄分の最新レートを取得する場合はsymbolパラメータ指定無しでの実行をおすすめします。

パラメータ

symbol -- 指定しない場合は全銘柄分の最新レートを返す。 BTC ETH BCH LTC XRP BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY

戻り値

GetTickerRes

get_trades(symbol: gmocoin.common.dto.Symbol, page: int = 1, count: int = 100) → gmocoin.public.dto.GetTradesRes

指定した銘柄の板情報(snapshot)を取得します。

パラメータ

• symbol -- BTC ETH BCH LTC XRP BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY

• page -- 取得対象ページ 指定しない場合は1を指定したとして動作する。

• count -- 1ページ当りの取得件数 指定しない場合は100(最大値)を指定したとして動作する。

戻り値

GetTradesRes

gmocoin.public.dto module

class gmocoin.public.dto.GetOrderBooksData(asks: List[gmocoin.public.dto.OrderData], bids: List[gmocoin.public.dto.OrderData], symbol: gmocoin.common.dto.Symbol)

ベースクラス: object

銘柄板データクラスです。

class gmocoin.public.dto.GetOrderBooksDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseSchema

銘柄板データスキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.GetOrderBooksRes(status: int, responsetime: str, data: gmocoin.public.dto.GetOrderBooksData)

ベースクラス: gmocoin.common.dto.BaseResponse

銘柄板レスポンスクラスです。

class gmocoin.public.dto.GetOrderBooksResSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseResponseSchema

銘柄板レスポンススキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.GetStatusData(status: gmocoin.common.dto.Status)

ベースクラス: object

取引所稼動状態データクラスです。

class gmocoin.public.dto.GetStatusDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseSchema

取引所稼動状態データスキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.GetStatusRes(status: int, responsetime: str, data: gmocoin.public.dto.GetStatusData)

ベースクラス: gmocoin.common.dto.BaseResponse

取引所稼動状態レスポンスクラスです。

class gmocoin.public.dto.GetStatusResSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseResponseSchema

取引所稼動状態レスポンススキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.GetTickerData(symbol: gmocoin.common.dto.Symbol, timestamp: str, volume: decimal.Decimal, ask: decimal.Decimal, bid: decimal.Decimal, high: decimal.Decimal, last: decimal.Decimal, low: decimal.Decimal)

ベースクラス: object

銘柄最新レートデータクラスです。

class gmocoin.public.dto.GetTickerDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseSchema

銘柄最新レートデータスキーマクラスです。

convert_none_to_zero(in_data, **kwargs)

Noneを0に変換する関数です。

パラメータ

• in_data --

• kwargs --

戻り値

in_data

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.GetTickerRes(status: int, responsetime: str, data: gmocoin.public.dto.GetTickerData)

ベースクラス: gmocoin.common.dto.BaseResponse

銘柄最新レートレスポンスクラスです。

class gmocoin.public.dto.GetTickerResSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseResponseSchema

銘柄最新レートレスポンススキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.GetTradesData(pagination: gmocoin.public.dto.TradesPagenation, trades: List[gmocoin.public.dto.Trade])

ベースクラス: object

取引履歴データクラスです。

class gmocoin.public.dto.GetTradesDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseSchema

取引履歴データスキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.GetTradesRes(status: int, responsetime: str, data: gmocoin.public.dto.GetOrderBooksData)

ベースクラス: gmocoin.common.dto.BaseResponse

取引履歴レスポンスクラスです。

class gmocoin.public.dto.GetTradesResSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseResponseSchema

取引履歴レスポンススキーマです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.OrderData(price: decimal.Decimal, size: decimal.Decimal)

ベースクラス: object

注文データクラスです。

class gmocoin.public.dto.OrderDataSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseSchema

注文データスキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.Trade(price: decimal.Decimal, side: gmocoin.common.dto.SalesSide, size: decimal.Decimal, timestamp: str)

ベースクラス: object

取引データクラスです。

class gmocoin.public.dto.TradeSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseSchema

取引データスキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

class gmocoin.public.dto.TradesPagenation(current_page: int, count: int)

ベースクラス: object

取引ページングデータクラスです。

class gmocoin.public.dto.TradesPagenationSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)

ベースクラス: gmocoin.common.dto.BaseSchema

取引ページングデータスキーマクラスです。

opts = <marshmallow.schema.SchemaOpts object>

Module contents