NetKrypton API Documentation

NetKrypton API Documentation

Welcome to the NetKrypton API documentation. This guide provides all the necessary information to integrate our domain threat intelligence service into your applications.

1. Overview

The NetKrypton API allows you to verify if a domain is flagged for security threats, such as phishing or malware.

  • Base URL: https://cloud.netkrypton.com

  • Data Format: JSON

  • Encoding: UTF-8

2. Authentication

Every request must be authenticated using your unique API key. You can provide the key using one of the following methods:

  • URL Query Parameter (Recommended): ?key=YOUR_API_KEY

  • HTTP Header: X-API-Key: YOUR_API_KEY

  • Bearer Token: Authorization: Bearer YOUR_API_KEY

3. Domain Check Endpoint

Retrieve security status for a specific domain.

Endpoint: GET /api.php?domain={domain}&key={your_key}

Query Parameters

Parameter Type Required Description
domain string Yes The domain to check (e.g., example.com)
key string Yes Your API key

Response Examples

Threat Detected (HTTP 200)

JSON
{
  "domain": "example.com",
  "threat": true,
  "threat_type": "phishing",
  "approved_at": "2026-06-01T14:32:00Z"
}

Safe Domain (HTTP 200)

JSON
{
  "domain": "example.com",
  "threat": false
}

4. Response Codes & Rate Limiting

HTTP Status Codes

  • 200 OK: Success.

  • 400 Bad Request: Invalid domain format or missing parameters.

  • 401 Unauthorized: Invalid or missing API key.

  • 429 Too Many Requests: Monthly quota exceeded.

Rate Limit Headers

Every response includes headers to monitor your usage:

  • X-RateLimit-Limit: Your plan's monthly request quota.

  • X-RateLimit-Remaining: Number of requests remaining in the current month.

  • X-Plan: Your current subscription tier.

5. Subscription Tiers

Usage resets on the first day of each month.

Plan Monthly Requests
Developer 5,000
Pro 50,000
Business 500,000