API Documentation
Programmatic access to Zondex search data. All endpoints return JSON and require no authentication for basic usage. Pro & Enterprise plans unlock higher rate limits and export capabilities.
link Base URL
All endpoints are relative to this base URL. Pass your API key via the X-API-Key header when authenticating.
/api/search/
Search the Zondex index. Supports the full dork syntax. Returns paginated results (20 per page).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Search query (dork syntax) |
| page | int | No | Page number (default: 1) |
Example
Response
/api/facets/
Returns aggregated facet counts for a search query. Useful for building dashboards and understanding data distribution.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Search query (dork syntax) |
Example
Response
/api/export/
Export search results as CSV or JSON file. Maximum rows depend on your plan (Pro: 10,000, Enterprise: unlimited). Requires authentication.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Search query (dork syntax) |
| format | string | No | csv (default) or json |
Example
Notes
- CSV response has
Content-Disposition: attachmentheader. - JSON export wraps results in
{"results": [...], "total": N, "query": "..."}. - Results are sorted by
scan_date DESC.
/api/ai-search/
Converts a natural language query into Zondex dork syntax using Google Gemini Flash. Optionally returns search results alongside the generated dork.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Natural language query |
| results | bool | No | true or 1 to include search results |
Example
Response
Notes
- Results are cached for 5 minutes per unique query.
- Available on Pro and Enterprise plans.
/api/autocomplete/
Returns autocomplete suggestions for service names and product names matching the query prefix. Minimum 2 characters required.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| q | string | Yes | Search prefix (min 2 chars) |
Example
Response
error_outline Error Responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request — missing or invalid parameters | {"error": "..."} |
| 403 | Forbidden — rate limit exceeded or feature not in plan | {"error": "..."} |
| 500 | Internal Server Error | {"error": "..."} |
speed Rate Limits
API rate limits depend on your plan. Exceeding your limit returns a 403 response.
| Plan | Daily API calls | Export rows |
|---|---|---|
| Free | 5 | N/A |
| Starter | 100 | N/A |
| Pro | Unlimited | 10,000 |
| Enterprise | Unlimited | Unlimited |