# NimbusMint Partner API

> Read-only, server-to-server API for NimbusMint partners: successful mints ("hits") on a collection booked through your app, and a key check (/health). Base URL: https://api.nimbusmint.bot/partner/v1. Auth: a private API key sent as `Authorization: Bearer nmk_live_<id>_<secret>` from a server whose IP is on the key's allowlist.

## How agents should use these docs

- Fetch the Markdown twin of any page: the links below, or any page URL with `.md` instead of the trailing slash.
- Read [Keys and IP allowlist](https://docs.nimbusmint.bot/authentication.md) before making any call.
- Never put keys in URLs, logs, prompts, commits or client-side code. Read the key from a server-side secret such as `NIMBUS_PRIVATE_KEY`.
- The OpenAPI spec is the contract; if prose and spec disagree, the spec wins: https://docs.nimbusmint.bot/openapi.yaml

## Getting started

- [NimbusMint Partner API](https://docs.nimbusmint.bot/index.md): Read mint activity for your app from your own servers, with a private key and an IP allowlist.
- [Get API keys](https://docs.nimbusmint.bot/get-keys.md): Request access with the form or a NimbusMint Discord ticket; we issue a private key for your server.
- [Quick start](https://docs.nimbusmint.bot/quick-start.md): Make your first Partner API call, then add NimbusMint hits to a Discord /gas command.

## Authentication

- [Keys and IP allowlist](https://docs.nimbusmint.bot/authentication.md): Server-to-server only. How the private key works, what the IP allowlist accepts, and how to keep the key on your server.
- [Request signing](https://docs.nimbusmint.bot/authentication/request-signing.md): Coming soon. Ed25519 signatures over each request, so a leaked log line or database cannot be used to forge or replay your calls.
- [Key rotation](https://docs.nimbusmint.bot/authentication/key-rotation.md): Replace a private key without downtime, before it expires or after a leak.

## API reference

- [OpenAPI 3.1 (YAML)](https://docs.nimbusmint.bot/openapi.yaml): the full contract, source of truth
- [OpenAPI 3.1 (JSON)](https://docs.nimbusmint.bot/openapi.json): the same spec as JSON
- [NimbusMint Partner API (1.0.0)](https://docs.nimbusmint.bot/api.md): API reference.
- [Successful mints on a contract by NimbusMint users from your app](https://docs.nimbusmint.bot/api/operations/gethits.md): GET /hits
- [Every successful mint on a contract by NimbusMint users from your app, one row each](https://docs.nimbusmint.bot/api/operations/getmints.md): GET /mints
- [Check a key](https://docs.nimbusmint.bot/api/operations/gethealth.md): GET /health

## Reference

- [Errors](https://docs.nimbusmint.bot/errors.md): Status codes, error codes and what to do about each.
- [Rate limits](https://docs.nimbusmint.bot/rate-limits.md): Per-key limits, the 429 response, and how caching keeps you under them.
- [Changelog](https://docs.nimbusmint.bot/changelog.md): Changes to the NimbusMint Partner API and these docs.

## Optional

- [Changelog feed (Atom)](https://docs.nimbusmint.bot/changelog.xml): subscribe to API changes
- [All docs in one file](https://docs.nimbusmint.bot/llms-full.txt): every page above, concatenated