REST API

Build With Security Data.
Your Tools, Our Intelligence.

Integrate security search, content retrieval, and alert management directly into your security tools and workflows via our REST API.

Terminal
$ curl request
GET /api/v1/search?q=example.com
Authorization: Bearer 1|a8kF9x••••
20042ms
{
"success": true,
"data": {
"detected_type": "domain",
"total": 247,
"results": [ ... 20 items ]
}
}

Demo data shown for illustration purposes

API Endpoints

Key endpoints available in the ReconX API.

GET/api/v1/search
GET/api/v1/search/content
GET/api/v1/search/filters
GET/api/v1/search/sources
GET/api/v1/search/stats
GET/api/v1/search/quota
POST/api/v1/alerts
GET/api/v1/alerts

What You Get

Everything included with the ReconX API.

Token Authentication

Sanctum-based bearer tokens with configurable expiration. Up to 5 active tokens per account.

Rate Limiting

60 requests/minute general, 5/minute for auth endpoints. Built-in quota management per subscription plan.

RESTful Design

Clean JSON responses with consistent error handling. Standard HTTP methods and status codes.

Interactive Docs

Full API documentation at /docs/api powered by Scramble. Try endpoints directly from the browser.

Advanced Filtering

Search with date range, source type, file type, size, and sensitivity flags. Same power as the web UI.

Secure by Default

HTTPS only, token scoping, automatic rate limiting, and content accessed via secure hashed URLs.

Frequently Asked Questions

How do I get an API token?

Sign up for a ReconX account, go to Account > API, and create a new token. You can set a name, choose an expiration period (7, 30, 60, 90 days, or never), and manage up to 5 active tokens.

What authentication method is used?

ReconX API uses Laravel Sanctum bearer token authentication. Include your token in the Authorization header as "Bearer YOUR_TOKEN" with every request.

What are the rate limits?

The API has a general rate limit of 60 requests per minute. Authentication endpoints are limited to 5 requests per minute. Your subscription plan determines monthly search and content view quotas.

Can I search security data via API?

Yes. The /api/v1/search endpoint accepts a query via the "q" parameter with filters like date_from, date_to, field, file_type, sources, and has_sensitive_data. Results include pagination, detected query type, and content hashes for file access.

Is there an API documentation page?

Yes. Full interactive API documentation powered by Scramble is available at /docs/api. It includes all endpoints, request/response schemas, and example payloads.

Do API requests consume my subscription credits?

Yes. Each search query and content view via API counts toward your plan's monthly limits, just like web searches. You can check your remaining quota via the /api/v1/search/quota endpoint.

Start Building Today

Get your API token and integrate security intelligence into your security workflow.