Skip to main content

Gmt Python API library

PyPI version

The Gmt Python library provides convenient access to the Gmt REST API from any Python 3.9+ application. The library includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.

GMT maintains the public client and generates its internal routes from OpenAPI.

Documentation

See the GMT API reference for endpoints and SDK examples.

Installation

# install from PyPI
pip install gmt-python-sdk

Usage

from gmt import Gmt

client = Gmt()

response = client.service.health_check()
print(response.now)

While you can provide an api_key keyword argument, we recommend using python-dotenv to add GMT_API_KEY="My API Key" to your .env file so that your API Key is not stored in source control.

Async usage

Simply import AsyncGmt instead of Gmt and use await with each API call:

import asyncio
from gmt import AsyncGmt

client = AsyncGmt()


async def main() -> None:
    response = await client.service.health_check()
    print(response.now)


asyncio.run(main())

Functionality between the synchronous and asynchronous clients is otherwise identical.

With aiohttp

By default, the async client uses httpx for HTTP requests. However, for improved concurrency performance you may also use aiohttp as the HTTP backend.

You can enable this by installing aiohttp:

# install from PyPI
pip install gmt-python-sdk[aiohttp]

Then you can enable it by instantiating the client with http_client=DefaultAioHttpClient():

import asyncio
from gmt import DefaultAioHttpClient
from gmt import AsyncGmt


async def main() -> None:
    async with AsyncGmt(
        http_client=DefaultAioHttpClient(),
    ) as client:
        response = await client.service.health_check()
        print(response.now)


asyncio.run(main())

Using types

Nested request parameters are TypedDicts. Responses are Pydantic models which also provide helper methods for things like:

  • Serializing back into JSON, model.to_json()
  • Converting to a dictionary, model.to_dict()

Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set python.analysis.typeCheckingMode to basic.

Pagination

List methods in the Gmt API are paginated.

This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:

from gmt import Gmt

client = Gmt()

all_purchases = []
# Automatically fetches more pages as needed.
for purchase in client.purchases.list(
    page=1,
    page_size=100,
    sort="date_desc",
):
    # Do something with purchase here
    all_purchases.append(purchase)
print(all_purchases)

Or, asynchronously:

import asyncio
from gmt import AsyncGmt

client = AsyncGmt()


async def main() -> None:
    all_purchases = []
    # Iterate through items across all pages, issuing requests as needed.
    async for purchase in client.purchases.list(
        page=1,
        page_size=100,
        sort="date_desc",
    ):
        all_purchases.append(purchase)
    print(all_purchases)


asyncio.run(main())

Alternatively, you can use the .has_next_page(), .next_page_info(), or .get_next_page() methods for more granular control working with pages:

first_page = await client.purchases.list(
    page=1,
    page_size=100,
    sort="date_desc",
)
if first_page.has_next_page():
    print(f"will fetch next page using these details: {first_page.next_page_info()}")
    next_page = await first_page.get_next_page()
    print(f"number of items we just fetched: {len(next_page.items)}")

# Remove `await` for non-async usage.

Or just work directly with the returned data:

first_page = await client.purchases.list(
    page=1,
    page_size=100,
    sort="date_desc",
)

print(f"page number: {first_page.pagination.current_page}")  # => "page number: 1"
for purchase in first_page.items:
    print(purchase.id)

# Remove `await` for non-async usage.

Handling errors

When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of gmt.APIConnectionError is raised.

When the API returns a non-success status code (that is, 4xx or 5xx response), a subclass of gmt.APIStatusError is raised, containing status_code and response properties.

All errors inherit from gmt.APIError.

import gmt
from gmt import Gmt

client = Gmt()

try:
    client.service.health_check()
except gmt.APIConnectionError as e:
    print("The server could not be reached")
    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
except gmt.RateLimitError as e:
    print("A 429 status code was received; we should back off a bit.")
except gmt.APIStatusError as e:
    print("Another non-200-range status code was received")
    print(e.status_code)
    print(e.response)

Error codes are as follows:

Status Code Error Type
400 BadRequestError
401 AuthenticationError
403 PermissionDeniedError
404 NotFoundError
422 UnprocessableEntityError
429 RateLimitError
>=500 InternalServerError
N/A APIConnectionError

Retries

Certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors are all retried by default.

You can use the max_retries option to configure or disable retry settings:

from gmt import Gmt

# Configure the default for all requests:
client = Gmt(
    # default is 2
    max_retries=0,
)

# Or, configure per-request:
client.with_options(max_retries=5).service.health_check()

Timeouts

By default requests time out after 1 minute. You can configure this with a timeout option, which accepts a float or an httpx.Timeout object:

from gmt import Gmt

# Configure the default for all requests:
client = Gmt(
    # 20 seconds (default is 1 minute)
    timeout=20.0,
)

# More granular control:
client = Gmt(
    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)

