> For the complete documentation index, see [llms.txt](https://docs.antivamp.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.antivamp.io/developers/overview.md).

# Developer Overview

The AntiVamp Partner API at a glance — base URL, environments, authentication, and the endpoint groups you'll build against.

> **One base URL. Two isolated environments. Signed decisions you can verify offline.**

The **AntiVamp Partner API** lets you validate token launches, verify signed decisions and webhooks, report lifecycle events, and read live chain and identity state. It is a server-side REST API with a first-party TypeScript SDK, self-serve sandbox keys, and a machine-readable OpenAPI spec.

{% hint style="info" %}
📡 View the machine-readable endpoint reference at [AntiVamp API](https://antivamp.io/api).
{% endhint %}

## At a glance

<table><thead><tr><th width="220">Property</th><th>Value</th></tr></thead><tbody><tr><td>🌐 <strong>Base URL</strong></td><td><code>https://antivamp.io</code> — all API paths live under <code>/api/v1</code></td></tr><tr><td>📄 <strong>OpenAPI</strong></td><td><code>GET https://antivamp.io/api/v1/openapi</code> (OpenAPI 3.1.0, <em>AntiVamp Partner API</em>)</td></tr><tr><td>🔑 <strong>Auth</strong></td><td><code>Authorization: Bearer &#x3C;key></code> — sandbox <code>av_sbx_…</code> / production <code>av_live_…</code></td></tr><tr><td>🌱 <strong>Environments</strong></td><td>Sandbox and production run on <strong>physically separate databases</strong></td></tr><tr><td>📦 <strong>SDK</strong></td><td><code>@antivamp_io/sdk</code> (Node.js ≥ 18, server-side only, zero runtime dependencies)</td></tr><tr><td>✍️ <strong>Decisions</strong></td><td>Ed25519-signed, expire after 5 minutes, verifiable offline</td></tr><tr><td>🔔 <strong>Webhooks</strong></td><td>HMAC-SHA256 signed with a per-endpoint secret</td></tr><tr><td>📮 <strong>Contact</strong></td><td><a href="mailto:partners@antivamp.io">partners@antivamp.io</a> · <a href="mailto:support@antivamp.io">support@antivamp.io</a> · <a href="mailto:security@antivamp.io">security@antivamp.io</a></td></tr></tbody></table>

## Authentication in one glance

Every partner endpoint takes a Bearer key. Get a sandbox key in seconds, self-serve; production keys are operator-provisioned after review.

{% tabs %}
{% tab title="cURL" %}

```bash
curl https://antivamp.io/api/v1/launches/validate \
  -H "Authorization: Bearer av_sbx_your_key" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: idem_$(uuidgen)" \
  -d '{"chain":"solana","name":"Green Robin","ticker":"ROBIN","launcher":"So1ana…wallet"}'
```

{% endtab %}

{% tab title="TypeScript (SDK)" %}

```ts
import { AntiVampClient } from "@antivamp_io/sdk";

const antivamp = new AntiVampClient({
  apiKey: process.env.ANTIVAMP_API_KEY, // av_sbx_… or av_live_…
});

const result = await antivamp.enforceLaunch({
  chain: "solana",
  name: "Green Robin",
  ticker: "ROBIN",
  launcher: "So1ana…wallet",
});
if (!result.enforceable) blockLaunch(result.userMessage);
```

{% endtab %}
{% endtabs %}

{% hint style="danger" %}
🚨 API keys are **server-side only**. Never ship a key in browser code, mobile apps, or any `NEXT_PUBLIC_*` variable. See [Authentication](/developers/authentication.md).
{% endhint %}

## Endpoint groups

<table><thead><tr><th width="220">Group</th><th>What it does</th><th width="120">Access</th></tr></thead><tbody><tr><td>🧬 <strong>Identity</strong></td><td>Read-only availability + status for a normalized <code>Name + Ticker</code></td><td>Public</td></tr><tr><td>✅ <strong>Validation</strong></td><td>Signed <code>allow</code> / <code>block</code> / … decision at launch time</td><td>Partner</td></tr><tr><td>📣 <strong>Reporting</strong></td><td>Record launches and market-cap-goal events (bond, milestone)</td><td>Partner</td></tr><tr><td>🔒 <strong>Reservations</strong></td><td>Quote, prepare, and read reservation state</td><td>Public + Partner</td></tr><tr><td>✍️ <strong>Signed decisions</strong></td><td>Public keys + a hosted verify endpoint</td><td>Public</td></tr><tr><td>🔔 <strong>Webhooks</strong></td><td>Register endpoints, manage secrets, inspect and replay deliveries</td><td>Partner</td></tr><tr><td>🧪 <strong>Sandbox</strong></td><td>Self-serve keys, request logs, and usage</td><td>Public + Partner</td></tr><tr><td>⛓️ <strong>Chains &#x26; Health</strong></td><td>Live per-chain status and service health</td><td>Public</td></tr></tbody></table>

See the [API Overview](/developers/api-overview.md) for the grouped endpoint index, or the [API Reference](/developers/api-reference.md) for the full list with methods.

## The core flow

```mermaid
flowchart LR
  A["🎨 Creator commits<br/>name + ticker"] --> B["✅ validateLaunch<br/>(signed decision)"]
  B --> C{"enforceable?"}
  C -->|allow| D["🚀 Deploy token"]
  C -->|block / fail closed| E["🛑 Reject"]
  D --> F["📣 reportLaunch"]
  F --> G["📈 reportBond / reportMilestone<br/>(market-cap-goal locks)"]
  G --> H["🔔 Webhooks update your UI"]
```

Validate at the moment a creator commits — after they pick a name + ticker, before you deploy. Enforce the returned decision, then report the launch and its market-cap-goal events so protection extends across the whole network. A bare launch grants **no** lock; copycat locks are triggered by market-cap goals and are always time-limited.

## Supported chains

`🟪 solana` `🔵 base` (8453) `🟡 bnb` (56) `🟢 robinhood` (4663) `⚪ ethereum` (1) `🟣 hyperliquid` (999)

Call `GET /api/v1/chains` for live status — only send chains AntiVamp reports as live.

***

## Continue exploring

* 🏗️ [Architecture](/developers/architecture.md) — request flow, signed decisions, and fail-closed philosophy
* 🔑 [Authentication](/developers/authentication.md) — Bearer keys, prefixes, and key hygiene
* 🌐 [Environments](/developers/environments.md) — sandbox vs. production isolation
* 📡 [API Overview](/developers/api-overview.md) — the grouped endpoint index
* 📦 [SDK Reference](/developers/sdk.md) — install, initialize, and every method
* 🔎 [API Reference](/developers/api-reference.md) — the full endpoint list + OpenAPI spec


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.antivamp.io/developers/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.