gamegains-sdk 0.0.3

Official Python SDK for the GameGains perpetual-futures trading API — HMAC + EIP-712 signing built in.

gamegains-sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage gamegains-sdk API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

GameGains API: GameGains v1 REST API.

Auth: authenticated endpoints sign each request with HMAC-SHA256. The signing string is the literal byte concatenation timestamp + method + originalUrl + rawBody, where:

• timestamp — Unix epoch ms as a decimal string (also sent in X-GG-TIMESTAMP).
• method — uppercase verb (GET, POST, DELETE).
• originalUrl — request path including the query string (e.g. /api/v1/orders?market=AK47-REDLINE-FT).
• rawBody — the exact request body bytes you put on the wire. Sign before parsing; the server re-hashes the raw buffer.

Send the hex-encoded HMAC in X-GG-SIGNATURE, the API key value (the apiKey field, e.g. gg_pk_… — NOT the keyId) in X-GG-APIKEY, and the timestamp in X-GG-TIMESTAMP. The server rejects skew > 5s — call GET /api/v1/time once at boot to detect clock drift.

Replay protection: the timestamp is also a per-key nonce and must strictly increase on every call for a given key. A timestamp <= the last one accepted for that key is rejected (covers exact replays, two requests in the same millisecond, and blind retries of identical signed bytes); a timestamp >5s in the future is also rejected. Never replay signed bytes — bump the timestamp and re-sign on retry. To run requests concurrently, send an optional X-GG-NONCE (a unique token per request, appended to the signed string after the body, separated by a newline); distinct nonces use per-key nonce-uniqueness instead of the monotonic timestamp, so parallel requests do not serialize.

Content-Type: any request that carries a body must set Content-Type: application/json (including a body-bearing DELETE such as batch cancel); otherwise the body is dropped, rawBody is empty, and the signature fails as a 401.

Errors: every error response is { "error": { "code": "<MACHINE_CODE>", "message": "<human text>" } }. Status code carries semantics (400 bad params, 401 auth, 403 permission, 404 missing, 409 conflict, 429 rate-limited, 5xx server).

Bootstrap: sign an EIP-712 ApiKeyCreate intent with the trader wallet → POST /api/v1/auth/create-key to mint a key + API secret (shown once).

Table of Contents

• gamegains-sdk
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

[!TIP] To finish publishing your SDK to PyPI you must run your first generation action.

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add git+<UNSET>.git

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+<UNSET>.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+<UNSET>.git

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from gamegains-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.10"
# dependencies = [
#     "gamegains-sdk",
# ]
# ///

from gamegains_sdk import GameGains

