Quickstart

Get your API key and make your first call in under 60 seconds.

1. Sign in and get your API key

Click "Sign in with GitHub" on the dashboard. Your API key will be generated automatically.

2. Make your first API call

cURL

curl -X POST https://theindex.dev/api/v1/analyze \
  -H "Authorization: Bearer idx_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://vercel.com"}'

JavaScript / Node.js

const response = await fetch("https://theindex.dev/api/v1/analyze", {
  method: "POST",
  headers: {
    "Authorization": "Bearer idx_live_YOUR_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({ url: "https://vercel.com" })
});

const data = await response.json();
console.log(data.company.name);     // "Vercel"
console.log(data.tech_stack);        // { frameworks: ["React", "Next.js"], ... }
console.log(data.contact.emails);    // ["support@vercel.com"]

Python

import requests

response = requests.post(
    "https://theindex.dev/api/v1/analyze",
    json={"url": "https://vercel.com"},
    headers={"Authorization": "Bearer idx_live_YOUR_KEY"}
)

data = response.json()
print(data["company"]["name"])       # "Vercel"
print(data["tech_stack"])            # {"frameworks": ["React", "Next.js"], ...}
print(data["contact"]["emails"])     # ["support@vercel.com"]

3. Check your usage

curl https://theindex.dev/api/v1/usage \
  -H "Authorization: Bearer idx_live_YOUR_KEY"

Returns your current month's usage, remaining calls, and plan tier.

Next Steps