Have I Been Pwned

List public HIBP breaches, optionally filtered by domain, spam-list flag, and verification status.

{
  "type": "object",
  "properties": {
    "domain": {
      "description": "Filter to breaches for a specific domain.",
      "type": "string"
    },
    "isSpamList": {
      "description": "Filter to breaches that are or are not flagged as spam lists.",
      "type": "boolean"
    },
    "includeUnverified": {
      "default": true,
      "description": "Include unverified breaches. Defaults to true.",
      "type": "boolean"
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "breaches": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Look up a single public HIBP breach by its canonical breach name, such as Adobe.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The breach name to retrieve, for example Adobe."
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "breach": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Return the most recently added public breach currently loaded into HIBP.

{
  "type": "object",
  "properties": {
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "breach": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

List the data classes used across public HIBP breach models, such as email addresses or passwords.

{
  "type": "object",
  "properties": {
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "dataClasses": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Query the public Pwned Passwords k-anonymity API with a 5-character SHA-1 or NTLM prefix and return matching suffixes with prevalence counts.

{
  "type": "object",
  "properties": {
    "prefix": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{5}$",
      "description": "The first 5 hexadecimal characters of a SHA-1 or NTLM hash."
    },
    "mode": {
      "default": "sha1",
      "description": "Use SHA-1 by default or NTLM when mode is set to ntlm.",
      "type": "string",
      "enum": [
        "sha1",
        "ntlm"
      ]
    },
    "addPadding": {
      "default": false,
      "description": "Send the Add-Padding header and discard padded zero-count entries.",
      "type": "boolean"
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "prefix"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "prefix": {
      "type": "string"
    },
    "mode": {
      "type": "string",
      "enum": [
        "sha1",
        "ntlm"
      ]
    },
    "addPadding": {
      "type": "boolean"
    },
    "matchCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "matches": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "hashSuffix": {
            "type": "string"
          },
          "count": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "hashSuffix",
          "count"
        ],
        "additionalProperties": false
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Search HIBP for breaches affecting a single email address. Requires an OAuth bearer token linked to an active HIBP API subscription; use domain and verification filters to refine the result.

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string",
      "description": "The email address to search for."
    },
    "domain": {
      "description": "Filter results to a specific breach domain.",
      "type": "string"
    },
    "includeUnverified": {
      "default": true,
      "description": "Include unverified breaches. Defaults to true.",
      "type": "boolean"
    },
    "responseMode": {
      "default": "full",
      "description": "Choose full breach objects, truncated objects, or breach names.",
      "type": "string",
      "enum": [
        "full",
        "truncated",
        "names"
      ]
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "account"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string"
    },
    "responseMode": {
      "type": "string",
      "enum": [
        "full",
        "truncated",
        "names"
      ]
    },
    "breaches": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          },
          {
            "type": "object",
            "properties": {
              "Name": {
                "type": "string"
              }
            },
            "required": [
              "Name"
            ],
            "additionalProperties": {}
          },
          {
            "type": "string"
          }
        ]
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Query the authenticated HIBP k-anonymity breached-account range endpoint with the first 6 characters of a SHA-1 email hash. Requires a subscription with k-anonymity access; compare each returned suffix with the remaining hash characters locally because a prefix alone cannot identify an account.

{
  "type": "object",
  "properties": {
    "prefix": {
      "type": "string",
      "pattern": "^[0-9A-Fa-f]{6}$",
      "description": "The first 6 hexadecimal characters of the SHA-1 hash of an email address. Compare each returned suffix with the remaining 34 characters locally; a prefix alone does not identify an account."
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "prefix"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "prefix": {
      "type": "string"
    },
    "matchCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "matches": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "hashSuffix": {
            "type": "string",
            "description": "Remaining 34 SHA-1 hash characters to compare locally with the account hash."
          },
          "websites": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Non-sensitive breach names associated with the matching hash suffix."
          }
        },
        "required": [
          "hashSuffix",
          "websites"
        ],
        "additionalProperties": false
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Search for public pastes containing a single email address. Requires an OAuth bearer token linked to an active HIBP API subscription; run this separately from breached-account lookup.

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string",
      "description": "The email address to search for pastes."
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "account"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "account": {
      "type": "string"
    },
    "pastes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "Source": {
            "type": "string"
          },
          "Id": {
            "type": "string"
          },
          "Title": {
            "type": [
              "string",
              "null"
            ]
          },
          "Date": {
            "type": [
              "string",
              "null"
            ]
          },
          "EmailCount": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "Source",
          "Id",
          "EmailCount"
        ],
        "additionalProperties": {}
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Return breached aliases for a verified domain. This tool requires an authorized subscription via OAuth bearer token.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The verified domain to search."
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "domain"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "breachesByAlias": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "aliasCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

List the domains associated with the authenticated HIBP subscription.

{
  "type": "object",
  "properties": {
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "subscribedDomains": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "DomainName": {
            "type": "string"
          },
          "PwnCount": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "PwnCountExcludingSpamLists": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "PwnCountExcludingSpamListsAtLastSubscriptionRenewal": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "null"
              }
            ]
          },
          "NextSubscriptionRenewal": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "DomainName",
          "PwnCount",
          "PwnCountExcludingSpamLists",
          "PwnCountExcludingSpamListsAtLastSubscriptionRenewal",
          "NextSubscriptionRenewal"
        ],
        "additionalProperties": false
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Return the current plan, quotas, rate limits, expiry, and feature flags for the active HIBP API subscription linked to the authenticated OAuth connection. Use it to confirm access before feature-dependent lookups.

