How to Use the API
Authentication
All API requests require an API Key for authentication. Your API Key is your account's password. Treat it as confidential.
- Header: X-API-KEY: Recommended method. Include your API Key in the `X-API-KEY` header.
- Query Parameter: api_key: Alternative method for quick testing. Include your API Key as `?api_key=YOUR_KEY` in the URL. Less secure for production.
Unauthorized requests will receive a `401 Unauthorized` response.
List Available Datasets
Retrieve a list of all available data files on the platform, including their metadata.
Endpoint:
/api.php?endpoint=datasets/list
Parameters:
limit(integer) - Optional: Maximum number of datasets to return. (Default: 100)offset(integer) - Optional: Offset for pagination. (Default: 0)
Access & Limitations by Plan:
- Free Plan: Limited to showing only the 1 latest dataset of each type in the listing.
- Pro Plan: Full list of datasets.
- Enterprise Plan: Full list of datasets.
Example Request:
GET /api.php?endpoint=datasets/list&api_key=YOUR_PASSWORD
Example Response (truncated):
{"total_results": 3, "limit": 100, "offset": 0, "datasets": [ {"type": "daily_ct_log", "name": "2025-07-30_domains.txt", ...} ]}
Get Latest Daily Domain Dumps (CT Logs)
Retrieve the most recent daily domain dump from Certificate Transparency (CT) Logs.
Endpoint:
/api.php?endpoint=domains/latest
Parameters:
limit(integer) - Optional: Maximum number of domain lines to return. (Default: 100)offset(integer) - Optional: Offset for pagination. (Default: 0)
Access & Limitations by Plan:
- Free Plan: Limited to 100 domain lines per request.
- Pro Plan: Limited to 5000 domain lines per request.
- Enterprise Plan: Unlimited domain lines per request.
Example Request:
GET /api.php?endpoint=domains/latest&api_key=YOUR_PASSWORD&limit=50
Example Response (truncated):
{"domains": ["example.com", "sub.domain.net", ...]}
Get Domains by Date (Historical Data)
Retrieve domain data for a specific historical date.
Endpoint:
/api.php?endpoint=domains/by-date
Parameters:
date(string (YYYY-MM-DD)) - Required: The specific date for which to retrieve domain data.limit(integer) - Optional: Maximum number of domain lines to return. (Default: 100)offset(integer) - Optional: Offset for pagination. (Default: 0)
Access & Limitations by Plan:
- Free Plan: Limited to data from the last 7 days only, and 100 domain lines per request.
- Pro Plan: Access to historical data up to 365 days, and 5000 domain lines per request.
- Enterprise Plan: Unlimited historical data access and unlimited domain lines per request.
Example Request:
GET /api.php?endpoint=domains/by-date&date=2025-07-25&api_key=YOUR_PASSWORD
Example Response (truncated):
{"domains": ["olddomain.org", "another.example.com", ...]}
Get Domains by Extension (TLD)
Retrieve domain data for a specific Top-Level Domain (TLD) extension.
Endpoint:
/api.php?endpoint=domains/by-extension
Parameters:
extension(string) - Required: The TLD extension (e.g., `com`, `org`, `net`, `id`).limit(integer) - Optional: Maximum number of domain lines to return. (Default: 100)offset(integer) - Optional: Offset for pagination. (Default: 0)
Access & Limitations by Plan:
- Free Plan: Access limited to common TLDs (.com, .org, .net), and 100 domain lines per request.
- Pro Plan: Access to all available TLDs, and 5000 domain lines per request.
- Enterprise Plan: Access to all available TLDs and unlimited domain lines per request.
Example Request:
GET /api.php?endpoint=domains/by-extension&extension=id&api_key=YOUR_PASSWORD
Example Response (truncated):
{"domains": ["mywebsite.id", "blog.id", ...]}