# Override per-request:
client.with_options(timeout=5.0).service.health_check()

On timeout, an APITimeoutError is thrown.

Note that requests that time out are retried twice by default.

Advanced

Logging

We use the standard library logging module.

You can enable logging by setting the environment variable GMT_LOG to info.

$ export GMT_LOG=info

Or to debug for more verbose logging.

How to tell whether None means null or missing

In an API response, a field may be explicitly null, or missing entirely; in either case, its value is None in this library. You can differentiate the two cases with .model_fields_set:

if response.my_field is None:
  if 'my_field' not in response.model_fields_set:
    print('Got json like {}, without a "my_field" key present at all.')
  else:
    print('Got json like {"my_field": null}.')

Accessing raw response data (e.g. headers)

The "raw" Response object can be accessed by prefixing .with_raw_response. to any HTTP method call, e.g.,

from gmt import Gmt

client = Gmt()
response = client.service.with_raw_response.health_check()
print(response.headers.get('X-My-Header'))

service = response.parse()  # get the object that `service.health_check()` would have returned
print(service.now)

These methods return an APIResponse object.

The async client returns an AsyncAPIResponse with the same structure, the only difference being awaitable methods for reading the response content.

.with_streaming_response

The above interface eagerly reads the full response body when you make the request, which may not always be what you want.

To stream the response body, use .with_streaming_response instead, which requires a context manager and only reads the response body once you call .read(), .text(), .json(), .iter_bytes(), .iter_text(), .iter_lines() or .parse(). In the async client, these are async methods.

with client.service.with_streaming_response.health_check() as response:
    print(response.headers.get("X-My-Header"))

    for line in response.iter_lines():
        print(line)

The context manager is required so that the response will reliably be closed.

Making custom/undocumented requests

This library is typed for convenient access to the documented API.

If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can make requests using client.get, client.post, and other http verbs. Options on the client will be respected (such as retries) when making this request.

import httpx

response = client.post(
    "/foo",
    cast_to=httpx.Response,
    body={"my_param": True},
)

print(response.headers.get("x-foo"))

Undocumented request params

If you want to explicitly send an extra param, you can do so with the extra_query, extra_body, and extra_headers request options.

Undocumented response properties

To access undocumented response properties, you can access the extra fields like response.unknown_prop. You can also get all the extra fields on the Pydantic model as a dict with response.model_extra.

Configuring the HTTP client

You can directly override the httpx client to customize it for your use case, including:

import httpx
from gmt import Gmt, DefaultHttpxClient

client = Gmt(
    # Or use the `GMT_BASE_URL` env var
    base_url="http://my.test.server.example.com:8083",
    http_client=DefaultHttpxClient(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

You can also customize the client on a per-request basis by using with_options():

client.with_options(http_client=DefaultHttpxClient(...))

Managing HTTP resources

By default the library closes underlying HTTP connections whenever the client is garbage collected. You can manually close the client using the .close() method if desired, or with a context manager that closes when exiting.

from gmt import Gmt

with Gmt() as client:
  # make requests here
  ...

# HTTP client is now closed

Versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes that only affect static types, without breaking runtime behavior.
  2. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Determining the installed version

If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.

You can determine the version that is being used at runtime with:

import gmt
print(gmt.__version__)

Requirements

Python 3.9 or higher.

Contributing

Use the SDK repository linked in the package metadata to report issues.

Metadata

Release files for gmt-python-sdk 0.44.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gmt-python-sdk 0.44.3
File Size Uploaded Provenance Actions
gmt_python_sdk-0.44.3.tar.gz 86.4 kB With provenance Details for gmt_python_sdk-0.44.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for gmt-python-sdk 0.44.3
File Interpreter ABI Platform Actions
gmt_python_sdk-0.44.3-py3-none-any.whl Python 3 none any Details for gmt_python_sdk-0.44.3-py3-none-any.whl

Total release size: 220.2 kB

Release files / gmt_python_sdk-0.44.3.tar.gz

Download URL gmt_python_sdk-0.44.3.tar.gz
Size 86.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a8a10c2548f5b667d652bd1e19de0b741f37786bc51c23ecee812298782e779d
BLAKE2b-256 checksum
How to use checksums
42ae6a2b5f0b36da37cabd6056e91be654ef555529524cd9873ef904a1e6c5c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.

Transparency log

Release files / gmt_python_sdk-0.44.3-py3-none-any.whl

Download URL gmt_python_sdk-0.44.3-py3-none-any.whl
Size 133.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
50dff3fa1db1beb60d471d87e63c0e3e3f5e1558c49ef8afbf95d6d3f9acb882
BLAKE2b-256 checksum
How to use checksums
0020b521566b202cc4f15abbccc517438c08ed49414a45d4916e64d6e41c0e60
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.

Transparency log

Security for gmt-python-sdk 0.44.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for gmt_python_sdk-0.44.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 10, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.44.3 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page