API v1

QuantumRank Public API

Access AI visibility scores, trigger assessments, and integrate QuantumRank data into your applications. All endpoints use the same canonical scoring engine as the web product.

API-key authenticated Rate limited & quota-managed RESTful JSON

Base URL

https://api.quantumrank.ai/api/v1/public-api

Authentication

All Public API endpoints require an API key passed in the X-API-Key header. Create keys from your dashboard settings.

Example request

curl https://api.quantumrank.ai/api/v1/public-api/score/smithlaw.com \
  -H "X-API-Key: qr_live_your_key_here"

Rate Limits & Quotas

Each API key has a monthly call quota based on your tier. The GET /usage endpoint returns your current consumption. When you exceed your quota, the API returns 429 Too Many Requests.

Tier	Monthly Quota	Price
Free	10 calls	$0
Pro	100 calls	$97/mo
Enterprise	1,000 calls	$499/mo

Score Lookup

Retrieve the latest cached QRS score for any domain that has been assessed.

GET/score/{domain}

curl https://api.quantumrank.ai/api/v1/public-api/score/smithlaw.com \
  -H "X-API-Key: qr_live_your_key_here"

# Response 200
{
  "domain": "smithlaw.com",
  "qrs_score": 62,
  "tier": "Competitive",
  "pillar_scores": {
    "sf": 55, "rr": 72, "sk": 68,
    "aq": 58, "ea": 65, "iw": 60, "ei": 52
  },
  "last_assessed_at": "2026-03-20T14:30:00Z",
  "scoring_version": "1.0.0"
}

Assessments

Trigger a new 7-pillar assessment. This is an async operation: submit the request, get an assessment ID, then poll for results.

Trigger Assessment

POST/assess

curl -X POST https://api.quantumrank.ai/api/v1/public-api/assess \
  -H "X-API-Key: qr_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "smithlaw.com",
    "company_name": "Smith Law Firm",
    "queries": [
      "best personal injury attorney in Chicago",
      "top-rated car accident lawyer near me"
    ]
  }'

# Response 202
{
  "assessment_id": "abc-123-def-456",
  "status": "processing",
  "poll_url": "/api/v1/public-api/assess/abc-123-def-456"
}

Poll Assessment Status

GET/assess/{assessment_id}

curl https://api.quantumrank.ai/api/v1/public-api/assess/abc-123-def-456 \
  -H "X-API-Key: qr_live_your_key_here"

# Response 200 (completed)
{
  "assessment_id": "abc-123-def-456",
  "status": "completed",
  "domain": "smithlaw.com",
  "qrs_score": 62,
  "tier": "Competitive",
  "pillar_scores": { ... },
  "created_at": "2026-03-20T14:30:00Z",
  "completed_at": "2026-03-20T14:33:12Z"
}

Brand Pages

Retrieve public brand page data from the Quantum Metrix index. Only available for domains that have opted in to public listing.

GET/brand/{domain}

curl https://api.quantumrank.ai/api/v1/public-api/brand/smithlaw.com \
  -H "X-API-Key: qr_live_your_key_here"

# Response 200
{
  "domain": "smithlaw.com",
  "brand_name": "Smith Law Firm",
  "industry": "professional_services",
  "qrs_score": 62,
  "tier": "Competitive",
  "pillar_scores": { ... },
  "last_assessed_at": "2026-03-20T14:30:00Z",
  "scoring_version": "1.0.0"
}

Benchmarks

Get industry benchmark data — average scores, tier distributions, and pillar breakdowns.

GET/benchmarks/{industry}

curl https://api.quantumrank.ai/api/v1/public-api/benchmarks/professional_services \
  -H "X-API-Key: qr_live_your_key_here"

# Response 200
{
  "industry": "professional_services",
  "assessment_count": 247,
  "average_qrs": 59,
  "tier_distribution": {
    "Leader": 0.04, "Competitive": 0.18,
    "Visible": 0.35, "Emerging": 0.28, "Invisible": 0.15
  },
  "pillar_averages": {
    "sf": 58, "rr": 68, "sk": 60,
    "aq": 65, "ea": 58, "iw": 52, "ei": 55
  },
  "last_computed_at": "2026-03-20T00:00:00Z"
}

API Key Management

Manage your API keys programmatically. These endpoints use Bearer JWT authentication (your Supabase session token), not API key auth.

GET/keys

# List your API keys
curl https://api.quantumrank.ai/api/v1/keys \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

POST/keys

# Create a new API key (plaintext shown only once!)
curl -X POST https://api.quantumrank.ai/api/v1/keys \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Integration"}'

DELETE/keys/{key_id}

# Revoke an API key
curl -X DELETE https://api.quantumrank.ai/api/v1/keys/KEY_UUID \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

POST/keys/{key_id}/rotate

# Rotate a key (revoke old, create replacement)
curl -X POST https://api.quantumrank.ai/api/v1/keys/KEY_UUID/rotate \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

MCP Server

QuantumRank is available as an MCP (Model Context Protocol) server for AI coding assistants like Cursor, Claude Code, and Windsurf. The MCP server exposes the same canonical scoring engine as the web product.

Available Tools

Tool	Description
lookup_score	Look up cached QRS score for a domain
run_assessment	Trigger a full 7-pillar assessment
get_brand_page	Get public brand page data
get_benchmarks	Get industry benchmark data

Configuration

Add to your MCP client configuration:

mcp.json

{
  "mcpServers": {
    "quantumrank": {
      "command": "python",
      "args": ["path/to/backend/mcp_server.py"],
      "env": {
        "NEXT_PUBLIC_SUPABASE_URL": "your_supabase_url",
        "SUPABASE_SERVICE_ROLE_KEY": "your_service_key"
      }
    }
  }
}

WordPress Plugin

Display your QRS badge on any WordPress site. The plugin provides a shortcode and widget that show your live score with tier-colored styling.

Quick Start

Upload the quantumrank-badge plugin to your WordPress site
Activate via Plugins menu
Go to Settings → QuantumRank Badge
Enter your API key and domain
Add [quantumrank_badge] to any page, post, or widget area

Shortcode usage

<!-- Basic usage -->
[quantumrank_badge]

<!-- Custom domain -->
[quantumrank_badge domain="otherdomain.com"]

API Tiers

Free

10 calls/month

Score lookups
Benchmark data
Brand page data

Pro

$97/mo

100 calls/month

Everything in Free
Trigger assessments
Priority support

Enterprise

$499/mo

1,000 calls/month

Everything in Pro
MCP server access
Custom quotas
Dedicated support

Ready to integrate?

Create your free API key and start building in minutes.

Get Your API Key