This repository holds OpenAPI 3.1 descriptions of the MaxMind public web services.
| Product | Bundled spec | Documentation |
|---|---|---|
| GeoIP and GeoLite web services | bundled/geoip.yaml |
dev.maxmind.com |
| minFraud web services | bundled/minfraud.yaml |
dev.maxmind.com |
| Privacy exclusions | bundled/privacy-exclusions.yaml |
dev.maxmind.com |
| License key validation | bundled/license-key-validation.yaml |
dev.maxmind.com |
| Database and geofeed downloads | bundled/downloads.yaml |
dev.maxmind.com |
Each file in bundled/ is self-contained. Use it with API tools and code
generators. The files in specs/, components/, and examples/ are the
sources. Do not edit bundled/ by hand.
The developer documentation is the reference for behavior that OpenAPI cannot describe. MaxMind also publishes official client libraries.
MaxMind can add response fields, error codes, and enum values to response fields without a new API version. Your client must ignore fields that it does not know.
The info.version of each spec follows
Semantic Versioning and tracks changes to the spec. The
API version, for example v2.1, is in the server URL.
The github.com/maxmind/openapi Go package embeds the bundled specs:
spec, err := openapi.Bundled.ReadFile("bundled/geoip.yaml")The tools are pinned with mise.
mise install
pnpm install
pnpm run bundle # regenerate bundled/
precious lint --all # lint the specs and format the filesThis software is Copyright (c) 2026 by MaxMind, Inc.
This is free software, licensed under the Apache License, Version 2.0 or the MIT License, at your option.