# Phisherman

## Docs

- [POST /api/check](https://mintlify.wiki/joey727/Phisherman/api/check-url.md): Submit a URL for phishing analysis and receive a scored threat verdict.
- [Error codes](https://mintlify.wiki/joey727/Phisherman/api/error-codes.md): HTTP status codes and error response format returned by the Phisherman API.
- [API overview](https://mintlify.wiki/joey727/Phisherman/api/overview.md): Phisherman exposes a single REST endpoint for URL analysis.
- [ScanResult schema](https://mintlify.wiki/joey727/Phisherman/api/scan-result.md): The full structure of the JSON object returned by POST /api/check.
- [How it works](https://mintlify.wiki/joey727/Phisherman/concepts/how-it-works.md): A walkthrough of the Phisherman checker pipeline from HTTP request to verdict.
- [Scoring and verdicts](https://mintlify.wiki/joey727/Phisherman/concepts/scoring.md): How Phisherman calculates a URL's risk score and determines its verdict.
- [SSRF protection](https://mintlify.wiki/joey727/Phisherman/concepts/ssrf-protection.md): How Phisherman protects against Server-Side Request Forgery and DNS rebinding attacks.
- [Threat intelligence feeds](https://mintlify.wiki/joey727/Phisherman/concepts/threat-feeds.md): The external threat feeds Phisherman queries and how they are cached in Redis.
- [Environment variables](https://mintlify.wiki/joey727/Phisherman/configuration/environment-variables.md): All environment variables Phisherman reads at startup and runtime.
- [Rate limiting](https://mintlify.wiki/joey727/Phisherman/configuration/rate-limiting.md): How Phisherman throttles requests per IP address using Redis.
- [Redis setup](https://mintlify.wiki/joey727/Phisherman/configuration/redis-setup.md): How to provision an Upstash Redis instance for Phisherman.
- [Deployment](https://mintlify.wiki/joey727/Phisherman/deployment.md): Deploy Phisherman using Docker or run it directly with Node.js.
- [Introduction](https://mintlify.wiki/joey727/Phisherman/introduction.md): Phisherman is a phishing URL detection backend that analyzes URLs against multiple threat-intelligence feeds, DNS checks, and heuristic rules.
- [Quickstart](https://mintlify.wiki/joey727/Phisherman/quickstart.md): Get Phisherman running and make your first URL check in under five minutes.

## OpenAPI Specs

- [openapi](https://mintlify.wiki/joey727/Phisherman/api-reference/openapi.json)