API Documentation

Integrate our powerful search capabilities directly into your applications.

API access is available for Monthly Plus subscribers only.

API Overview

Our REST API provides programmatic access to the same powerful search capabilities available in our web interface. Use our API to integrate breach data monitoring into your own applications, dashboards, or security tools.

Base URL

https://api.checkmaasystem.com/api

Rate Limits

API usage is subject to the following rate limits:

3 requests per second - UNLIMITED - To prevent abuse and ensure optimal performance

When you exceed a rate limit, the API will return a 429 Too Many Requests status code with a Retry-After header.

Response Format

All API responses are returned in JSON format with the following structure:

{
  "success": true,  // boolean indicating if the request was successful
  "results": {},    // contains the actual data (varies by endpoint)
  ...               // additional fields specific to each endpoint
}

Error Handling

When an error occurs, the API will return an error response with the following structure:

{
  "error": "Error message describing what went wrong",
  "status_code": 400  // HTTP status code
}

Common HTTP Status Codes

200 OK - Request successful
400 Bad Request - Invalid request parameters
401 Unauthorized - Missing or invalid API key
403 Forbidden - Insufficient permissions or plan restrictions
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Server error