{ "openapi": "3.1.0", "info": { "title": "hunter.domains API", "version": "1.0.0", "summary": "Vetted expired domains, on-demand domain reports and registry lookups as JSON.", "description": "hunter.domains scans expiring, pending-delete and auctioned domains every day, removes the ones with a spam history and scores the rest. This API returns the same lists and reports as the site, lets you manage alert rules and webhooks, order a report for any domain and run RDAP, DNS and Domain Rating lookups. Guide: https://hunter.domains/docs/api", "termsOfService": "https://hunter.domains/terms", "contact": { "name": "hunter.domains", "email": "hello@hunter.domains", "url": "https://hunter.domains/docs" } }, "externalDocs": { "description": "API guide", "url": "https://hunter.domains/docs/api" }, "servers": [ { "url": "https://hunter.domains/api/v1" } ], "security": [ { "apiKey": [] } ], "tags": [ { "name": "Account and stats", "description": "Check what your key can do and how much of the daily scan made it to the list." }, { "name": "Domains", "description": "Three lists share one shape: the live list (auctions and pending drops that have not ended), Available now (dropped, unregistered, re-checked against the registry every two hours) and the archive (everything that ended)." }, { "name": "Watchlist", "description": "Domains you follow. On Pro a watched domain triggers a reminder before its auction ends and a notice if it drops unregistered." }, { "name": "Alert rules", "description": "A rule describes the domains you want. Every newly listed domain is matched against your rules; a match sends an email and the `alert.matched` webhook." }, { "name": "Domain checks", "description": "Order the full report for any domain, listed or not. A check reads the Wayback history, so it runs in a queue and usually finishes within two minutes. Each new check uses one credit; asking again for the same domain within 7 days returns the existing report for free." }, { "name": "Lookups", "description": "Live registry (RDAP), DNS and Domain Rating lookups. They do not use check credits; they share the hourly quota of the free tools on the site." }, { "name": "Webhook endpoints", "description": "Manage where events are delivered. Payloads, signatures and retries are described on the webhooks page." } ], "paths": { "/me": { "get": { "operationId": "getAccount", "tags": [ "Account and stats" ], "summary": "Your plan, limits and usage", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "email": { "type": "string" }, "plan": { "type": "string" }, "plan_renews_at": { "type": "string" }, "limits": { "type": "object", "properties": { "requests_per_minute": { "type": "integer" }, "requests_per_day": { "type": "integer" }, "requests_today": { "type": "integer" }, "lookup_domains_per_hour": { "type": "integer" } } }, "checks": { "type": "object", "properties": { "available": { "type": "integer" }, "from_plan_this_month": { "type": "integer" }, "welcome": { "type": "integer" }, "purchased": { "type": "integer" } } }, "alerts": { "type": "object", "properties": { "used": { "type": "integer" }, "limit": { "type": "integer" } } }, "watchlist": { "type": "object", "properties": { "used": { "type": "integer" }, "limit": { "type": [ "string", "null" ] } } }, "webhooks": { "type": "object", "properties": { "used": { "type": "integer" }, "limit": { "type": "integer" } } } } } } }, "example": { "data": { "email": "you@example.com", "plan": "pro", "plan_renews_at": "2026-11-06T09:12:00Z", "limits": { "requests_per_minute": 120, "requests_per_day": 20000, "requests_today": 214, "lookup_domains_per_hour": 600 }, "checks": { "available": 27, "from_plan_this_month": 27, "welcome": 0, "purchased": 0 }, "alerts": { "used": 2, "limit": 10 }, "watchlist": { "used": 6, "limit": null }, "webhooks": { "used": 1, "limit": 3 } } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/stats": { "get": { "operationId": "getStats", "tags": [ "Account and stats" ], "summary": "Last scan and list sizes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "last_scan": { "type": "object", "properties": { "started_at": { "type": "string" }, "finished_at": { "type": "string" }, "scanned": { "type": "integer" }, "passed_authority_filter": { "type": "integer" } } }, "live": { "type": "object", "properties": { "domains": { "type": "integer" }, "open_on_free_plan": { "type": "integer" }, "ending_within_24h": { "type": "integer" }, "average_score": { "type": "number" }, "average_domain_rating": { "type": "number" } } }, "available_now": { "type": "integer" }, "archive": { "type": "integer" } } } } }, "example": { "data": { "last_scan": { "started_at": "2026-10-06T15:30:02Z", "finished_at": "2026-10-06T17:48:40Z", "scanned": 2656148, "passed_authority_filter": 426 }, "live": { "domains": 62, "open_on_free_plan": 5, "ending_within_24h": 14, "average_score": 64.2, "average_domain_rating": 36.1 }, "available_now": 9, "archive": 310 } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domains": { "get": { "operationId": "listDomains", "tags": [ "Domains" ], "summary": "The live list", "description": "Domains whose auction or drop has not ended yet, best score first. On the free plan the response holds the day’s open domains and `meta.locked` tells you how many more match on Pro.", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Search in the domain name and the old site title (up to 60 characters).", "schema": { "type": "string" }, "example": "garden" }, { "name": "min_score", "in": "query", "required": false, "description": "Lowest Hunter score, 0–100.", "schema": { "type": "integer" }, "example": 60 }, { "name": "min_dr", "in": "query", "required": false, "description": "Lowest Ahrefs Domain Rating, 0–100.", "schema": { "type": "integer" }, "example": 30 }, { "name": "min_tf", "in": "query", "required": false, "description": "Lowest Majestic Trust Flow, 0–100.", "schema": { "type": "integer" } }, { "name": "min_ref_domains", "in": "query", "required": false, "description": "Fewest referring domains.", "schema": { "type": "integer" } }, { "name": "min_archive_years", "in": "query", "required": false, "description": "Fewest distinct years with Wayback captures, 0–30.", "schema": { "type": "integer" } }, { "name": "max_price", "in": "query", "required": false, "description": "Highest current price in USD. Domains without a price (pending delete) always pass.", "schema": { "type": "integer" }, "example": 100 }, { "name": "tld", "in": "query", "required": false, "description": "Extensions, comma-separated.", "schema": { "type": "string" }, "example": "com,org" }, { "name": "type", "in": "query", "required": false, "description": "Listing types, comma-separated.", "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": false, "description": "Niches (the top Majestic topic), comma-separated.", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Languages of the old site as two-letter codes, comma-separated.", "schema": { "type": "string" }, "example": "en,de" }, { "name": "clean", "in": "query", "required": false, "description": "Only domains with verdict `ok` and no risk flags.", "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "description": "Only domains found at or after this time (ISO 8601). Use it to fetch what is new since your last call.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-06T00:00:00Z" }, { "name": "ending_within_hours", "in": "query", "required": false, "description": "Only listings that end within this many hours, 1–720.", "schema": { "type": "integer" }, "example": 24 }, { "name": "sort", "in": "query", "required": false, "description": "Default `score` (`ended` on the archive).", "schema": { "type": "string", "enum": [ "score", "dr", "ending", "newest", "price", "ended" ] } }, { "name": "page", "in": "query", "required": false, "description": "Page number, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page: 1–100, default 25.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" } } }, "listing": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "price_usd": { "type": "integer" }, "bids": { "type": "integer" }, "ends_at": { "type": "string" }, "url": { "type": "string" } } }, "found_at": { "type": "string" }, "open": { "type": "boolean" }, "detail": { "type": "string" }, "report_url": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "list": { "type": "string" }, "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "pages": { "type": "integer" }, "plan": { "type": "string" }, "locked": { "type": "integer" }, "locked_note": { "type": "string" }, "upgrade_url": { "type": "string" } } } } }, "example": { "data": [ { "domain": "example.org", "tld": "org", "status": "listed", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31 }, "listing": { "source": "godaddy", "type": "bid", "price_usd": 25, "bids": 3, "ends_at": "2026-10-09T17:30:00Z", "url": "https://auctions.godaddy.com/trpItemListing.aspx?domain=example.org" }, "found_at": "2026-10-06T16:42:10Z", "open": true, "detail": "full", "report_url": "https://hunter.domains/domain/example.org" } ], "meta": { "list": "live", "total": 5, "page": 1, "per_page": 25, "pages": 1, "plan": "free", "locked": 57, "locked_note": "57 more matching domains are on the Pro list.", "upgrade_url": "https://hunter.domains/pricing" } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domains/available": { "get": { "operationId": "listAvailableDomains", "tags": [ "Domains" ], "summary": "Available now", "description": "Listed domains that dropped and that nobody registered. No auction: the price is a normal registration fee. A Pro list; the free plan only sees a domain here if it was one of its open domains.", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Search in the domain name and the old site title (up to 60 characters).", "schema": { "type": "string" }, "example": "garden" }, { "name": "min_score", "in": "query", "required": false, "description": "Lowest Hunter score, 0–100.", "schema": { "type": "integer" }, "example": 60 }, { "name": "min_dr", "in": "query", "required": false, "description": "Lowest Ahrefs Domain Rating, 0–100.", "schema": { "type": "integer" }, "example": 30 }, { "name": "min_tf", "in": "query", "required": false, "description": "Lowest Majestic Trust Flow, 0–100.", "schema": { "type": "integer" } }, { "name": "min_ref_domains", "in": "query", "required": false, "description": "Fewest referring domains.", "schema": { "type": "integer" } }, { "name": "min_archive_years", "in": "query", "required": false, "description": "Fewest distinct years with Wayback captures, 0–30.", "schema": { "type": "integer" } }, { "name": "max_price", "in": "query", "required": false, "description": "Highest current price in USD. Domains without a price (pending delete) always pass.", "schema": { "type": "integer" }, "example": 100 }, { "name": "tld", "in": "query", "required": false, "description": "Extensions, comma-separated.", "schema": { "type": "string" }, "example": "com,org" }, { "name": "type", "in": "query", "required": false, "description": "Listing types, comma-separated.", "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": false, "description": "Niches (the top Majestic topic), comma-separated.", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Languages of the old site as two-letter codes, comma-separated.", "schema": { "type": "string" }, "example": "en,de" }, { "name": "clean", "in": "query", "required": false, "description": "Only domains with verdict `ok` and no risk flags.", "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "description": "Only domains found at or after this time (ISO 8601). Use it to fetch what is new since your last call.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-06T00:00:00Z" }, { "name": "ending_within_hours", "in": "query", "required": false, "description": "Only listings that end within this many hours, 1–720.", "schema": { "type": "integer" }, "example": 24 }, { "name": "sort", "in": "query", "required": false, "description": "Default `score` (`ended` on the archive).", "schema": { "type": "string", "enum": [ "score", "dr", "ending", "newest", "price", "ended" ] } }, { "name": "page", "in": "query", "required": false, "description": "Page number, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page: 1–100, default 25.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" } } }, "listing": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "price_usd": { "type": [ "string", "null" ] }, "bids": { "type": "integer" }, "ends_at": { "type": "string" }, "url": { "type": "string" } } }, "found_at": { "type": "string" }, "open": { "type": "boolean" }, "detail": { "type": "string" }, "report_url": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "list": { "type": "string" }, "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "pages": { "type": "integer" }, "plan": { "type": "string" }, "locked": { "type": "integer" }, "locked_note": { "type": "string" }, "upgrade_url": { "type": "string" } } } } }, "example": { "data": [ { "domain": "example.org", "tld": "org", "status": "available", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31 }, "listing": { "source": "dropcatch", "type": "pending_delete", "price_usd": null, "bids": 0, "ends_at": "2026-10-04T18:00:00Z", "url": "https://www.spaceship.com/domain-search/?query=example.org" }, "found_at": "2026-10-06T16:42:10Z", "open": true, "detail": "full", "report_url": "https://hunter.domains/domain/example.org" } ], "meta": { "list": "available", "total": 5, "page": 1, "per_page": 25, "pages": 1, "plan": "free", "locked": 57, "locked_note": "57 more matching domains are on the Pro list.", "upgrade_url": "https://hunter.domains/pricing" } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domains/archive": { "get": { "operationId": "listArchivedDomains", "tags": [ "Domains" ], "summary": "The archive", "description": "Every listed domain whose auction or drop has ended, most recent first. Open to every plan.", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Search in the domain name and the old site title (up to 60 characters).", "schema": { "type": "string" }, "example": "garden" }, { "name": "min_score", "in": "query", "required": false, "description": "Lowest Hunter score, 0–100.", "schema": { "type": "integer" }, "example": 60 }, { "name": "min_dr", "in": "query", "required": false, "description": "Lowest Ahrefs Domain Rating, 0–100.", "schema": { "type": "integer" }, "example": 30 }, { "name": "min_tf", "in": "query", "required": false, "description": "Lowest Majestic Trust Flow, 0–100.", "schema": { "type": "integer" } }, { "name": "min_ref_domains", "in": "query", "required": false, "description": "Fewest referring domains.", "schema": { "type": "integer" } }, { "name": "min_archive_years", "in": "query", "required": false, "description": "Fewest distinct years with Wayback captures, 0–30.", "schema": { "type": "integer" } }, { "name": "max_price", "in": "query", "required": false, "description": "Highest current price in USD. Domains without a price (pending delete) always pass.", "schema": { "type": "integer" }, "example": 100 }, { "name": "tld", "in": "query", "required": false, "description": "Extensions, comma-separated.", "schema": { "type": "string" }, "example": "com,org" }, { "name": "type", "in": "query", "required": false, "description": "Listing types, comma-separated.", "schema": { "type": "string" } }, { "name": "topic", "in": "query", "required": false, "description": "Niches (the top Majestic topic), comma-separated.", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "description": "Languages of the old site as two-letter codes, comma-separated.", "schema": { "type": "string" }, "example": "en,de" }, { "name": "clean", "in": "query", "required": false, "description": "Only domains with verdict `ok` and no risk flags.", "schema": { "type": "boolean" } }, { "name": "since", "in": "query", "required": false, "description": "Only domains found at or after this time (ISO 8601). Use it to fetch what is new since your last call.", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-06T00:00:00Z" }, { "name": "ending_within_hours", "in": "query", "required": false, "description": "Only listings that end within this many hours, 1–720.", "schema": { "type": "integer" }, "example": 24 }, { "name": "sort", "in": "query", "required": false, "description": "Default `score` (`ended` on the archive).", "schema": { "type": "string", "enum": [ "score", "dr", "ending", "newest", "price", "ended" ] } }, { "name": "page", "in": "query", "required": false, "description": "Page number, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page: 1–100, default 25.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" } } }, "listing": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "price_usd": { "type": "integer" }, "bids": { "type": "integer" }, "ends_at": { "type": "string" }, "url": { "type": "string" } } }, "found_at": { "type": "string" }, "open": { "type": "boolean" }, "detail": { "type": "string" }, "report_url": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "list": { "type": "string" }, "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "pages": { "type": "integer" }, "plan": { "type": "string" }, "locked": { "type": "integer" }, "locked_note": { "type": "string" }, "upgrade_url": { "type": "string" } } } } }, "example": { "data": [ { "domain": "example.org", "tld": "org", "status": "ended", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31 }, "listing": { "source": "godaddy", "type": "bid", "price_usd": 25, "bids": 3, "ends_at": "2026-10-09T17:30:00Z", "url": "https://auctions.godaddy.com/trpItemListing.aspx?domain=example.org" }, "found_at": "2026-10-06T16:42:10Z", "open": true, "detail": "full", "report_url": "https://hunter.domains/domain/example.org" } ], "meta": { "list": "archive", "total": 5, "page": 1, "per_page": 25, "pages": 1, "plan": "free", "locked": 57, "locked_note": "57 more matching domains are on the Pro list.", "upgrade_url": "https://hunter.domains/pricing" } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domains/{domain}": { "get": { "operationId": "getDomain", "tags": [ "Domains" ], "summary": "The full report of a listed domain", "description": "Everything on the report page: metrics, score breakdown, top referring domains, anchors, topical Trust Flow, risk checks and, once the listing has ended, the registration status. `detail` is `full` for the day’s open domains and for every domain on Pro, `basic` otherwise. Returns `404` for a domain that is not on the list; use a domain check for those.", "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain name.", "schema": { "type": "string" }, "example": "example.org" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" }, "tf_cf_ratio": { "type": "number" }, "backlinks": { "type": "integer" }, "semrush_authority_score": { "type": "integer" }, "moz_domain_authority": { "type": "integer" }, "open_pagerank": { "type": "number" }, "google_indexed_pages": { "type": "integer" }, "archived_urls": { "type": "integer" } } }, "listing": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "price_usd": { "type": "integer" }, "bids": { "type": "integer" }, "ends_at": { "type": "string" }, "url": { "type": "string" } } }, "found_at": { "type": "string" }, "open": { "type": "boolean" }, "detail": { "type": "string" }, "report_url": { "type": "string" }, "score_breakdown": { "type": "object", "properties": { "ahrefs_dr": { "type": "number" }, "trust_flow": { "type": "number" }, "ref_domains": { "type": "number" }, "semrush_as": { "type": "number" }, "open_pagerank": { "type": "number" }, "history": { "type": "integer" }, "age": { "type": "integer" }, "price": { "type": "number" }, "penalty": { "type": "integer" } } }, "top_referring_domains": { "type": "array", "items": { "type": "string" } }, "anchors": { "type": "object", "properties": { "top": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "referring_domains": { "type": "integer" } } } }, "spam_share": { "type": "integer" } } }, "topical_trust_flow": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "trust_flow": { "type": "integer" } } } }, "risk_checks": { "type": "array", "items": { "type": "object", "properties": { "flag": { "type": "string" }, "label": { "type": "string" }, "result": { "type": "string" }, "severity": { "type": "string" }, "note": { "type": "string" } } } }, "wayback_url": { "type": "string" }, "registration": { "type": [ "string", "null" ] }, "rank_on_hunt_day": { "type": "integer" }, "revival_kit": { "type": "object", "properties": { "pages": { "type": "integer" }, "url": { "type": "string" } } } } } } }, "example": { "data": { "domain": "example.org", "tld": "org", "status": "listed", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31, "tf_cf_ratio": 0.9, "backlinks": 9840, "semrush_authority_score": 21, "moz_domain_authority": 33, "open_pagerank": 4.1, "google_indexed_pages": 10, "archived_urls": 1260 }, "listing": { "source": "godaddy", "type": "bid", "price_usd": 25, "bids": 3, "ends_at": "2026-10-09T17:30:00Z", "url": "https://auctions.godaddy.com/trpItemListing.aspx?domain=example.org" }, "found_at": "2026-10-06T16:42:10Z", "open": true, "detail": "full", "report_url": "https://hunter.domains/domain/example.org", "score_breakdown": { "ahrefs_dr": 0.92, "trust_flow": 0.7, "ref_domains": 0.87, "semrush_as": 0.7, "open_pagerank": 0.41, "history": 1, "age": 1, "price": 0.8, "penalty": 0 }, "top_referring_domains": [ "rhs.org.uk", "gardenersworld.com", "extension.umn.edu" ], "anchors": { "top": [ { "text": "seasonal planting guide", "referring_domains": 38 }, { "text": "example.org", "referring_domains": 27 } ], "spam_share": 0 }, "topical_trust_flow": [ { "topic": "Home/Gardening", "trust_flow": 27 }, { "topic": "Recreation/Outdoors", "trust_flow": 14 } ], "risk_checks": [ { "flag": "dr_inflated", "label": "Inflated DR", "result": "clean", "severity": "risk", "note": "DR is in line with the number of referring domains" }, { "flag": "topic_change", "label": "Topic changed", "result": "clean", "severity": "info", "note": "Site topic is the same throughout the archive" } ], "wayback_url": "https://web.archive.org/web/*/example.org", "registration": null, "rank_on_hunt_day": 4, "revival_kit": { "pages": 38, "url": "https://hunter.domains/api/v1/domains/example.org/pages" } } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/domains/{domain}/pages": { "get": { "operationId": "listDomainPages", "tags": [ "Domains" ], "summary": "The revival kit: old URLs and archived text", "description": "The most archived pages of the old site, with capture counts and Wayback links. Rebuild these paths (or 301 them) and the old backlinks keep working. Add `include=content` to get the archived text of each page as Markdown.", "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain name.", "schema": { "type": "string" }, "example": "example.org" }, { "name": "include", "in": "query", "required": false, "description": "Send `content` to include the archived text (smaller pages: 10 by default, 20 at most).", "schema": { "type": "string", "enum": [ "content" ] } }, { "name": "page", "in": "query", "required": false, "description": "Page number, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page: 1–100, default 50.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string" }, "captures": { "type": "integer" }, "last_capture": { "type": "string" }, "title": { "type": "string" }, "words": { "type": "integer" }, "wayback_url": { "type": "string" }, "has_content": { "type": "boolean" } } } }, "meta": { "type": "object", "properties": { "domain": { "type": "string" }, "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "pages": { "type": "integer" } } } } }, "example": { "data": [ { "path": "/guides/spring-planting", "url": "http://example.org/guides/spring-planting", "captures": 64, "last_capture": "2025-03-18", "title": "Spring planting calendar", "words": 1180, "wayback_url": "https://web.archive.org/web/20250318101500/http://example.org/guides/spring-planting", "has_content": true } ], "meta": { "domain": "example.org", "total": 38, "page": 1, "per_page": 50, "pages": 1 } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/watchlist": { "get": { "operationId": "listWatchlist", "tags": [ "Watchlist" ], "summary": "Domains you watch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" } } }, "listing": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "price_usd": { "type": "integer" }, "bids": { "type": "integer" }, "ends_at": { "type": "string" }, "url": { "type": "string" } } }, "found_at": { "type": "string" }, "open": { "type": "boolean" }, "detail": { "type": "string" }, "report_url": { "type": "string" } } } } } }, "example": { "data": [ { "domain": "example.org", "tld": "org", "status": "listed", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31 }, "listing": { "source": "godaddy", "type": "bid", "price_usd": 25, "bids": 3, "ends_at": "2026-10-09T17:30:00Z", "url": "https://auctions.godaddy.com/trpItemListing.aspx?domain=example.org" }, "found_at": "2026-10-06T16:42:10Z", "open": true, "detail": "full", "report_url": "https://hunter.domains/domain/example.org" } ] } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/watchlist/{domain}": { "put": { "operationId": "watchDomain", "tags": [ "Watchlist" ], "summary": "Watch a domain", "description": "Idempotent. The free plan watches up to 3 domains.", "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain name.", "schema": { "type": "string" }, "example": "example.org" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" } } }, "listing": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "price_usd": { "type": "integer" }, "bids": { "type": "integer" }, "ends_at": { "type": "string" }, "url": { "type": "string" } } }, "found_at": { "type": "string" }, "open": { "type": "boolean" }, "detail": { "type": "string" }, "report_url": { "type": "string" } } } } }, "example": { "data": { "domain": "example.org", "tld": "org", "status": "listed", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31 }, "listing": { "source": "godaddy", "type": "bid", "price_usd": 25, "bids": 3, "ends_at": "2026-10-09T17:30:00Z", "url": "https://auctions.godaddy.com/trpItemListing.aspx?domain=example.org" }, "found_at": "2026-10-06T16:42:10Z", "open": true, "detail": "full", "report_url": "https://hunter.domains/domain/example.org" } } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "unwatchDomain", "tags": [ "Watchlist" ], "summary": "Stop watching a domain", "parameters": [ { "name": "domain", "in": "path", "required": true, "description": "The domain name.", "schema": { "type": "string" }, "example": "example.org" } ], "responses": { "204": { "description": "Done. No content." }, "default": { "$ref": "#/components/responses/Error" } } } }, "/alerts": { "get": { "operationId": "listAlerts", "tags": [ "Alert rules" ], "summary": "Your alert rules", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "frequency": { "type": "string" }, "min_score": { "type": "integer" }, "min_dr": { "type": "integer" }, "min_tf": { "type": [ "string", "null" ] }, "min_ref_domains": { "type": [ "string", "null" ] }, "min_archive_years": { "type": "integer" }, "max_price": { "type": "integer" }, "tlds": { "type": "array", "items": { "type": "string" } }, "listing_types": { "type": "array", "items": {} }, "topics": { "type": "array", "items": { "type": "string" } }, "langs": { "type": "array", "items": { "type": "string" } }, "clean_only": { "type": "boolean" }, "keywords": { "type": "array", "items": {} }, "match_count": { "type": "integer" }, "last_matched_at": { "type": "string" }, "created_at": { "type": "string" } } } } } }, "example": { "data": [ { "id": 12, "name": "Health, DR 30+", "active": true, "frequency": "instant", "min_score": 60, "min_dr": 30, "min_tf": null, "min_ref_domains": null, "min_archive_years": 5, "max_price": 150, "tlds": [ "com", "org" ], "listing_types": [], "topics": [ "Health" ], "langs": [ "en" ], "clean_only": true, "keywords": [], "match_count": 7, "last_matched_at": "2026-10-05T16:51:30Z", "created_at": "2026-10-03T10:20:00Z" } ] } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createAlert", "tags": [ "Alert rules" ], "summary": "Create an alert rule", "description": "Up to 10 rules. Leave a field out (or send 0) for “no limit”.", "x-plan": "pro", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "A label for the rule, up to 80 characters.", "type": "string" }, "frequency": { "description": "`instant` emails each match as it is found; `daily` saves matches for the daily digest. Default `instant`. Webhooks always fire at once.", "type": "string", "enum": [ "instant", "daily" ] }, "min_score": { "description": "Lowest Hunter score, 0–100.", "type": "integer" }, "min_dr": { "description": "Lowest Domain Rating, 0–100.", "type": "integer" }, "min_tf": { "description": "Lowest Trust Flow, 0–100.", "type": "integer" }, "min_ref_domains": { "description": "Fewest referring domains.", "type": "integer" }, "min_archive_years": { "description": "Fewest years in the archive, 0–30.", "type": "integer" }, "max_price": { "description": "Highest price in USD.", "type": "integer" }, "tlds": { "description": "Extensions.", "type": "array", "items": { "type": "string" } }, "listing_types": { "description": "Listing types.", "type": "array", "items": { "type": "string", "enum": [ "bid", "buy_now", "pending_delete", "auction" ] } }, "topics": { "description": "Niches.", "type": "array", "items": { "type": "string", "enum": [ "Arts", "Business", "Computers", "Games", "Health", "Home", "News", "Recreation", "Reference", "Regional", "Science", "Shopping", "Society", "Sports" ] } }, "langs": { "description": "Languages of the old site.", "type": "array", "items": { "type": "string", "enum": [ "en", "de", "fr", "es", "it", "nl", "pt", "tr", "ru", "sv", "ja" ] } }, "clean_only": { "description": "Only domains without risk flags.", "type": "boolean" }, "keywords": { "description": "Match only if the name or the old title contains one of these words.", "type": "array", "items": { "type": "string" } }, "active": { "description": "Whether the rule is on. Default `true`.", "type": "boolean" } }, "required": [ "name" ] }, "example": { "name": "Health, DR 30+", "min_score": 60, "min_dr": 30, "max_price": 150, "tlds": [ "com", "org" ], "topics": [ "Health" ], "clean_only": true } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "frequency": { "type": "string" }, "min_score": { "type": "integer" }, "min_dr": { "type": "integer" }, "min_tf": { "type": [ "string", "null" ] }, "min_ref_domains": { "type": [ "string", "null" ] }, "min_archive_years": { "type": "integer" }, "max_price": { "type": "integer" }, "tlds": { "type": "array", "items": { "type": "string" } }, "listing_types": { "type": "array", "items": {} }, "topics": { "type": "array", "items": { "type": "string" } }, "langs": { "type": "array", "items": { "type": "string" } }, "clean_only": { "type": "boolean" }, "keywords": { "type": "array", "items": {} }, "match_count": { "type": "integer" }, "last_matched_at": { "type": "string" }, "created_at": { "type": "string" } } } } }, "example": { "data": { "id": 12, "name": "Health, DR 30+", "active": true, "frequency": "instant", "min_score": 60, "min_dr": 30, "min_tf": null, "min_ref_domains": null, "min_archive_years": 5, "max_price": 150, "tlds": [ "com", "org" ], "listing_types": [], "topics": [ "Health" ], "langs": [ "en" ], "clean_only": true, "keywords": [], "match_count": 7, "last_matched_at": "2026-10-05T16:51:30Z", "created_at": "2026-10-03T10:20:00Z" } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/alerts/{id}": { "get": { "operationId": "getAlert", "tags": [ "Alert rules" ], "summary": "One alert rule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The rule id.", "schema": { "type": "integer" }, "example": 12 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "frequency": { "type": "string" }, "min_score": { "type": "integer" }, "min_dr": { "type": "integer" }, "min_tf": { "type": [ "string", "null" ] }, "min_ref_domains": { "type": [ "string", "null" ] }, "min_archive_years": { "type": "integer" }, "max_price": { "type": "integer" }, "tlds": { "type": "array", "items": { "type": "string" } }, "listing_types": { "type": "array", "items": {} }, "topics": { "type": "array", "items": { "type": "string" } }, "langs": { "type": "array", "items": { "type": "string" } }, "clean_only": { "type": "boolean" }, "keywords": { "type": "array", "items": {} }, "match_count": { "type": "integer" }, "last_matched_at": { "type": "string" }, "created_at": { "type": "string" } } } } }, "example": { "data": { "id": 12, "name": "Health, DR 30+", "active": true, "frequency": "instant", "min_score": 60, "min_dr": 30, "min_tf": null, "min_ref_domains": null, "min_archive_years": 5, "max_price": 150, "tlds": [ "com", "org" ], "listing_types": [], "topics": [ "Health" ], "langs": [ "en" ], "clean_only": true, "keywords": [], "match_count": 7, "last_matched_at": "2026-10-05T16:51:30Z", "created_at": "2026-10-03T10:20:00Z" } } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateAlert", "tags": [ "Alert rules" ], "summary": "Change an alert rule", "description": "Send only the fields you want to change. `{\"active\": false}` pauses the rule.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The rule id.", "schema": { "type": "integer" }, "example": 12 } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "A label for the rule, up to 80 characters.", "type": "string" }, "frequency": { "description": "`instant` emails each match as it is found; `daily` saves matches for the daily digest. Default `instant`. Webhooks always fire at once.", "type": "string", "enum": [ "instant", "daily" ] }, "min_score": { "description": "Lowest Hunter score, 0–100.", "type": "integer" }, "min_dr": { "description": "Lowest Domain Rating, 0–100.", "type": "integer" }, "min_tf": { "description": "Lowest Trust Flow, 0–100.", "type": "integer" }, "min_ref_domains": { "description": "Fewest referring domains.", "type": "integer" }, "min_archive_years": { "description": "Fewest years in the archive, 0–30.", "type": "integer" }, "max_price": { "description": "Highest price in USD.", "type": "integer" }, "tlds": { "description": "Extensions.", "type": "array", "items": { "type": "string" } }, "listing_types": { "description": "Listing types.", "type": "array", "items": { "type": "string", "enum": [ "bid", "buy_now", "pending_delete", "auction" ] } }, "topics": { "description": "Niches.", "type": "array", "items": { "type": "string", "enum": [ "Arts", "Business", "Computers", "Games", "Health", "Home", "News", "Recreation", "Reference", "Regional", "Science", "Shopping", "Society", "Sports" ] } }, "langs": { "description": "Languages of the old site.", "type": "array", "items": { "type": "string", "enum": [ "en", "de", "fr", "es", "it", "nl", "pt", "tr", "ru", "sv", "ja" ] } }, "clean_only": { "description": "Only domains without risk flags.", "type": "boolean" }, "keywords": { "description": "Match only if the name or the old title contains one of these words.", "type": "array", "items": { "type": "string" } }, "active": { "description": "Whether the rule is on. Default `true`.", "type": "boolean" } } }, "example": { "name": "Health, DR 30+", "min_score": 60, "min_dr": 30, "max_price": 150, "tlds": [ "com", "org" ], "topics": [ "Health" ], "clean_only": true } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "frequency": { "type": "string" }, "min_score": { "type": "integer" }, "min_dr": { "type": "integer" }, "min_tf": { "type": [ "string", "null" ] }, "min_ref_domains": { "type": [ "string", "null" ] }, "min_archive_years": { "type": "integer" }, "max_price": { "type": "integer" }, "tlds": { "type": "array", "items": { "type": "string" } }, "listing_types": { "type": "array", "items": {} }, "topics": { "type": "array", "items": { "type": "string" } }, "langs": { "type": "array", "items": { "type": "string" } }, "clean_only": { "type": "boolean" }, "keywords": { "type": "array", "items": {} }, "match_count": { "type": "integer" }, "last_matched_at": { "type": "string" }, "created_at": { "type": "string" } } } } }, "example": { "data": { "id": 12, "name": "Health, DR 30+", "active": true, "frequency": "instant", "min_score": 60, "min_dr": 30, "min_tf": null, "min_ref_domains": null, "min_archive_years": 5, "max_price": 150, "tlds": [ "com", "org" ], "listing_types": [], "topics": [ "Health" ], "langs": [ "en" ], "clean_only": true, "keywords": [], "match_count": 7, "last_matched_at": "2026-10-05T16:51:30Z", "created_at": "2026-10-03T10:20:00Z" } } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteAlert", "tags": [ "Alert rules" ], "summary": "Delete an alert rule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The rule id.", "schema": { "type": "integer" }, "example": 12 } ], "responses": { "204": { "description": "Done. No content." }, "default": { "$ref": "#/components/responses/Error" } } } }, "/alerts/matches": { "get": { "operationId": "listAlertMatches", "tags": [ "Alert rules" ], "summary": "Domains that matched your rules", "description": "Newest match first. Poll it with `since` if you cannot receive webhooks.", "parameters": [ { "name": "since", "in": "query", "required": false, "description": "Only matches at or after this time (ISO 8601).", "schema": { "type": "string", "format": "date-time" }, "example": "2026-10-06T00:00:00Z" }, { "name": "limit", "in": "query", "required": false, "description": "How many to return: 1–100, default 50.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "matched_at": { "type": "string" }, "alert": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "domain": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "status": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" } } }, "listing": { "type": "object", "properties": { "source": { "type": "string" }, "type": { "type": "string" }, "price_usd": { "type": "integer" }, "bids": { "type": "integer" }, "ends_at": { "type": "string" }, "url": { "type": "string" } } }, "found_at": { "type": "string" }, "open": { "type": "boolean" }, "detail": { "type": "string" }, "report_url": { "type": "string" } } } } } } } }, "example": { "data": [ { "matched_at": "2026-10-06T16:44:02Z", "alert": { "id": 12, "name": "Health, DR 30+" }, "domain": { "domain": "example.org", "tld": "org", "status": "listed", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31 }, "listing": { "source": "godaddy", "type": "bid", "price_usd": 25, "bids": 3, "ends_at": "2026-10-09T17:30:00Z", "url": "https://auctions.godaddy.com/trpItemListing.aspx?domain=example.org" }, "found_at": "2026-10-06T16:42:10Z", "open": true, "detail": "full", "report_url": "https://hunter.domains/domain/example.org" } } ] } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/checks": { "post": { "operationId": "createCheck", "tags": [ "Domain checks" ], "summary": "Order a report for any domain", "description": "Returns `202` with a queued check, or `200` with the existing check if this domain was checked in the last 7 days. Poll `GET /checks/{id}` every few seconds, or subscribe to the `check.completed` webhook. Returns `402` when no credits are left.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "description": "The domain to check. A URL or a subdomain is reduced to the registered domain.", "type": "string" } }, "required": [ "domain" ] }, "example": { "domain": "example.org" } } } }, "responses": { "202": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "domain": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "finished_at": { "type": [ "string", "null" ] }, "score": { "type": [ "string", "null" ] }, "verdict": { "type": [ "string", "null" ] }, "report_url": { "type": "string" }, "queue_position": { "type": "integer" } } } } }, "example": { "data": { "id": "01k6x2f0q8m3r7t9v4b5n6c8dz", "domain": "example.org", "status": "queued", "created_at": "2026-10-06T17:02:11Z", "finished_at": null, "score": null, "verdict": null, "report_url": "https://hunter.domains/domain-checker/report/01k6x2f0q8m3r7t9v4b5n6c8dz", "queue_position": 1 } } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "get": { "operationId": "listChecks", "tags": [ "Domain checks" ], "summary": "Your checks", "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Page number, from 1.", "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "description": "Items per page: 1–50, default 25.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "domain": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "finished_at": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "report_url": { "type": "string" } } } }, "meta": { "type": "object", "properties": { "total": { "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "pages": { "type": "integer" } } } } }, "example": { "data": [ { "id": "01k6x2f0q8m3r7t9v4b5n6c8dz", "domain": "example.org", "status": "done", "created_at": "2026-10-06T17:02:11Z", "finished_at": "2026-10-06T17:03:24Z", "score": 78, "verdict": "ok", "report_url": "https://hunter.domains/domain-checker/report/01k6x2f0q8m3r7t9v4b5n6c8dz" } ], "meta": { "total": 4, "page": 1, "per_page": 25, "pages": 1 } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/checks/{id}": { "get": { "operationId": "getCheck", "tags": [ "Domain checks" ], "summary": "A check and, when done, its report", "description": "`status` is `queued`, `running`, `done` or `failed`. A failed check does not use a credit. `would_list` tells you whether the same domain would have passed our daily vetting; `reject_reasons` says why not.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The check id.", "schema": { "type": "string" }, "example": "01k6x2f0q8m3r7t9v4b5n6c8dz" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "domain": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": "string" }, "finished_at": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "report_url": { "type": "string" }, "would_list": { "type": "boolean" }, "reject_reasons": { "type": "array", "items": {} }, "report": { "type": "object", "properties": { "domain": { "type": "string" }, "tld": { "type": "string" }, "score": { "type": "integer" }, "verdict": { "type": "string" }, "flags": { "type": "array", "items": {} }, "topic": { "type": "string" }, "language": { "type": "string" }, "title": { "type": "string" }, "metrics": { "type": "object", "properties": { "domain_rating": { "type": "integer" }, "referring_domains": { "type": "integer" }, "archive_years": { "type": "integer" }, "archive_first_year": { "type": "integer" }, "archive_last_year": { "type": "integer" }, "trust_flow": { "type": "integer" }, "citation_flow": { "type": "integer" }, "tf_cf_ratio": { "type": "number" }, "backlinks": { "type": "integer" }, "semrush_authority_score": { "type": "integer" }, "moz_domain_authority": { "type": "integer" }, "open_pagerank": { "type": "number" }, "google_indexed_pages": { "type": "integer" }, "archived_urls": { "type": "integer" } } }, "detail": { "type": "string" }, "score_breakdown": { "type": "object", "properties": { "ahrefs_dr": { "type": "number" }, "trust_flow": { "type": "number" }, "ref_domains": { "type": "number" }, "semrush_as": { "type": "number" }, "open_pagerank": { "type": "number" }, "history": { "type": "integer" }, "age": { "type": "integer" }, "price": { "type": "number" }, "penalty": { "type": "integer" } } }, "top_referring_domains": { "type": "array", "items": { "type": "string" } }, "anchors": { "type": "object", "properties": { "top": { "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string" }, "referring_domains": { "type": "integer" } } } }, "spam_share": { "type": "integer" } } }, "topical_trust_flow": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "trust_flow": { "type": "integer" } } } }, "risk_checks": { "type": "array", "items": { "type": "object", "properties": { "flag": { "type": "string" }, "label": { "type": "string" }, "result": { "type": "string" }, "severity": { "type": "string" }, "note": { "type": "string" } } } }, "wayback_url": { "type": "string" } } }, "registration": { "type": "object", "properties": { "state": { "type": "string" }, "registrar": { "type": "string" }, "registered_at": { "type": "string" }, "expires_at": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string" } } } } } } } }, "example": { "data": { "id": "01k6x2f0q8m3r7t9v4b5n6c8dz", "domain": "example.org", "status": "done", "created_at": "2026-10-06T17:02:11Z", "finished_at": "2026-10-06T17:03:24Z", "score": 78, "verdict": "ok", "report_url": "https://hunter.domains/domain-checker/report/01k6x2f0q8m3r7t9v4b5n6c8dz", "would_list": true, "reject_reasons": [], "report": { "domain": "example.org", "tld": "org", "score": 78, "verdict": "ok", "flags": [], "topic": "Home", "language": "en", "title": "Seasonal planting guides for small gardens", "metrics": { "domain_rating": 46, "referring_domains": 412, "archive_years": 17, "archive_first_year": 2006, "archive_last_year": 2025, "trust_flow": 28, "citation_flow": 31, "tf_cf_ratio": 0.9, "backlinks": 9840, "semrush_authority_score": 21, "moz_domain_authority": 33, "open_pagerank": 4.1, "google_indexed_pages": 10, "archived_urls": 1260 }, "detail": "full", "score_breakdown": { "ahrefs_dr": 0.92, "trust_flow": 0.7, "ref_domains": 0.87, "semrush_as": 0.7, "open_pagerank": 0.41, "history": 1, "age": 1, "price": 0.8, "penalty": 0 }, "top_referring_domains": [ "rhs.org.uk", "gardenersworld.com", "extension.umn.edu" ], "anchors": { "top": [ { "text": "seasonal planting guide", "referring_domains": 38 }, { "text": "example.org", "referring_domains": 27 } ], "spam_share": 0 }, "topical_trust_flow": [ { "topic": "Home/Gardening", "trust_flow": 27 }, { "topic": "Recreation/Outdoors", "trust_flow": 14 } ], "risk_checks": [ { "flag": "dr_inflated", "label": "Inflated DR", "result": "clean", "severity": "risk", "note": "DR is in line with the number of referring domains" }, { "flag": "topic_change", "label": "Topic changed", "result": "clean", "severity": "info", "note": "Site topic is the same throughout the archive" } ], "wayback_url": "https://web.archive.org/web/*/example.org" }, "registration": { "state": "registered", "registrar": "Example Registrar, LLC", "registered_at": "2006-04-11T09:00:00Z", "expires_at": "2027-04-11T09:00:00Z", "statuses": [ "client transfer prohibited" ] } } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/tools/whois": { "get": { "operationId": "lookupWhois", "tags": [ "Lookups" ], "summary": "Registration record and drop estimate", "description": "Read live from the registry through RDAP: state, registrar, dates, status codes, name servers and, for generic extensions, the window in which the domain will drop.", "parameters": [ { "name": "domain", "in": "query", "required": true, "description": "The domain name.", "schema": { "type": "string" }, "example": "example.org" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string" }, "state": { "type": "string" }, "registrar": { "type": "string" }, "registrar_iana_id": { "type": "string" }, "registered_at": { "type": "string" }, "expires_at": { "type": "string" }, "updated_at": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string" } }, "nameservers": { "type": "array", "items": { "type": "string" } }, "dnssec": { "type": "boolean" }, "drop_estimate": { "type": "object", "properties": { "stage": { "type": "string" }, "earliest": { "type": "string" }, "latest": { "type": "string" }, "exact": { "type": "boolean" }, "drop_hour_utc": { "type": [ "string", "null" ] } } } } } } }, "example": { "data": { "domain": "example.org", "state": "registered", "registrar": "Example Registrar, LLC", "registrar_iana_id": "146", "registered_at": "2006-04-11T09:00:00Z", "expires_at": "2027-04-11T09:00:00Z", "updated_at": "2026-03-02T08:14:00Z", "statuses": [ "client transfer prohibited" ], "nameservers": [ "ns1.example.net", "ns2.example.net" ], "dnssec": false, "drop_estimate": { "stage": "active", "earliest": "2027-05-16", "latest": "2027-06-30", "exact": false, "drop_hour_utc": null } } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/tools/availability": { "get": { "operationId": "lookupAvailability", "tags": [ "Lookups" ], "summary": "Bulk availability", "description": "`state` is `available`, `registered`, `dropping` (in redemption or pending delete) or `unknown` (the registry has no RDAP service or did not answer). Up to 20 domains a request on the free plan, 50 on Pro.", "parameters": [ { "name": "domains", "in": "query", "required": true, "description": "Comma-separated domain names.", "schema": { "type": "string" }, "example": "example.org,example.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "state": { "type": "string" }, "registrar": { "type": "string" }, "registrar_iana_id": { "type": "string" }, "registered_at": { "type": "string" }, "expires_at": { "type": "string" }, "updated_at": { "type": "string" }, "statuses": { "type": "array", "items": { "type": "string" } }, "nameservers": { "type": "array", "items": { "type": "string" } }, "dnssec": { "type": "boolean" } } } } } }, "example": { "data": [ { "domain": "example.org", "state": "registered", "registrar": "Example Registrar, LLC", "registrar_iana_id": "146", "registered_at": "2006-04-11T09:00:00Z", "expires_at": "2027-04-11T09:00:00Z", "updated_at": "2026-03-02T08:14:00Z", "statuses": [ "client transfer prohibited" ], "nameservers": [ "ns1.example.net", "ns2.example.net" ], "dnssec": false } ] } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/tools/domain-rating": { "get": { "operationId": "lookupDomainRating", "tags": [ "Lookups" ], "summary": "Ahrefs Domain Rating", "description": "Up to 10 domains a request on the free plan, 25 on Pro. Results are cached for 7 days. A row can carry `error: \"busy_retry_later\"` when the upstream limit is reached.", "parameters": [ { "name": "domains", "in": "query", "required": true, "description": "Comma-separated domain names.", "schema": { "type": "string" }, "example": "example.org,example.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "domain_rating": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } } } } }, "example": { "data": [ { "domain": "example.org", "domain_rating": 46, "error": null } ] } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/tools/dns": { "get": { "operationId": "lookupDns", "tags": [ "Lookups" ], "summary": "DNS records", "description": "A, AAAA, CNAME, MX, NS, TXT, SOA and CAA records, plus mail, SPF, DMARC and parking signals.", "parameters": [ { "name": "host", "in": "query", "required": true, "description": "A domain or subdomain.", "schema": { "type": "string" }, "example": "example.org" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "host": { "type": "string" }, "records": { "type": "object", "properties": { "A": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "ttl": { "type": "integer" }, "extra": { "type": [ "string", "null" ] } } } }, "MX": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "ttl": { "type": "integer" }, "extra": { "type": "string" } } } }, "NS": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "ttl": { "type": "integer" }, "extra": { "type": [ "string", "null" ] } } } } } }, "has_mail": { "type": "boolean" }, "spf": { "type": "boolean" }, "dmarc": { "type": "boolean" }, "parked_at": { "type": [ "string", "null" ] } } } } }, "example": { "data": { "host": "example.org", "records": { "A": [ { "value": "93.184.215.14", "ttl": 300, "extra": null } ], "MX": [ { "value": "mail.example.org", "ttl": 3600, "extra": "10" } ], "NS": [ { "value": "a.iana-servers.net", "ttl": 86400, "extra": null } ] }, "has_mail": true, "spf": true, "dmarc": false, "parked_at": null } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/webhooks": { "get": { "operationId": "listWebhooks", "tags": [ "Webhook endpoints" ], "summary": "Your webhook endpoints", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "disabled_at": { "type": [ "string", "null" ] }, "consecutive_failures": { "type": "integer" }, "last_delivered_at": { "type": "string" }, "created_at": { "type": "string" } } } } } }, "example": { "data": [ { "id": 3, "url": "https://hooks.example.com/hunter", "events": [ "alert.matched", "domain.available" ], "active": true, "disabled_at": null, "consecutive_failures": 0, "last_delivered_at": "2026-10-06T16:44:03Z", "created_at": "2026-10-03T10:25:00Z" } ] } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "createWebhook", "tags": [ "Webhook endpoints" ], "summary": "Add a webhook endpoint", "description": "Up to 3 endpoints. The signing `secret` is returned once, in this response only; store it.", "x-plan": "pro", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "description": "An `https://` address on a public host.", "type": "string" }, "events": { "description": "Events to deliver. Default: all.", "type": "array", "items": { "type": "string", "enum": [ "alert.matched", "domain.available", "domain.ending_soon", "check.completed" ] } } }, "required": [ "url" ] }, "example": { "url": "https://hooks.example.com/hunter", "events": [ "alert.matched", "domain.available" ] } } } }, "responses": { "201": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "disabled_at": { "type": [ "string", "null" ] }, "consecutive_failures": { "type": "integer" }, "last_delivered_at": { "type": "string" }, "created_at": { "type": "string" }, "secret": { "type": "string" } } } } }, "example": { "data": { "id": 3, "url": "https://hooks.example.com/hunter", "events": [ "alert.matched", "domain.available" ], "active": true, "disabled_at": null, "consecutive_failures": 0, "last_delivered_at": "2026-10-06T16:44:03Z", "created_at": "2026-10-03T10:25:00Z", "secret": "whsec_3Qd…" } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/webhooks/{id}": { "get": { "operationId": "getWebhook", "tags": [ "Webhook endpoints" ], "summary": "One webhook endpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The endpoint id.", "schema": { "type": "integer" }, "example": 12 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "disabled_at": { "type": [ "string", "null" ] }, "consecutive_failures": { "type": "integer" }, "last_delivered_at": { "type": "string" }, "created_at": { "type": "string" } } } } }, "example": { "data": { "id": 3, "url": "https://hooks.example.com/hunter", "events": [ "alert.matched", "domain.available" ], "active": true, "disabled_at": null, "consecutive_failures": 0, "last_delivered_at": "2026-10-06T16:44:03Z", "created_at": "2026-10-03T10:25:00Z" } } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "patch": { "operationId": "updateWebhook", "tags": [ "Webhook endpoints" ], "summary": "Change or re-enable an endpoint", "description": "An endpoint that failed 15 deliveries in a row is switched off; send `{\"active\": true}` to switch it back on.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The endpoint id.", "schema": { "type": "integer" }, "example": 12 } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "description": "New address.", "type": "string" }, "events": { "description": "New event list.", "type": "array", "items": { "type": "string", "enum": [ "alert.matched", "domain.available", "domain.ending_soon", "check.completed" ] } }, "active": { "description": "Pause or resume deliveries.", "type": "boolean" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "url": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "active": { "type": "boolean" }, "disabled_at": { "type": [ "string", "null" ] }, "consecutive_failures": { "type": "integer" }, "last_delivered_at": { "type": "string" }, "created_at": { "type": "string" } } } } }, "example": { "data": { "id": 3, "url": "https://hooks.example.com/hunter", "events": [ "alert.matched", "domain.available" ], "active": true, "disabled_at": null, "consecutive_failures": 0, "last_delivered_at": "2026-10-06T16:44:03Z", "created_at": "2026-10-03T10:25:00Z" } } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "delete": { "operationId": "deleteWebhook", "tags": [ "Webhook endpoints" ], "summary": "Remove an endpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The endpoint id.", "schema": { "type": "integer" }, "example": 12 } ], "responses": { "204": { "description": "Done. No content." }, "default": { "$ref": "#/components/responses/Error" } } } }, "/webhooks/{id}/test": { "post": { "operationId": "testWebhook", "tags": [ "Webhook endpoints" ], "summary": "Send a test event", "description": "Queues a `ping` event to the endpoint, whatever it is subscribed to.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The endpoint id.", "schema": { "type": "integer" }, "example": 12 } ], "responses": { "202": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "event": { "type": "string" }, "status": { "type": "string" }, "attempts": { "type": "integer" }, "response_code": { "type": [ "string", "null" ] }, "error": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "delivered_at": { "type": [ "string", "null" ] } } } } }, "example": { "data": { "id": "evt_01k6x2f0q8m3r7t9v4b5n6c8dz", "event": "ping", "status": "pending", "attempts": 0, "response_code": null, "error": null, "created_at": "2026-10-06T16:44:02Z", "delivered_at": null } } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/webhooks/{id}/deliveries": { "get": { "operationId": "listWebhookDeliveries", "tags": [ "Webhook endpoints" ], "summary": "Recent deliveries", "description": "The last 50 deliveries with their status and the response code of the latest attempt. Kept for 14 days.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The endpoint id.", "schema": { "type": "integer" }, "example": 12 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "event": { "type": "string" }, "status": { "type": "string" }, "attempts": { "type": "integer" }, "response_code": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "created_at": { "type": "string" }, "delivered_at": { "type": "string" } } } } } }, "example": { "data": [ { "id": "evt_01k6x2f0q8m3r7t9v4b5n6c8dz", "event": "alert.matched", "status": "delivered", "attempts": 1, "response_code": 200, "error": null, "created_at": "2026-10-06T16:44:02Z", "delivered_at": "2026-10-06T16:44:03Z" } ] } } } }, "default": { "$ref": "#/components/responses/Error" } } } } }, "components": { "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "description": "An API key from your account page, sent as \"Authorization: Bearer hd_…\"." } }, "responses": { "Error": { "description": "An error. `code` is stable and meant for programs; `message` is meant for people.", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "unauthenticated", "email_unverified", "plan_required", "not_found", "no_checks_left", "limit_reached", "validation_failed", "rate_limited", "lookup_quota_exceeded", "method_not_allowed", "server_error" ] }, "message": { "type": "string" }, "fields": { "type": "object", "description": "Validation messages by field (only with validation_failed)." }, "docs": { "type": "string", "format": "uri" } } } } }, "example": { "error": { "code": "plan_required", "message": "This domain is on the Pro list.", "upgrade_url": "https://hunter.domains/pricing", "docs": "https://hunter.domains/docs/api#errors" } } } } } } } }