API Reference

Complete endpoint documentation for The Index API.

Base URL

https://theindex.dev/api/v1

Authentication

All API requests require an API key passed via the Authorization header.

Authorization: Bearer idx_live_your_api_key

POST/analyze

Analyze any website URL and return structured intelligence data.

Request Body

{
  "url": "https://vercel.com",        // Required. The URL to analyze.
  "force_refresh": false               // Optional. Bypass cache (default: false).
}

Response (200 OK)

{
  "url": "https://vercel.com",
  "company": {
    "name": "Vercel",
    "description": "Develop. Preview. Ship.",
    "industry": "SaaS / Software"
  },
  "tech_stack": {
    "cms": [],
    "frameworks": ["React", "Next.js"],
    "analytics": ["Google Analytics", "Segment"],
    "ecommerce": [],
    "hosting": [],
    "cdn": ["Cloudflare"],
    "javascript_libraries": [],
    "payment": [],
    "support": [],
    "server": [],
    "detected_technologies": ["React", "Next.js", "Google Analytics", "Segment", "Cloudflare"]
  },
  "contact": {
    "emails": ["support@vercel.com"],
    "phone_numbers": [],
    "social_links": {
      "twitter": "https://twitter.com/vercel",
      "facebook": null,
      "instagram": null,
      "linkedin": "https://linkedin.com/company/vercel",
      "youtube": null,
      "github": "https://github.com/vercel",
      "tiktok": null
    }
  },
  "meta": {
    "title": "Vercel: Build and deploy the best web experiences",
    "description": "Vercel's Frontend Cloud gives developers frameworks...",
    "og_image": "https://vercel.com/og-image.png",
    "favicon": "https://vercel.com/favicon.ico",
    "language": "en"
  },
  "trust_signals": {
    "has_ssl": true,
    "has_privacy_policy": true,
    "has_terms_of_service": true
  },
  "scraped_at": "2026-03-27T14:30:00Z",
  "cached": false,
  "confidence_score": 0.95
}

Rate Limit Headers

Every response includes rate limit information:

X-RateLimit-Limit: 10          // Max requests per window
X-RateLimit-Remaining: 7       // Remaining requests in this window
X-RateLimit-Reset: 1711549200  // Unix timestamp when window resets

GET/usage

Check your current month's API usage and remaining calls.

Response (200 OK)

{
  "tier": "free",
  "calls_used": 42,
  "calls_remaining": 458,
  "calls_limit": 500,
  "period_start": "2026-03-01T00:00:00.000Z",
  "period_end": "2026-04-01T00:00:00.000Z"
}

Rate Limits

Tier	Monthly Calls	Per Minute
Free	500	10
Starter ($29/mo)	5,000	60
Pro ($99/mo)	50,000	120
Business ($299/mo)	250,000	300
Enterprise ($999/mo)	Unlimited	1,000