sdk = GameGains(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from gamegains_sdk import GameGains


with GameGains() as game_gains:

    res = game_gains.auth.create_api_key()

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from gamegains_sdk import GameGains

async def main():

    async with GameGains() as game_gains:

        res = await game_gains.auth.create_api_key_async()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
gg_apikey	apiKey	API key	GAMEGAINS_GG_APIKEY

To authenticate with the API the gg_apikey parameter must be set when initializing the SDK client instance. For example:

from gamegains_sdk import GameGains
import os


with GameGains(
    gg_apikey=os.getenv("GAMEGAINS_GG_APIKEY", ""),
) as game_gains:

    res = game_gains.auth.create_api_key()

    # Handle response
    print(res)

Available Resources and Operations

Available methods

Account

• get_account - Get account info for the authenticated API key

Auth

• create_api_key - Mint an API key, authenticated by an EIP-712 wallet signature
• get_primary_api_key - Lazy-mint + return the wallet’s stable primary API key
• rotate_primary_api_key - Regenerate the HMAC secret on the wallet’s primary key

Collateral

• get_collateral - Get collateral balances for the authenticated user

Lp

• get_lp_vault - Get LP vault overview
• get_lp_value - Get LP value for a specific address

MarketData

• list_oracle_prices - Get oracle prices for all markets
• get_oracle_price - Get oracle price for one market
• list_funding_info - Get funding info for all markets
• get_funding_info - Get funding info for one market

Markets

• list_markets - List all tradable markets
• get_server_time - Server clock for HMAC + nonce skew detection
• get_exchange_info - One-shot venue metadata for bot bootstrap
• get_orderbook - Get order book for a market
• get_ticker - Get latest ticker for a market
• list_trades - Get recent trades for a market

Orders

• create_order - Place a single order
• list_orders - List open / matched / settled orders for the authenticated trader
• create_order_batch - Place a batch of orders in a single request (up to 10; market makers up to 25)
• cancel_order_batch - Cancel up to 20 orders in a single request
• cancel_all_orders - Cancel all open orders, optionally filtered by market
• replace_order_batch - Cancel + place up to 25 orders in one call (engine mode only)
• set_dead_man_switch - Arm/disarm the account-wide dead-man switch (cancel-on-disconnect)
• get_order - Get a single order by ID (engine mode only)
• cancel_order - Cancel a single order
• amend_order - Amend an order (priority-preserving size-down)
• cancel_order_by_client_id - Cancel a single open order by its client-supplied tag (Binance origClientOrderId equivalent)

Positions

• list_positions - List positions for the authenticated trader
• add_position_margin - Add margin to an existing position
• set_position_tp_sl - Attach a take-profit and/or stop-loss to an open position
• clear_position_tp_sl - Clear both arms of a position TP/SL
• get_position_tp_sl - Read the active TP and SL trigger prices for the authed trader

Referral

• get_rev_share_stats - Accrued / claimed / claimable rev-share for the authed trader
• claim_rev_share - Debit accrued balance and queue the on-chain vault credit
• get_referral_leaderboard_count - Top referrers ranked by number of referees
• get_referral_leaderboard_earnings - Top referrers ranked by lifetime rev-share USD

Risk

• get_liquidation_status - Check liquidation status for a trader

Webhooks

• create_webhook - Register a webhook
• list_webhooks - List registered webhooks
• delete_webhook - Delete a webhook

WebSocket

• get_web_socket_info - Get WebSocket endpoint metadata

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from gamegains_sdk import GameGains
from gamegains_sdk.utils import BackoffStrategy, RetryConfig


with GameGains() as game_gains:

    res = game_gains.auth.create_api_key(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from gamegains_sdk import GameGains
from gamegains_sdk.utils import BackoffStrategy, RetryConfig


with GameGains(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
) as game_gains:

    res = game_gains.auth.create_api_key()

    # Handle response
    print(res)

Error Handling

GameGainsError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
err.message	str	Error message
err.status_code	int	HTTP response status code eg 404
err.headers	httpx.Headers	HTTP response headers
err.body	str	HTTP body. Can be empty string if no body is returned.
err.raw_response	httpx.Response	Raw HTTP response
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

from gamegains_sdk import GameGains, errors


with GameGains() as game_gains:
    res = None
    try:

        res = game_gains.auth.create_api_key()

        # Handle response
        print(res)


    except errors.GameGainsError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.ErrorResponse):
            print(e.data.error)  # models.Error

Error Classes

Primary errors:

• GameGainsError: The base class for HTTP error responses.
  • ErrorResponse: Generic error.

Less common errors (5)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from GameGainsError:

• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Description
0	https://api.gamegains.gg	Production (active chain via GET /exchange-info; currently Base Sepolia 84532)
1	http://localhost:3000	Local dev

Example

from gamegains_sdk import GameGains


with GameGains(
    server_idx=0,
) as game_gains:

    res = game_gains.auth.create_api_key()

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from gamegains_sdk import GameGains


with GameGains(
    server_url="http://localhost:3000",
) as game_gains:

    res = game_gains.auth.create_api_key()

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from gamegains_sdk import GameGains
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = GameGains(client=http_client)

or you could wrap the client with your own custom logic:

from gamegains_sdk import GameGains
from gamegains_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = GameGains(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The GameGains class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from gamegains_sdk import GameGains
def main():

    with GameGains() as game_gains:
        # Rest of application here...


# Or when using async:
async def amain():

    async with GameGains() as game_gains:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from gamegains_sdk import GameGains
import logging

logging.basicConfig(level=logging.DEBUG)
s = GameGains(debug_logger=logging.getLogger("gamegains_sdk"))

You can also enable a default debug logger by setting an environment variable GAMEGAINS_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy