Godaddy
@dougschaefer/godaddyv2026.10.05.1
01README
GoDaddy Domains API toolkit authenticated with a Personal Access Token (Bearer gd_pat_). Read the domain portfolio and full registration detail (transfer authCode always stripped, contacts opt-in), list DNS records by zone, type, or type and name, check availability in bulk, get name suggestions and the TLD catalogue, and read the account's monthly API usage. DNS add, replace, and delete methods are dry-run by default and record a before/planned/after change set. No purchase, renewal, transfer, contact, or privacy operations.
02Release Notes
Initial release: domains, DNS records, availability, suggestions, TLDs and API usage over GoDaddy PAT Bearer auth. DNS add/replace/delete are dry-run by default with SOA and apex-NS guards; no purchase, renewal or transfer operations.
03Models
@dougschaefer/godaddy-domainsv2026.10.05.1godaddy/domains.ts
fn listDomains(statuses?: array, statusGroups?: array, includeNameServers?: boolean, modifiedSince?: string, maxItems?: number)
List every domain on the account (marker-paginated). Writes one `domain` resource per domain and a `domainIndex` summary.
| Argument | Type | Description |
|---|---|---|
| statuses? | array | Only include domains whose status is in this set, e.g. ["ACTIVE"] |
| statusGroups? | array | Only include domains in any of these status groups |
| includeNameServers? | boolean | Ask GoDaddy to include each domain's nameservers (they are null otherwise) |
| modifiedSince? | string | Only include domains modified since this ISO date-time |
| maxItems? | number | Stop after this many domains |
fn getDomain(domain: string, includeContacts?: boolean)
Get full registration detail for one domain. The transfer authCode is always removed; contacts are removed unless includeContacts is true.
| Argument | Type | Description |
|---|---|---|
| domain | string | Domain name, e.g. example.com |
| includeContacts? | boolean | Keep registrant/admin/billing/tech contact blocks (personal data). The transfer authCode is always removed. |
fn apiUsage(month?: string, includeDetail?: boolean)
Read GoDaddy's monthly API request counts for this credential (GET /v2/domains/usage/{yyyy-mm}).
| Argument | Type | Description |
|---|---|---|
| month? | string | Month as yyyy-mm. Defaults to the current UTC month. GoDaddy keeps three months. |
| includeDetail? | boolean | Include per-request-path detail records |
Resources
domain(infinite)— One registered domain from the account list: status, expiry, renewal and lock flags, nameservers
domainIndex(infinite)— Portfolio summary: domain count, counts by status, and the list of domain names
domainDetail(infinite)— Full registration detail for one domain, with authCode removed and contacts removed unless requested
apiUsage(infinite)— GoDaddy Domains API request counts for one month
@dougschaefer/godaddy-dnsv2026.10.05.1godaddy/dns.ts
fn listRecords(domain: string)
List DNS records for a domain, optionally filtered by type, or by type and name. Writes one `recordSet` resource.
| Argument | Type | Description |
|---|---|---|
| domain | string | Domain (zone) name, e.g. example.com |
fn addRecords(domain: string, records: array)
Add DNS records without touching existing ones (PATCH /v1/domains/{domain}/records). Identical existing records are skipped. Apex NS is refused. Dry-run by default.
| Argument | Type | Description |
|---|---|---|
| domain | string | Domain (zone) name, e.g. example.com |
| records | array | Records to add; existing records are kept and identical records are skipped |
fn replaceRecords(domain: string, records: array, allowApexNameservers?: boolean)
Replace all records of a type, or of a type and name (PUT /v1/domains/{domain}/records/{type}[/{name}]). Dry-run by default.
| Argument | Type | Description |
|---|---|---|
| domain | string | Domain (zone) name, e.g. example.com |
| records | array | The complete new set of records for the type/name |
| allowApexNameservers? | boolean | Required for NS at the apex (@) and for any whole-type NS replace, which can take the whole domain offline |
fn deleteRecords(domain: string, allowApexNameservers?: boolean)
Delete all records of a type and name (DELETE /v1/domains/{domain}/records/{type}/{name}). Dry-run by default.
| Argument | Type | Description |
|---|---|---|
| domain | string | Domain (zone) name, e.g. example.com |
| allowApexNameservers? | boolean | Required to delete NS records at the apex (@) |
Resources
recordSet(infinite)— DNS records for a zone, or for one type / type+name slice of it
change(infinite)— A planned (dry-run) or applied DNS change: before, planned, and after record sets
@dougschaefer/godaddy-availabilityv2026.10.05.1godaddy/availability.ts
fn check(domains: array, checkType?: enum)
Check availability of one or more domain names (bulk, read-only). Writes one `availability` resource per name. Never purchases.
| Argument | Type | Description |
|---|---|---|
| domains | array | Domain names to check, e.g. ["example.com", "example.net"]. Up to 500 per call. |
| checkType? | enum | FAST answers from cache; FULL verifies with the registry (slower, more often definitive) |
fn suggest(query: string, tlds?: array, limit?: number, waitMs?: number)
Suggest alternative domain names for a keyword (GET /v1/domains/suggest). Read-only.
| Argument | Type | Description |
|---|---|---|
| query | string | Keyword or domain to base suggestions on, e.g. example |
| tlds? | array | Restrict suggestions to these TLDs, e.g. ["com", "net"] |
| limit? | number | Maximum suggestions to return |
| waitMs? | number | How long GoDaddy may spend gathering suggestions |
fn listTlds()
List TLDs supported and enabled for sale (GET /v1/domains/tlds).
Resources
availability(7d)— Availability answer for one domain name, with list price and renewal price when offered
suggestions(7d)— Domain name suggestions for a query
tlds(30d)— TLDs GoDaddy supports and has enabled for sale
04Stats
A
100 / 100
Downloads
2
Archive size
32.1 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels