API

Overview and authentication

The Iris engine as a JSON API: the same analyses and traces as the site, for your own code.

SDKs

The official clients wrap every route below, typed, with a riskSummary (risk_summary in Python) that reduces a report to what a bot needs: bundle and dev holdings, launch kit and score. Prefer raw HTTP? The examples below need nothing installed.

View on GitHub
Install
1npm install github:iris-intel-app/sdk-js

Coming to npm and PyPI. Until then, install from GitHub.

check-token.ts
1import { Iris, riskSummary } from "@iriscan/sdk";2 3const iris = new Iris({ apiKey: process.env.IRIS_API_KEY });4 5const report = await iris.analyze("<token mint>");   // 1 analysis6console.log(report.risk.level, report.risk.score);   // "HIGH" 827 8const scan = await iris.launchTool("<dev wallet>");  // 5 credits9if (scan.verdict !== "none") console.log(`Made with ${scan.tool_name}`);10console.log(riskSummary(report).bundleHeldPct);

Both read IRIS_API_KEY from the environment. Create a key in your account.

iris-guard: a pre-trade rug filter for Solana bots, built on the SDK.

Base URL

Every route lives under one base URL. Requests and responses are JSON; send Content-Type: application/json with a body.

base url
1https://iriscan.app/api

Authentication

Create a key in Account → API (see API keys) and send it with every request, either way:

headers
1Authorization: Bearer iris_live_…2# or3x-api-key: iris_live_…

/status is public. Everything else answers 401 without a valid key. The API and MCP come with the Pro plan and above: on a plan without them a call answers 403 plan_required.

Keep keys secret

A key spends your account's API credits. Keep it on your server, never in a web page or an app people can download. Revoke it at once if it leaks.

Your first call

analyze.sh
1curl -X POST https://iriscan.app/api/analyze \2  -H "Authorization: Bearer $IRIS_KEY" \3  -H "Content-Type: application/json" \4  -d '{ "address": "sy88tvipKfaCTuVVeU2PczPa88hqgPfKnYQyCHboHP8" }'
analyze.py
1import os2import requests3 4profile = requests.post(5    "https://iriscan.app/api/analyze",6    headers={"Authorization": f"Bearer {os.environ['IRIS_KEY']}"},7    json={"address": "sy88tvipKfaCTuVVeU2PczPa88hqgPfKnYQyCHboHP8"},8    timeout=130,9).json()10 11print(profile["identity"]["type"], profile["risk"]["level"])
analyze.ts
1const res = await fetch("https://iriscan.app/api/analyze", {2  method: "POST",3  headers: {4    Authorization: `Bearer ${process.env.IRIS_KEY}`,5    "Content-Type": "application/json",6  },7  body: JSON.stringify({ address: "sy88tvipKfaCTuVVeU2PczPa88hqgPfKnYQyCHboHP8" }),8});9 10if (!res.ok) throw new Error((await res.json()).error);11const profile = await res.json();

Routes

RouteDoesCost
POST /analyzeIdentity, risk and evidence for a wallet, a program or a token.1 analysis, 2 above 1,000 transactions
POST /traceWhere a transfer through a mixer or an exchange came out.1 trace, or 3 credits
POST /insidersA token's insiders: wallets its creator is linked to by money.2 analyses, or 2 credits
POST /followThe main stream of money out of a wallet, hop by hop, to where it ends.2 analyses, or 2 credits
POST /launch-toolWhether a wallet launched or traded with a launch kit, with the evidence.5 analyses, or 5 credits (1 a day included on the free tier; 10 a day on Investigator, 30 on Pro; included on Team)
POST /victimsEvery wallet a drainer took funds from, with what each lost.3 analyses, or 3 credits
GET /statusThe health of the API and what it relies on.Free, public
GET /billing/accountYour plan, allowance left and credits.Free
GET /billing/usage/{days}What you used per day, 7 to 365 days back.Free

Credits left

Every /analyze, /trace, /insiders, /follow and /victims response, failures included, carries an x-iris-credits header: what your account has left after the call.

x-iris-credits
1{2  "plan": "api_pro",3  "plan_name": "API Growth",4  "cycle": "monthly",5  "analyses_left": 9412,6  "traces_left": 488,7  "pack_credits": 0,8  "period_end": "2026-10-29T00:00:00Z",9  "paid_until": "2026-10-29T00:00:00Z"10}

Call limits

The API and MCP come with Pro ($299 a month) and above. Pro includes 1,000 API credits a month; a call spends its weight (an analysis 1, 2 over 1,000 transactions, a trace 3, insiders and following the funds 2, a fan-out map 4 per 100 wallets, a launch-kit scan 5, a bridge lookup 1; transaction summaries and chain checks are free up to 1,000 a month, then 1; connections are free), and more credits cost $0.10 each, in packs that never expire. Calls are also limited to 500 per 10 minutes; past it, a call gets 429 with the code quota_exceeded and is not charged. Out of API credits, a call gets 402 api_credits_exhausted; on a plan without the API, 403 plan_required. Plans no longer sold that had the API keep it as before. The website is never limited by this. Headers and codes: Errors and limits.