list_domains
List domains from your Porkbun account with optional filters and sorting. Returns up to 1000 domains per page with metadata such as expire date, auto-renew, and API access status.
Instructions
List domains in the authenticated Porkbun account. Returns one page (up to 1000) with metadata: expire date, auto-renew, security lock, WHOIS privacy, API access opt-in, and notLocal flag.
Filters (all optional):
domain: exact match. Returns 0 or 1.name_contains: substring search on domain name.tlds: limit to these TLDs (no leading dot).expiring_within_days: only domains expiring within N days. Useful for renewal automation.auto_renew: 'yes' or 'no'.api_access: 'yes' or 'no'. Filter to domains an API key can actually operate on — eliminatesAPI_ACCESS_DISABLEDerrors downstream.sort_name: 'domain' | 'tld' | 'create_date' | 'expire_date'. Default expire_date.sort_direction: 'asc' | 'desc'. Default asc.
For a single domain by name, use get_domain instead — cleaner shape and 404-on-not-found semantics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | Exact domain match — returns 0 or 1 result. | |
| name_contains | No | Case-insensitive substring on the full domain name. | |
| tlds | No | Limit to these TLDs (no leading dot). Example: ['com', 'io'] | |
| expiring_within_days | No | Only domains expiring within this many days from now. | |
| auto_renew | No | Filter to domains with auto-renew on or off. | |
| api_access | No | Filter to domains opted in to API access. | |
| sort_name | No | Sort field. | |
| sort_direction | No | Sort direction. | |
| start | No | Pagination offset. Default 0. | |
| include_labels | No | Include user-defined domain labels in the response. |