API Reference

Usage API

Monitor your API quota consumption, view per-endpoint breakdowns, and check your plan limits programmatically.

GET/v1/usage

Example request

bash

curl https://api.hypersearchx.zuhabul.com/v1/usage \
  -H "Authorization: Bearer hsx_your_key"

Response

response.json

{
  "plan": "pro",
  "quota": 100000,
  "used": 12847,
  "remaining": 87153,
  "reset_at": "2025-07-01T00:00:00Z",
  "per_minute_limit": 500,
  "endpoints": {
    "search": 10234,
    "research": 1892,
    "scrape": 721
  },
  "daily": [
    { "date": "2025-06-19", "requests": 542 },
    { "date": "2025-06-20", "requests": 891 }
  ]
}

Health endpoint

GET/health

The health endpoint does not require authentication. Returns 200 OK when all dependencies are healthy, 503 if any critical dependency is down.

bash

curl https://api.hypersearchx.zuhabul.com/health

json

{
  "status": "healthy",
  "version": "1.0.0",
  "uptime_seconds": 86400,
  "dependencies": {
    "search_backend": "healthy",
    "database": "healthy"
  }
}

Next steps

Rate Limits →

Quotas and retry strategies

Search API →

Full search reference