---
title: "NimbusMint Partner API (1.0.0)"
description: "API reference."
canonical: "https://docs.nimbusmint.bot/api/"
---
> Index: https://docs.nimbusmint.bot/llms.txt

# NimbusMint Partner API (1.0.0)

Read-only API for NimbusMint partners. Every request is made with a
private key issued by NimbusMint; the data it returns is scoped to the
partner the key belongs to, never to anything named in the request.

**Keys.** A private key is a secret for your servers only. Never ship it
in a browser, mobile app, bot client or any code a user can read. Each key
is bound to an IP allowlist (your servers' public egress addresses), has
scopes, a rate limit and a hard expiry of at most one year. A revoked key
stops working within 10 seconds. Request a key by opening a ticket in the
NimbusMint Discord.

**Request signing.** Keys today authenticate with a bearer token. Signed
requests (Ed25519 over the method, path, body hash, timestamp and nonce)
are planned as an additional scheme; bearer keys keep working.

**Errors.** Every error is JSON `{code, message}`. Branch on `code`;
`message` is for humans and may change. Authentication failures are
always `401 invalid_key`, whatever the reason.

**Versioning.** Changes within v1 are additive only: new optional fields,
new routes, new error codes. Ignore fields you do not know.

Base URL: `https://api.nimbusmint.bot/partner/v1`

Machine-readable contract: [OpenAPI YAML](https://docs.nimbusmint.bot/openapi.yaml) · [OpenAPI JSON](https://docs.nimbusmint.bot/openapi.json).

## Operations

- [GET /hits](https://docs.nimbusmint.bot/api/operations/gethits.md): Successful mints on a contract by NimbusMint users from your app
- [GET /mints](https://docs.nimbusmint.bot/api/operations/getmints.md): Every successful mint on a contract by NimbusMint users from your app, one row each
- [GET /health](https://docs.nimbusmint.bot/api/operations/gethealth.md): Check a key