gmocoin.private package¶

Submodules¶

gmocoin.private.api module¶

class gmocoin.private.api.Client(**kwargs)¶

ベースクラス: object

GMOCoinのプライベートAPIクライアントクラスです。

cancel_order(order_id: int) → gmocoin.common.dto.BaseResponse ¶

注文取消をします。対象: 現物取引、レバレッジ取引

パラメータ: order_id --
戻り値: BaseResponse

change_order(order_id: int, price: str, losscut_price: str = '') → gmocoin.common.dto.BaseResponse ¶

注文変更をします。対象: 現物取引、レバレッジ取引

パラメータ

order_id -- Required
price -- Required
losscut_price -- Optional

戻り値

BaseResponse

close_bulk_order(symbol: gmocoin.common.dto.Symbol, side: gmocoin.common.dto.SalesSide, execution_type: gmocoin.common.dto.ExecutionType, time_in_force: gmocoin.common.dto.TimeInForce, size: str, price: str = '0') → gmocoin.private.dto.PostCloseBulkOrderRes ¶

一括決済注文をします。対象: レバレッジ取引

パラメータ

symbol -- Required BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY
side -- Required BUY SELL
execution_type -- Required MARKET LIMIT STOP
time_in_force -- Optional FAK ( MARKET STOPの場合のみ設定可能 ) FAS FOK ((Post-onlyの場合はSOK) LIMITの場合のみ設定可能 ) *指定がない場合は成行と逆指値はFAK、指値はFASで注文されます。 SOKはBTC_JPYの場合のみ指定可能です。
price -- *executionTypeによる LIMIT STOP の場合は必須、 MARKET の場合は不要。
size -- Required

戻り値

PostCloseBulkOrderRes

close_order(symbol: gmocoin.common.dto.Symbol, side: gmocoin.common.dto.SalesSide, execution_type: gmocoin.common.dto.ExecutionType, time_in_force: gmocoin.common.dto.TimeInForce, position_id: int, position_size: str, price: str = '0') → gmocoin.private.dto.PostCloseOrderRes ¶

決済注文をします。対象: レバレッジ取引

パラメータ

symbol -- Required BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY
side -- Required BUY SELL
execution_type -- Required MARKET LIMIT STOP
time_in_force -- Optional FAK ( MARKET STOPの場合のみ設定可能 ) FAS FOK ((Post-onlyの場合はSOK) LIMITの場合のみ設定可能 ) *指定がない場合は成行と逆指値はFAK、指値はFASで注文されます。 SOKはBTC_JPYの場合のみ指定可能です。
price -- *executionTypeによる LIMIT STOP の場合は必須、 MARKET の場合は不要。
position_id -- Required 建玉は1つのみ指定可能。
position_size -- Required 建玉は1つのみ指定可能。

戻り値

PostCloseOrderRes

get_active_orders(symbol: gmocoin.common.dto.Symbol, page: int = 1, count: int = 100) → gmocoin.private.dto.GetActiveOrdersRes ¶

有効注文一覧を取得します。対象: 現物取引、レバレッジ取引。

パラメータ

symbol -- BTC ETH BCH LTC XRP BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY
page -- 取得対象ページ: 指定しない場合は1を指定したとして動作する。
count -- 1ページ当りの取得件数: 指定しない場合は100(最大値)を指定したとして動作する。

戻り値

GetActiveOrdersRes

get_assets() → gmocoin.private.dto.GetAssetsRes ¶

資産残高を取得します。

パラメータ: なし --
戻り値: GetAssetsRes

get_margin() → gmocoin.private.dto.GetMarginRes ¶

余力情報を取得します。

パラメータ: なし --
戻り値: GetMarginRes

get_position_summary(symbol: gmocoin.common.dto.Symbol) → gmocoin.private.dto.GetPositionSummaryRes ¶

建玉サマリーを取得します。対象: レバレッジ取引

銘柄ごと、売買区分(買/売)ごとの建玉サマリー取得ができます。

パラメータ: symbol -- BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY
戻り値: GetPositionSummaryRes

order(symbol: gmocoin.common.dto.Symbol, side: gmocoin.common.dto.SalesSide, execution_type: gmocoin.common.dto.ExecutionType, time_in_force: gmocoin.common.dto.TimeInForce, size: str, price: str = '0', losscut_price: str = '0') → gmocoin.private.dto.PostOrderRes ¶

新規注文をします。対象: 現物取引、レバレッジ取引

現物取引: 買/売注文レバレッジ取引: 新規の買/売注文

パラメータ

