Developers

Your API Key

loading...

Keep this key private. Do not share it – anyone with it can access your API. Renew if you think it's compromised.

Blocker

Active

v1 endpoint

https://your-domain.com/r/{slug}?apikey={your_api_key}&ip={visitor_ip}&ua={user_agent}&url={request_url}&ref={referral}

v2 endpoint

https://your-domain.com/r/{slug}?apikey={your_api_key}&ip={visitor_ip}&ua={user_agent}&url={any_parameter_like_email}

Parameter Reference

apikey

Your unique authentication key.

ip

IP address to check against the antibot endpoint.

ua

User-Agent string for fingerprint verification.

url

Any request parameter (e.g. email=visitor@example.com) — shown in dashboard statistics.

ref

Referral domain — Hermes will verify the referring visitor.

For advanced usage, refer to the full documentation.

Short URLs

Active

Create and manage short URLs via the REST API.

List all URLs

GET https://your-domain.com/api/urls

Create new URL

POST https://your-domain.com/api/urls {"slug": "promo", "target_url": "https://example.com", "blocked_page": "https://google.com"}

Delete URL

DELETE https://your-domain.com/api/urls {"id": 1}

Block Rules

Active

Manage ISP, ASN, and country-based traffic filtering rules.

List all rules

GET https://your-domain.com/api/rules

Create block rule (ISP, ASN, or COUNTRY)

POST https://your-domain.com/api/rules {"rule_type": "ISP", "value": "Cloudflare", "action": "block"}

Delete rule

DELETE https://your-domain.com/api/rules {"id": 1}

Lookup IP

Active
GET https://your-domain.com/api/stats

Returns geolocation, timezone, ASN/ISP, company, and proxy/VPN/Tor security signals. Each successful lookup uses 1 quota.

Click Logs

Active
GET https://your-domain.com/api/logs?slug=promo&visit_type=blocked&limit=50&offset=0

Returns detailed click logs with IP, country, ISP, ASN, device, threat level, and visit status. Supports filtering by slug, threat, visit_type, and country.

Email Validator

Unavailable
Coming Soon

Phone Validator

Unavailable
Coming Soon

Disposable Email Checker

Unavailable
Coming Soon

Hermes Antibot · v1.0.0