GMO Coin Python Client Library

A Python client library for interacting with the GMO Coin cryptocurrency exchange API.

📘 GMO Coin API Coverage

Usage

Set GMO_API_KEY and GMO_SECRET_KEY in your environment for private API calls.

Public endpoints

from gmocoin_client import Client

client = Client()

status = client.get_status()
ticker = client.get_ticker("BTC")
orderbooks = client.get_orderbooks("BTC")

Private endpoints (with env vars)

from gmocoin_client import Client

with Client.from_env() as client:
    assets = client.get_assets()
    margin = client.get_margin()

Place an order

from gmocoin_client import Client

with Client.from_env() as client:
    order = client.create_order(
        symbol="BTC_JPY",
        side="BUY",
        execution_type="LIMIT",
        time_in_force="FAS",
        price="430001",
        size="0.02",
    )

WebSocket access token

from gmocoin_client import Client

with Client.from_env() as client:
    token = client.ws_auth_create()

Error handling

from gmocoin_client import GmoCoinApiError, Client, GmoCoinHttpError

client = Client()

try:
    client.get_ticker("BTC")
except GmoCoinApiError as exc:
    print(exc)
except GmoCoinHttpError as exc:
    print(exc)

Live trading tests (local-only)

Live tests are excluded by default. To run them locally, opt in and set required environment variables (see .env.example). Tests load .env automatically:

export GMO_LIVE_TESTS=true
export GMO_API_KEY="your_api_key"
export GMO_SECRET_KEY="your_secret_key"
export GMO_LIVE_SYMBOL="BTC"
export GMO_LIVE_SIZE="0.0001"
export GMO_LIVE_BUY_EXECUTION_TYPE="MARKET"
export GMO_LIVE_SELL_EXECUTION_TYPE="MARKET"

Then run:

pytest -m live

Public REST API

Private REST API

Public WebSocket API

Private WebSocket API