symbol -- BTC ETH BCH LTC XRP BTC_JPY ETH_JPY BCH_JPY LTC_JPY XRP_JPY
side -- BUY SELL
execution_type -- MARKET LIMIT STOP
time_in_force -- Optional FAK ( MARKET STOPの場合のみ設定可能 ) FAS FOK ((Post-onlyの場合はSOK) LIMITの場合のみ設定可能 ) *指定がない場合は成行と逆指値はFAK、指値はFASで注文されます。 SOKは現物取引（全銘柄）とレバレッジ取引(BTC_JPY)の場合のみ指定可能です。
price -- *executionTypeによる LIMIT STOP の場合は必須、 MARKET の場合は不要。
losscut_price -- レバレッジ取引で、executionTypeが LIMIT または STOP の場合のみ設定可能。
size -- 数量

戻り値

PostOrderRes

gmocoin.private.dto module¶

class gmocoin.private.dto.ActiveOrder(root_order_id: int, order_id: int, symbol: gmocoin.common.dto.Symbol, side: gmocoin.common.dto.SalesSide, order_type: gmocoin.common.dto.OrderType, execution_type: gmocoin.common.dto.ExecutionType, settle_type: gmocoin.common.dto.SettleType, size: decimal.Decimal, executed_size: decimal.Decimal, price: decimal.Decimal, losscut_price: decimal.Decimal, status: gmocoin.common.dto.OrderStatus, time_in_force: gmocoin.common.dto.TimeInForce, timestamp: str)¶

ベースクラス: object

有効注文一覧クラスです。

class gmocoin.private.dto.ActiveOrderSchema(*, 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.private.dto.ActiveOrdersPagenation(current_page: int, count: int)¶

ベースクラス: object

有効注文一覧ページングデータクラスです。

class gmocoin.private.dto.ActiveOrdersPagenationSchema(*, 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.private.dto.GetActiveOrdersData(pagination: gmocoin.private.dto.ActiveOrdersPagenation = None, active_orders: List[gmocoin.private.dto.ActiveOrder] = None)¶

ベースクラス: object

有効注文一覧データクラスです。

class gmocoin.private.dto.GetActiveOrdersDataSchema(*, 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.private.dto.GetActiveOrdersRes(status: int, responsetime: str, data: gmocoin.private.dto.GetActiveOrdersData)¶

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

有効注文一覧レスポンスクラスです。

class gmocoin.private.dto.GetActiveOrdersResSchema(*, 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.private.dto.GetAssetsData(amount: decimal.Decimal, available: decimal.Decimal, conversion_rate: decimal.Decimal, symbol: gmocoin.common.dto.AssetSymbol)¶

ベースクラス: object

資産残高データクラスです。

class gmocoin.private.dto.GetAssetsDataSchema(*, 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.private.dto.GetAssetsRes(status: int, responsetime: str, data: gmocoin.private.dto.GetAssetsData)¶

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

資産残高レスポンスクラスです。

class gmocoin.private.dto.GetAssetsResSchema(*, 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.private.dto.GetMarginData(actual_profit_loss: decimal.Decimal, available_amount: decimal.Decimal, margin: decimal.Decimal, profit_loss: decimal.Decimal)¶

ベースクラス: object

余力情報データクラスです。

class gmocoin.private.dto.GetMarginDataSchema(*, 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.private.dto.GetMarginRes(status: int, responsetime: str, data: gmocoin.private.dto.GetMarginData)¶

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

余力情報レスポンスクラスです。

class gmocoin.private.dto.GetMarginResSchema(*, 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.private.dto.GetPositionSummaryData(position_summarys: List[gmocoin.private.dto.PositionSummary] = [])¶

ベースクラス: object

建玉サマリーデータクラスです。

class gmocoin.private.dto.GetPositionSummaryDataSchema(*, 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.private.dto.GetPositionSummaryRes(status: int, responsetime: str, data: gmocoin.private.dto.GetActiveOrdersData)¶

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

建玉サマリーレスポンスクラスです。

class gmocoin.private.dto.GetPositionSummaryResSchema(*, 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.private.dto.PositionSummary(average_position_rate: decimal.Decimal, position_loss_gain: decimal.Decimal, side: gmocoin.common.dto.SalesSide, sum_order_quantity: decimal.Decimal, sum_position_quantity: decimal.Decimal, symbol: gmocoin.common.dto.Symbol)¶

ベースクラス: object

建玉サマリークラスです。

class gmocoin.private.dto.PositionSummarySchema(*, 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.private.dto.PostCloseBulkOrderRes(status: int, responsetime: str, data: int)¶

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

一括決済注文レスポンスクラスです。

class gmocoin.private.dto.PostCloseBulkOrderResSchema(*, 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.private.dto.PostCloseOrderRes(status: int, responsetime: str, data: int)¶

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

決済注文レスポンスクラスです。

class gmocoin.private.dto.PostCloseOrderResSchema(*, 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.private.dto.PostOrderRes(status: int, responsetime: str, data: int)¶

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

新規注文レスポンスクラスです。

class gmocoin.private.dto.PostOrderResSchema(*, 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>¶

gmocoin.private package¶

Submodules¶

gmocoin.private.api module¶

gmocoin.private.dto module¶

Module contents¶