---
title: "NimbusMint Partner API"
description: "Read mint activity for your app from your own servers, with a private key and an IP allowlist."
canonical: "https://docs.nimbusmint.bot/"
---
> Index: https://docs.nimbusmint.bot/llms.txt

# NimbusMint Partner API

Read mint activity for your app from your own servers, with a private key and an IP allowlist.

### 1. Get keys

Request access with the form or a ticket in the NimbusMint Discord. We issue a **private key** for your
server. [Get API keys](https://docs.nimbusmint.bot/get-keys.md)

### 2. Allowlist your IPs

Send us the egress IPs of the servers that will call the API. Requests from any other address are
refused. [IP allowlist](https://docs.nimbusmint.bot/authentication.md#ip-allowlist)

### 3. Make a request

```sh
curl https://api.nimbusmint.bot/partner/v1/health \
  -H "Authorization: Bearer $NIMBUS_PRIVATE_KEY"
```
[Quick start](https://docs.nimbusmint.bot/quick-start.md)