{
  "type": "object",
  "properties": {
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "subscription": {
      "type": "object",
      "properties": {
        "SubscriptionName": {
          "type": "string",
          "description": "Current HIBP API subscription plan name."
        },
        "Description": {
          "type": "string",
          "description": "Current HIBP API subscription plan description."
        },
        "SubscribedUntil": {
          "type": "string",
          "description": "UTC timestamp when the current subscription expires."
        },
        "Rpm": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991,
          "description": "Maximum API requests per minute for the subscription."
        },
        "DomainSearchMaxBreachedAccounts": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ],
          "description": "Maximum breached accounts returned by a domain search, when applicable."
        },
        "MaxBreachedDomains": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ],
          "description": "Maximum verified domains allowed by the subscription, when applicable."
        },
        "IncludesStealerLogs": {
          "type": "boolean",
          "description": "Whether the subscription includes stealer-log lookups."
        },
        "IncludesBulkDomainAdd": {
          "type": "boolean",
          "description": "Whether the subscription includes bulk domain addition."
        },
        "IncludesAutoSubdomainVerification": {
          "type": "boolean",
          "description": "Whether the subscription includes automatic subdomain verification."
        },
        "IncludesCustomerDomains": {
          "type": "boolean",
          "description": "Whether the subscription includes customer-domain support."
        },
        "IncludesKAnon": {
          "type": "boolean",
          "description": "Whether the subscription includes breached-account k-anonymity range lookups."
        },
        "KAnonRpm": {
          "anyOf": [
            {
              "type": "integer",
              "minimum": -9007199254740991,
              "maximum": 9007199254740991
            },
            {
              "type": "null"
            }
          ],
          "description": "Maximum breached-account k-anonymity range lookups per minute, when included."
        }
      },
      "required": [
        "SubscriptionName",
        "Description",
        "SubscribedUntil",
        "Rpm",
        "DomainSearchMaxBreachedAccounts",
        "MaxBreachedDomains",
        "IncludesStealerLogs",
        "IncludesBulkDomainAdd",
        "IncludesAutoSubdomainVerification",
        "IncludesCustomerDomains",
        "IncludesKAnon",
        "KAnonRpm"
      ],
      "additionalProperties": false
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Return website domains historically observed in stealer logs for an email address. Requires an OAuth-linked active subscription with the stealer-log feature; results do not establish current account access.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address to search for in stealer logs."
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "email"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Return email addresses historically observed in stealer logs for a website domain. Requires an OAuth-linked active subscription with the stealer-log feature; results do not establish current account access.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The website domain to search for in stealer logs."
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "domain"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Return email aliases and associated website domains historically observed in stealer logs for an email domain. Requires an OAuth-linked active subscription with the stealer-log feature; results do not establish current account access.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The email domain to search for in stealer logs."
    },
    "limit": {
      "default": 25,
      "description": "Maximum number of items to include in the response. Defaults to 25.",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "default": 0,
      "description": "Number of items to skip before returning results. Defaults to 0.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "domain"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "aliases": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "aliasCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "totalCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "returnedCount": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "offset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "limit": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "hasMore": {
      "type": "boolean"
    },
    "nextOffset": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Generate the TXT record value required to verify domain control via DNS, creating or reusing the private HIBP domain-verification records needed for the request. Requires an authenticated subscription with domain-verification access.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The domain to generate a verification token for."
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "domain"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "txtRecordValue": {
      "type": "string"
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Complete domain verification by checking the expected HIBP TXT record on the target domain. Requires an authenticated subscription with domain-verification access.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The domain to verify by DNS."
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "domain"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "verified": {
      "type": "boolean"
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}

Send a domain verification email to an approved alias such as admin or security. Requires an authenticated subscription with domain-verification access.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "The domain to verify by email."
    },
    "emailAlias": {
      "type": "string",
      "description": "The approval alias to send the verification email to, for example admin."
    },
    "response_format": {
      "default": "markdown",
      "description": "Format only the text content as markdown (default) or a JSON string. The same machine-readable data is always returned in structuredContent.",
      "type": "string",
      "enum": [
        "markdown",
        "json"
      ]
    }
  },
  "required": [
    "domain",
    "emailAlias"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "emailAlias": {
      "type": "string"
    },
    "emailSent": {
      "type": "boolean"
    },
    "statusCode": {
      "description": "Present when the tool returns an error.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "message": {
      "description": "Present when the tool returns an error.",
      "type": "string"
    },
    "guidance": {
      "description": "Additional guidance for resolving the tool error.",
      "type": "string"
    },
    "retryAfterSeconds": {
      "description": "How long to wait before retrying, when the tool is rate limited.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "retryAfterHeaders": {
      "description": "Retry headers that mirror the standard HTTP rate-limit response when applicable.",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "rateLimitResetAt": {
      "description": "UTC timestamp indicating when the current rate limit window should have reset.",
      "type": "string"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false
}