Reference

client.hello() -> Namecom.HelloResponse

📝 Description

Returns basic information about the API server (useful for testing connectivity and version checks).

🔌 Usage

await client.hello();

⚙️ Parameters

requestOptions: NamecomClient.RequestOptions

Account Info

client.accountInfo.checkAccountBalance() -> Namecom.CheckAccountBalanceResponse

📝 Description

Returns the current account credit balance for the authenticated user.

🔌 Usage

await client.accountInfo.checkAccountBalance();

⚙️ Parameters

requestOptions: AccountInfoClient.RequestOptions

Accounts

client.accounts.createAccount({ ...params }) -> Namecom.CreateAccountResponse

📝 Description

Creates a new sub-account under your authenticated reseller account and returns API credentials for the new account. This endpoint is only available to approved reseller accounts. Contact name.com support to request access.

🔌 Usage

await client.accounts.createAccount({
    account: {
        accountName: "reseller_subaccount",
        contacts: {
            registrant: {
                firstName: "Jane",
                lastName: "Doe",
                address1: "123 Main St.",
                city: "Denver",
                state: "CO",
                zip: "12345",
                country: "US",
                email: "admin@example.net",
                phone: "+13035551212"
            }
        },
        password: "SecureP4ss!"
    },
    apiTos: true,
    tos: true
});

⚙️ Parameters

request: Namecom.CreateAccountRequest

requestOptions: AccountsClient.RequestOptions

Domains

client.domains.listDomains({ ...params }) -> Namecom.ListDomainsResponse

📝 Description

Lists all domains in your account (basic details for each domain).

🔌 Usage

await client.domains.listDomains();

⚙️ Parameters

request: Namecom.ListDomainsRequest

requestOptions: DomainsClient.RequestOptions

client.domains.createDomain({ ...params }) -> Namecom.CreateDomainResponse

📝 Description

Registers a new domain under your account. You must provide domain.domainName at minimum. This endpoint is commonly used to programmatically onboard new domains through user signup flows or checkout experiences.

If no contacts are passed in this request, the default contacts for your name.com account will be used.

Create Domain pricing

See the Domain purchase pricing guide for the full reference. Recommendation: For most integrations, scope discovery to purchaseType: registration. Other purchase types are supported but add complexity — details in the guide above.

Discovery (required before create): Call Search or Check Availability, not Get Pricing alone. Both return the same SearchResult fields (purchaseType, purchasePrice, premium, purchasable). Zone Check is designed for rapid availability checks only; it is not sufficient to complete a purchase.

Getting the price for Create Domain

Search or Check Availability → copy purchaseType, premium, note purchasePrice.
Branch on purchaseType:
- registration + premium: false — omit purchasePrice on create, set years. Optional: Get Pricing with same years to preview the total.
- registration + premium: true — Get Pricing with same years → pass purchasePrice exactly.
- aftermarket / expiring / backorder — use discovery purchasePrice (flat fee). Re-check discovery before create. Do not use Get Pricing for create price. years does not multiply price or guarantee registration length.
If purchasePrice is sent, it must match exactly or the request fails with 400 and "Purchase price does not match".

Years on acquisition types: For aftermarket_s, aftermarket_b, aftermarket_i, expiring, and backorder: omit years or pass the TLD default. Check domain.expireDate in the response; Renew to extend registration.

Best Practices For Domain Creates

In general, you should check that a domain is available prior to attempting to purchase a domain. You can use either the checkAvailability endpoint, or the Search endpoint to confirm that a domain is purchasable.

Important Note on Dropcatching and Abuse Prevention

The createDomain endpoint is designed for standard domain registrations and is not intended for automated dropcatching (i.e., mass or high-frequency attempts to register domains the moment they become available after expiration). The use of drop-catching tools or services to acquire expired domains is strictly prohibited. All domain acquisitions must go through approved channels to ensure fair and transparent access.

Contact Verification

When a new domain registration is created and a contact is submitted, name.com may need to validate the contact's email address in accordance with ICANN policy. This validation involves sending an email to the provided address, prompting the recipient to click a link to verify their email address.

🔌 Usage

await client.domains.createDomain({
    domain: {
        domainName: "example.com"
    }
});

⚙️ Parameters

request: Namecom.CreateDomainRequest

requestOptions: DomainsClient.IdempotentRequestOptions

client.domains.getDomain({ ...params }) -> Namecom.DomainResponsePayload

📝 Description

Retrieves detailed information for a specific domain in your account.

🔌 Usage

await client.domains.getDomain({
    domainName: "example.com"
});

⚙️ Parameters

request: Namecom.GetDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.updateDomain({ ...params }) -> Namecom.DomainResponsePayload

📝 Description

Allows updating of the autorenew, WhoIs Privacy and lock status of the specified domain. The request requires one, or any combination of the parameters in order to pass validation. If any of the requested updates failed, the domain will be returned to it's original state.

🔌 Usage

await client.domains.updateDomain({
    domainName: "domainName",
    body: {
        autorenewEnabled: true
    }
});

⚙️ Parameters

request: Namecom.UpdateDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.disableAutorenew({ ...params }) -> Namecom.Domain

📝 Description

Turns off automatic renewal for a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.

🔌 Usage

await client.domains.disableAutorenew({
    domainName: "example.com",
    body: {}
});

⚙️ Parameters

request: Namecom.DisableAutorenewRequest

requestOptions: DomainsClient.RequestOptions

client.domains.disableWhoisPrivacy({ ...params }) -> Namecom.Domain

📝 Description

Disables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.

🔌 Usage

await client.domains.disableWhoisPrivacy({
    domainName: "example.com",
    body: {}
});

⚙️ Parameters

request: Namecom.DisableWhoisPrivacyRequest

requestOptions: DomainsClient.RequestOptions

client.domains.enableAutorenew({ ...params }) -> Namecom.Domain

📝 Description

Turns on automatic renewal for a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.

🔌 Usage

await client.domains.enableAutorenew({
    domainName: "example.com",
    body: {}
});

⚙️ Parameters

request: Namecom.EnableAutorenewRequest

requestOptions: DomainsClient.RequestOptions

client.domains.enableWhoisPrivacy({ ...params }) -> Namecom.Domain

📝 Description

Enables WHOIS privacy protection on a domain. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.

🔌 Usage

await client.domains.enableWhoisPrivacy({
    domainName: "domainName",
    body: {}
});

⚙️ Parameters

request: Namecom.EnableWhoisPrivacyRequest

requestOptions: DomainsClient.RequestOptions

client.domains.getAuthCodeForDomain({ ...params }) -> Namecom.AuthCodeResponse

📝 Description

Retrieves the transfer authorization code (EPP code) for a domain.

🔌 Usage

await client.domains.getAuthCodeForDomain({
    domainName: "domainName"
});

⚙️ Parameters

request: Namecom.GetAuthCodeForDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.getPricingForDomain({ ...params }) -> Namecom.PricingResponse

📝 Description

Returns registration, renewal, and transfer pricing for a domain and term.

Not a discovery endpoint: Does not return purchaseType. Cannot determine whether a domain is acquired via registration vs aftermarket/expiring/backorder — call Search or Check Availability first.

Scope: purchasePrice and premium reflect standard and registry-premium registration only. They do not return aftermarket, expiring, or backorder acquisition prices. For those types, use purchasePrice from Search or Check Availability.

Registration create (purchaseType: registration): When create requires purchasePrice (registry premium), call with the same years you will send on create. Pass purchasePrice directly — it is the total for that term, not a per-year component.

Renew: Pass renewalPrice as purchasePrice on Renew Domain for premium renewals — not for computing Create Domain totals.

Transfer: Pass transferPrice as purchasePrice on Create Transfer for premium transfers. The years query parameter does not affect transferPrice.

See the Domain pricing guide for the full workflow.

🔌 Usage

await client.domains.getPricingForDomain({
    domainName: "domainName",
    years: 2
});

⚙️ Parameters

request: Namecom.GetPricingForDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.lockDomain({ ...params }) -> Namecom.Domain

📝 Description

Locks a domain to prevent it from being transferred. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.

🔌 Usage

await client.domains.lockDomain({
    domainName: "example.com",
    body: {}
});

⚙️ Parameters

request: Namecom.LockDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.purchasePrivacy({ ...params }) -> Namecom.PrivacyResponse

📝 Description

Adds or renews WHOIS privacy protection for a domain. This is used to ensure personal contact details remain hidden from public WHOIS lookups. If WHOIS privacy is already enabled, this will extend the protection. If it’s not yet active, this will both purchase and enable the service. This is a billable action unless covered by a bundled privacy plan.

🔌 Usage

await client.domains.purchasePrivacy({
    domainName: "domainName"
});

⚙️ Parameters

request: Namecom.DomainsPurchasePrivacyBody

requestOptions: DomainsClient.IdempotentRequestOptions

client.domains.renewDomain({ ...params }) -> Namecom.RenewDomainResponse

📝 Description

Renews an existing domain for an additional registration period. Include the domain name and renewal term. Omit purchasePrice for standard (non-premium) renewals. For premium renewals, pass renewalPrice from Get Pricing with matching years as purchasePrice. Renewal pricing is separate from Create Domain registration/acquisition pricing. This is typically used to extend ownership before a domain’s expiration.

🔌 Usage

await client.domains.renewDomain({
    domainName: "domainName"
});

⚙️ Parameters

request: Namecom.DomainsRenewDomainBody

requestOptions: DomainsClient.RequestOptions

client.domains.setContacts({ ...params }) -> Namecom.DomainResponsePayload

📝 Description

Updates WHOIS contact information for a domain. This includes the registrant, administrative, technical, and billing contacts. All contact objects must be complete — partial updates are not supported. You should fetch the existing contact data first (e.g., via GetDomain and modify only the values you wish to change. This call replaces all four contact sets at once.

Contact Verification

When registrant contact information is updated, validation may be triggered if the new contact information has not been previously validated. This validation is required by ICANN for all TLDs except country-code TLDs (ccTLDs). This validation involves sending an email to the provided address, prompting the recipient to click a link to verify their email address.

🔌 Usage

await client.domains.setContacts({
    domainName: "example.com"
});

⚙️ Parameters

request: Namecom.DomainsSetContactsBody

requestOptions: DomainsClient.RequestOptions

client.domains.setNameservers({ ...params }) -> Namecom.DomainResponsePayload

📝 Description

SetNameservers will set the nameservers for the Domain. This operation updates the DNS configuration by changing which nameservers are responsible for the domain's zone.

🔌 Usage

await client.domains.setNameservers({
    domainName: "example.com",
    nameservers: ["ns1.name.com", "ns2.name.com"]
});

⚙️ Parameters

request: Namecom.DomainsSetNameserversBody

requestOptions: DomainsClient.RequestOptions

client.domains.unlockDomain({ ...params }) -> Namecom.Domain

📝 Description

Unlocks a domain to allow it to be transferred. DEPRECATED This endpoint is deprecated in favor of the new UpdateDomain API. This will be removed in a future release.

🔌 Usage

await client.domains.unlockDomain({
    domainName: "domainName",
    body: {}
});

⚙️ Parameters

request: Namecom.UnlockDomainRequest

requestOptions: DomainsClient.RequestOptions

client.domains.checkAvailability({ ...params }) -> Namecom.SearchResponse

📝 Description

Checks whether up to 50 domain names are purchasable and returns discovery pricing for each result.

Discovery endpoint: Returns SearchResult fields — purchaseType, purchasePrice, premium, purchasable. Search returns the same fields for keyword/suggestion flows. Use this endpoint to determine what to send on Create Domain.

When results show premium: true or a non-registration purchaseType, follow the Domain pricing guide before calling Create Domain. For non-registration types, re-check Check Availability immediately before create — acquisition prices can change.

🔌 Usage

await client.domains.checkAvailability({
    domainNames: ["domainNames"]
});

⚙️ Parameters

request: Namecom.AvailabilityRequest

requestOptions: DomainsClient.RequestOptions

client.domains.search({ ...params }) -> Namecom.SearchResponse

📝 Description

Searches for domain name suggestions based on a keyword or term. Important: Do not encode the : in the path. Use /core/v1/domains:search, not /core/v1/domains%3Asearch.

Discovery endpoint: Returns SearchResult fields — purchaseType, purchasePrice, premium, purchasable.

Recommendation: Set purchaseType to registration. Most resellers restrict results to domains with a purchaseType of registration to ensure predictable pricing and immediate fulfillment. Other purchase types (such as aftermarket) can introduce higher costs and non-instant transactions that may be delayed or declined by third parties. With purchaseType: registration, domains that do not match the filter are omitted from results (unlike Check Availability, which returns them with purchasable: false).

When results show premium: true or a non-registration purchaseType, follow the Domain pricing guide before calling Create Domain. For all types, re-check with Check Availability immediately before create — prices and availability can change.

🔌 Usage

await client.domains.search({
    keyword: "mydomain"
});

⚙️ Parameters

request: Namecom.SearchRequest

requestOptions: DomainsClient.RequestOptions

client.domains.zoneCheck({ ...params }) -> Namecom.ZoneCheckResponse

📝 Description

Zone Check offers a rapid, preliminary check for domain availability by leveraging cached zone file data. Ideal for large-batch queries, it provides a high confidence indication of a domain's availability significantly faster than live registry checks. For definitive, real-time availability and pricing, you can follow up with the standard Check Availability call. The API normalizes and validates each submitted domain string. Domains that fail validation, use an unsupported TLD for this service, or are otherwise not eligible for zone check are removed from the request before the zone file lookup runs. The response includes only a numeric count of removed domains (removed); individual removed strings are not returned. A future API version may extend the contract to include details about removed domains.

For the best results and to avoid 400 Bad Request errors after cleaning, ensure each domain string meets the criteria described for domainNames in the request body schema.

If no valid domains remain after this process, the API returns a 400 Bad Request response. Note: The cached zone files used for this check are refreshed twice daily based on the latest available data from the registries.

🔌 Usage

await client.domains.zoneCheck({
    domainNames: ["example.com", "example.net", "example.org"]
});

⚙️ Parameters

request: Namecom.ZoneCheckRequest

requestOptions: DomainsClient.RequestOptions

DNSSECs

client.dnsseCs.listDnsseCs({ ...params }) -> Namecom.ListDnsseCsResponse

📝 Description

Lists all DNSSEC (DS) records configured for a domain.

🔌 Usage

await client.dnsseCs.listDnsseCs({
    domainName: "domainName"
});

⚙️ Parameters

request: Namecom.ListDnsseCsRequest

requestOptions: DnsseCsClient.RequestOptions

client.dnsseCs.createDnssec({ ...params }) -> Namecom.Dnssec

📝 Description

Adds (registers) a new DNSSEC DS record for a domain.

🔌 Usage

await client.dnsseCs.createDnssec({
    domainName: "domainName",
    algorithm: 1,
    digest: "digest",
    digestType: 1,
    keyTag: 1
});

⚙️ Parameters

request: Namecom.CreateDnssecBody

requestOptions: DnsseCsClient.RequestOptions

client.dnsseCs.getDnssec({ ...params }) -> Namecom.Dnssec

📝 Description

Retrieves details of a specific DNSSEC record for a domain.

🔌 Usage

await client.dnsseCs.getDnssec({
    domainName: "domainName",
    digest: "digest"
});

⚙️ Parameters

request: Namecom.GetDnssecRequest

requestOptions: DnsseCsClient.RequestOptions

client.dnsseCs.deleteDnssec({ ...params }) -> void

📝 Description

Deletes a DNSSEC record from a domain.

🔌 Usage

await client.dnsseCs.deleteDnssec({
    domainName: "domainName",
    digest: "digest"
});

⚙️ Parameters

request: Namecom.DeleteDnssecRequest

requestOptions: DnsseCsClient.RequestOptions

Email Forwardings

client.emailForwardings.listEmailForwardings({ ...params }) -> Namecom.ListEmailForwardingsResponse

📝 Description

Returns a paginated list of all email forwarding rules for a domain.

🔌 Usage

await client.emailForwardings.listEmailForwardings({
    domainName: "domainName",
    perPage: 100,
    page: 1
});

⚙️ Parameters

request: Namecom.ListEmailForwardingsRequest

requestOptions: EmailForwardingsClient.RequestOptions

client.emailForwardings.createEmailForwarding({ ...params }) -> Namecom.EmailForwarding

📝 Description

Creates a new email forwarding rule for a domain, such as redirecting info@example.com to an external inbox. If this is the first email forwarding rule created for the domain, the API may also update your MX records automatically to enable mail routing. The alias must not conflict with existing email services or MX records. To modify a forwarding rule later, use UpdateEmailForwarding.

🔌 Usage

await client.emailForwardings.createEmailForwarding({
    domainName: "example.com",
    emailBox: "admin",
    emailTo: "webmaster@example.com"
});

⚙️ Parameters

request: Namecom.CreateEmailForwardingRequest

requestOptions: EmailForwardingsClient.RequestOptions

client.emailForwardings.getEmailForwarding({ ...params }) -> Namecom.EmailForwarding

📝 Description

Retrieves the details of a specific email forwarding entry.

🔌 Usage

await client.emailForwardings.getEmailForwarding({
    domainName: "domainName",
    emailBox: "emailBox"
});

⚙️ Parameters

request: Namecom.GetEmailForwardingRequest

requestOptions: EmailForwardingsClient.RequestOptions

client.emailForwardings.updateEmailForwarding({ ...params }) -> Namecom.EmailForwarding

📝 Description

Updates the destination email address for an existing forwarding rule.

🔌 Usage

await client.emailForwardings.updateEmailForwarding({
    domainName: "domainName",
    emailBox: "emailBox"
});

⚙️ Parameters

request: Namecom.EmailForwardingsUpdateEmailForwardingBody

requestOptions: EmailForwardingsClient.RequestOptions

client.emailForwardings.deleteEmailForwarding({ ...params }) -> void

📝 Description

Deletes an email forwarding rule from a domain.

🔌 Usage

await client.emailForwardings.deleteEmailForwarding({
    domainName: "domainName",
    emailBox: "emailBox"
});

⚙️ Parameters

request: Namecom.DeleteEmailForwardingRequest

requestOptions: EmailForwardingsClient.RequestOptions

DNS

client.dns.listRecords({ ...params }) -> Namecom.ListRecordsResponse

📝 Description

Lists all DNS records for a specified domain.

🔌 Usage

await client.dns.listRecords({
    domainName: "domainName"
});

⚙️ Parameters

request: Namecom.ListRecordsRequest

requestOptions: DnsClient.RequestOptions

client.dns.createRecord({ ...params }) -> Namecom.Record_

📝 Description

Adds a new DNS record to the specified domain zone. Provide the record type (e.g. A, MX, CNAME), host, value, and TTL. This is used for configuring domain-based services such as email, website hosting, or third-party verifications.

🔌 Usage

await client.dns.createRecord({
    domainName: "domainName",
    answer: "answer",
    host: "host",
    type: "A"
});

⚙️ Parameters

request: Namecom.DnsCreateRecordBody

requestOptions: DnsClient.RequestOptions

client.dns.getRecord({ ...params }) -> Namecom.Record_

📝 Description

Retrieves details of a specific DNS record.

🔌 Usage

await client.dns.getRecord({
    domainName: "domainName",
    id: 1
});

⚙️ Parameters

request: Namecom.GetRecordRequest

requestOptions: DnsClient.RequestOptions

client.dns.updateRecord({ ...params }) -> Namecom.Record_

📝 Description

Replaces an existing DNS record with new data. This is a full overwrite — all required fields (host, type, answer, ttl) must be included in the request body. If you omit a field, the existing value will not be preserved and the request may fail. Use GetRecord beforehand to retrieve the current values if you intend to modify just one field. The record ID must belong to a domain you manage.

🔌 Usage

await client.dns.updateRecord({
    domainName: "domainName",
    id: 1,
    answer: "answer",
    type: "A"
});

⚙️ Parameters

request: Namecom.DnsUpdateRecordBody

requestOptions: DnsClient.RequestOptions

client.dns.deleteRecord({ ...params }) -> void

📝 Description

Removes a DNS record by ID. Often used during cleanup operations or when replacing outdated DNS settings with updated records.

🔌 Usage

await client.dns.deleteRecord({
    domainName: "domainName",
    id: 1
});

⚙️ Parameters

request: Namecom.DeleteRecordRequest

requestOptions: DnsClient.RequestOptions

URL Forwardings

client.urlForwardings.listUrlForwardings({ ...params }) -> Namecom.ListUrlForwardingsResponse

📝 Description

Returns all URL forwarding settings configured for a domain. Deprecated. Use List URL Forwardings by domain instead, which returns entries with an id for use with by-ID endpoints.

🔌 Usage

await client.urlForwardings.listUrlForwardings({
    domainName: "example.com",
    perPage: 100,
    page: 1
});

⚙️ Parameters

request: Namecom.ListUrlForwardingsRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.createUrlForwarding({ ...params }) -> Namecom.UrlForwardingResponse

📝 Description

Sets up a new URL forwarding (redirect) for a domain or subdomain. If this is the first URL forwarding entry, it may modify the A records for the domain accordingly. Note that changes may take up to 24 hours to fully propagate.

🔌 Usage

await client.urlForwardings.createUrlForwarding({
    domainName: "example.com",
    body: {
        forwardsTo: "https://destination-site.com",
        host: "www",
        type: "masked"
    }
});

⚙️ Parameters

request: Namecom.CreateUrlForwardingRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.getUrlForwarding({ ...params }) -> Namecom.UrlForwardingResponse

📝 Description

Retrieves the details of a specific URL forwarding configuration. Deprecated. Use Get URL Forwarding by ID instead.

🔌 Usage

await client.urlForwardings.getUrlForwarding({
    domainName: "example.com",
    host: "www.example.org"
});

⚙️ Parameters

request: Namecom.GetUrlForwardingRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.updateUrlForwarding({ ...params }) -> Namecom.UrlForwardingResponse

📝 Description

Modifies an existing URL forwarding rule. Changes may take up to 24 hours to fully propagate. Deprecated. Use Update URL Forwarding by ID instead.

🔌 Usage

await client.urlForwardings.updateUrlForwarding({
    domainName: "example.com",
    host: "www.example.org",
    body: {
        forwardsTo: "https://destination-site.com",
        host: "www",
        type: "masked"
    }
});

⚙️ Parameters

request: Namecom.UpdateUrlForwardingRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.deleteUrlForwarding({ ...params }) -> void

📝 Description

Removes a URL forwarding configuration from the domain. This operation cannot be undone. Deprecated. Use Delete URL Forwarding by ID instead.

🔌 Usage

await client.urlForwardings.deleteUrlForwarding({
    domainName: "example.com",
    host: "www.example.org"
});

⚙️ Parameters

request: Namecom.DeleteUrlForwardingRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.listUrlForwardingsByDomain({ ...params }) -> Namecom.ListUrlForwardingsResponse

📝 Description

Returns all URL forwarding settings configured for a domain. Each entry includes an id that can be used with the URL Forwarding by-ID endpoints to get, update, or delete records.

🔌 Usage

await client.urlForwardings.listUrlForwardingsByDomain({
    domainName: "example.com",
    perPage: 100,
    page: 1
});

⚙️ Parameters

request: Namecom.ListUrlForwardingsByDomainRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.getUrlForwardingById({ ...params }) -> Namecom.UrlForwardingResponse

📝 Description

Retrieves the details of a specific URL forwarding configuration by ID. The domain must be owned by the authenticated account.

🔌 Usage

await client.urlForwardings.getUrlForwardingById({
    domainName: "example.com",
    id: 12345
});

⚙️ Parameters

request: Namecom.GetUrlForwardingByIdRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.deleteUrlForwardingById({ ...params }) -> void

📝 Description

Removes a URL forwarding configuration by ID. The domain must be owned by the authenticated account. This operation cannot be undone.

🔌 Usage

await client.urlForwardings.deleteUrlForwardingById({
    domainName: "example.com",
    id: 12345
});

⚙️ Parameters

request: Namecom.DeleteUrlForwardingByIdRequest

requestOptions: UrlForwardingsClient.RequestOptions

client.urlForwardings.updateUrlForwardingById({ ...params }) -> Namecom.UrlForwardingResponse

📝 Description

Modifies an existing URL forwarding rule by ID. The domain must be owned by the authenticated account. Changes may take up to 24 hours to fully propagate.

🔌 Usage

await client.urlForwardings.updateUrlForwardingById({
    domainName: "example.com",
    id: 12345,
    body: {
        forwardsTo: "https://destination-site.com",
        host: "www",
        type: "masked"
    }
});

⚙️ Parameters

request: Namecom.UpdateUrlForwardingByIdRequest

requestOptions: UrlForwardingsClient.RequestOptions

Vanity Nameservers

client.vanityNameservers.listVanityNameservers({ ...params }) -> Namecom.ListVanityNameserversResponse

📝 Description

Lists all vanity nameserver hostnames configured for a domain.

🔌 Usage

await client.vanityNameservers.listVanityNameservers({
    domainName: "example.com",
    perPage: 50,
    page: 2
});

⚙️ Parameters

request: Namecom.ListVanityNameserversRequest

requestOptions: VanityNameserversClient.RequestOptions

client.vanityNameservers.createVanityNameserver({ ...params }) -> Namecom.VanityNameserverResponse

📝 Description

🔌 Usage

await client.vanityNameservers.createVanityNameserver({
    domainName: "example.com",
    hostname: "ns1",
    ips: ["192.168.1.10", "2001:0db8:85a3:0000:0000:8a2e:0370:7334"]
});

⚙️ Parameters

request: Namecom.CreateVanityNameserverBody

requestOptions: VanityNameserversClient.RequestOptions

client.vanityNameservers.getVanityNameserver({ ...params }) -> Namecom.VanityNameserverResponse

📝 Description

Retrieves details for a of a specific vanity nameserver (including its IP addresses).

🔌 Usage

await client.vanityNameservers.getVanityNameserver({
    domainName: "example.com",
    hostname: "ns1.example.com"
});

⚙️ Parameters

request: Namecom.GetVanityNameserverRequest

requestOptions: VanityNameserversClient.RequestOptions

client.vanityNameservers.updateVanityNameserver({ ...params }) -> Namecom.VanityNameserverResponse

📝 Description

Updates the glue record IP addresses for a vanity nameserver.

🔌 Usage

await client.vanityNameservers.updateVanityNameserver({
    domainName: "example.com",
    hostname: "ns1.example.com"
});

⚙️ Parameters

request: Namecom.UpdateVanityNameserverBody

requestOptions: VanityNameserversClient.RequestOptions

client.vanityNameservers.deleteVanityNameserver({ ...params }) -> void

📝 Description

Deletes a vanity nameserver from the domain’s registry settings. This operation might fail if the registry detects the nameserver is still in use.

🔌 Usage

await client.vanityNameservers.deleteVanityNameserver({
    domainName: "example.com",
    hostname: "ns1.example.com"
});

⚙️ Parameters

request: Namecom.DeleteVanityNameserverRequest

requestOptions: VanityNameserversClient.RequestOptions

Webhook Notifications

client.webhookNotifications.getSubscribedNotifications() -> Namecom.ListSubscribedWebhooksResponse

📝 Description

Retrieves all active webhook subscriptions on the account.

🔌 Usage

await client.webhookNotifications.getSubscribedNotifications();

⚙️ Parameters

requestOptions: WebhookNotificationsClient.RequestOptions

client.webhookNotifications.subscribeToNotification({ ...params }) -> Namecom.SubscribeToNotificationResponse

📝 Description

Creates a webhook subscription to receive real-time notifications about specific domain or account events (e.g. transfer completions, renewals). Pass the callback URL and event types. This allows external systems to stay in sync with name.com changes. Supported webhook event names:

account.credit.balance_change – account credit balance changes (increases or decreases).
account.domain.removal – domain removed from the subscribing account.
domain.lock.status_change – domain lock added or removed.
domain.transfer.status_change – domain transfer IN to name.com; status updates while name.com is the gaining registrar.
domain.transfer_out.status_change – domain transfer OUT from name.com; initiated, completed (domain removed), or canceled (no longer pending at the registry).
domain.transfer.internal_in - name.com domain transfers in to the subscribing account via internal transfer.
domain.transfer.internal_out - name.com domain transfers out of the subscribing account via internal transfer.
contact.verification.status_change - contact verification status changes (verified or unverified).
domain.registry.rejection – domain create failed after asynchronous registry processing (uncommon; most creates succeed at request time).
domain.expiration – domain has expired and entered the post-expiry grace period. This is informational only.

🔌 Usage

await client.webhookNotifications.subscribeToNotification({
    eventName: "account.credit.balance_change",
    url: "https://example.com",
    active: true
});

⚙️ Parameters

request: Namecom.SubscribeToNotification

requestOptions: WebhookNotificationsClient.RequestOptions

client.webhookNotifications.modifySubscription({ ...params }) -> Namecom.ModifySubscriptionResponse

📝 Description

Updates an existing webhook’s configuration. This may include changing the callback URL or updating whether the webhook is currently active.

🔌 Usage

await client.webhookNotifications.modifySubscription({
    id: 1,
    body: {
        url: "url"
    }
});

⚙️ Parameters

request: Namecom.ModifySubscriptionRequest

requestOptions: WebhookNotificationsClient.RequestOptions

client.webhookNotifications.deleteSubscription({ ...params }) -> void

📝 Description

Removes a webhook subscription from the account.

🔌 Usage

await client.webhookNotifications.deleteSubscription({
    id: 1
});

⚙️ Parameters

request: Namecom.DeleteSubscriptionRequest

requestOptions: WebhookNotificationsClient.RequestOptions

Orders

client.orders.listOrders({ ...params }) -> Namecom.ListOrdersResponse

📝 Description

Retrieves a list of all orders placed in the account.

🔌 Usage

await client.orders.listOrders();

⚙️ Parameters

request: Namecom.ListOrdersRequest

requestOptions: OrdersClient.RequestOptions

client.orders.getOrder({ ...params }) -> Namecom.Order

📝 Description

Fetches full details about a specific order using its ID. This includes domains, prices, and timestamps. Useful for confirming transactions, receipts, or generating invoices.

🔌 Usage

await client.orders.getOrder({
    orderId: 1
});

⚙️ Parameters

request: Namecom.GetOrderRequest

requestOptions: OrdersClient.RequestOptions

Refunds

client.refunds.processRefund({ ...params }) -> Namecom.RefundResponse

📝 Description

Deletes eligible domains and security products during the Add Grace Period (AGP) and automatically issues refunds for the associated order items.

Eligibility Requirements

Product Types: Only registration and whois_privacy product types are eligible for refunds.
AGP Timing: Items must be within the Add Grace Period (typically 5 days from registration, varies by TLD).
Order Ownership: All orderItemIds must belong to the specified orderId.

Refund Processing

Refunds are processed in the following order:

Domain deletion is attempted for each eligible order item
Upon successful deletion, the refund is issued
Refunds are sent to the original payment method on file
If the original payment method is unavailable, the refund is credited to the account balance

Idempotency

This endpoint supports idempotent requests via the X-Idempotency-Key header. If you retry a request with the same idempotency key, you will receive the same response as the original request. This is useful for safely retrying requests without risk of processing duplicate refunds.

🔌 Usage

await client.refunds.processRefund({
    orderId: 123456,
    orderItemIds: [987654]
});

⚙️ Parameters

request: Namecom.RefundRequest

requestOptions: RefundsClient.IdempotentRequestOptions

Transfers

client.transfers.listTransfers({ ...params }) -> Namecom.ListTransfersResponse

📝 Description

Returns all domain transfer requests for the account, including in-progress and recent transfers.

🔌 Usage

await client.transfers.listTransfers();

⚙️ Parameters

request: Namecom.ListTransfersRequest

requestOptions: TransfersClient.RequestOptions

client.transfers.createTransfer({ ...params }) -> Namecom.CreateTransferResponse

📝 Description

Initiates a domain transfer into your name.com account from another registrar. You must provide the domain name and its valid transfer authorization code (EPP code). The domain must not be locked or under any transfer restrictions (e.g. clientTransferProhibited). If successful, the transfer is submitted and tracked through the ICANN transfer process. Once a transfer has been created, you can track its progress via the GetTransfer endpoint. Transfer pricing: Omit purchasePrice for standard (non-premium) transfers. For premium transfers, pass transferPrice from Get Pricing For Domain as purchasePrice. If sent, it must match Get Pricing transferPrice exactly or the request will fail. Premium transfers without purchasePrice will fail. See the Domain pricing guide for how Get Pricing transferPrice relates to the years query parameter.

🔌 Usage

await client.transfers.createTransfer({
    authCode: "ABC123",
    domainName: "example.com"
});

⚙️ Parameters

request: Namecom.CreateTransferRequest

requestOptions: TransfersClient.RequestOptions

client.transfers.getTransfer({ ...params }) -> Namecom.Transfer

📝 Description

Retrieves details of a specific domain transfer request.

🔌 Usage

await client.transfers.getTransfer({
    domainName: "domainName"
});

⚙️ Parameters

request: Namecom.GetTransferRequest

requestOptions: TransfersClient.RequestOptions

client.transfers.cancelTransfer({ ...params }) -> Namecom.Transfer

📝 Description

Cancels a pending transfer request. This can be used if the transfer was initiated in error or if the authorization code provided was incorrect. The price of the transfer will refund the amount to account credit.

Cancelable statuses:

pending
submitting_transfer
pending_new_auth_code
pending_unlock
pending_registry_unlock
rejected

Non-cancelable statuses:

pending_transfer
pending_insert
completed
failed
canceled
canceled_pending_refund

🔌 Usage

await client.transfers.cancelTransfer({
    domainName: "domainName",
    body: {}
});

⚙️ Parameters

request: Namecom.CancelTransferRequest

requestOptions: TransfersClient.RequestOptions

client.transfers.cancelOutboundTransfer({ ...params }) -> Namecom.CancelTransferOutResponse

📝 Description

Cancels an outbound transfer for the given domain. Use this when the domain is being transferred out of name.com (losing registrar) to another (gaining) registrar and the registrant or reseller wants to cancel that transfer. On success, subscribers receive domain.transfer_out.status_change with status canceled. The endpoint validates that the domain exists and belongs to the authenticated account. Only domains in a pending transfer (out) state can be canceled.

🔌 Usage

await client.transfers.cancelOutboundTransfer({
    domainName: "example.com",
    body: {}
});

⚙️ Parameters

request: Namecom.CancelOutboundTransferRequest

requestOptions: TransfersClient.RequestOptions

client.transfers.createInternalTransferIn({ ...params }) -> Namecom.DomainResponsePayload

📝 Description

Pulls a domain from another name.com account into your reseller (gaining) account using a valid authorization code. This is an internal name.com-to-name.com move; it is separate from Create Transfer, which brings domains in from external registrars. Check if a TLD is eligible for internal transfer in by calling Tld Requirements for the TLD and checking property supportsInternalTransfer. This API is only available to approved reseller accounts. Contact name.com support to request access.

Losing account (dashboard only)

The party that holds the domain today must use the name.com dashboard on the losing account to unlock the domain (remove registrar transfer lock) and to copy the authorization code to provide to your integration. This endpoint does not unlock the domain or retrieve the auth code for the losing account.

Gaining account (this API)

Call this endpoint with domainName, authCode, and optional contacts using the gaining reseller's API credentials.

Contacts and post-transfer lock

If contacts is omitted, the gaining account's default contacts are applied. If contacts is provided, any roles included in the request are applied and omitted roles use the gaining account's default contacts (same pattern as Create Domain and Set Contacts). The 60-day contact-change transfer lock is enforced based on the gaining account's settings, consistent with Set Contacts.

Access

Restricted to approved enterprise resellers; other callers receive 403 Forbidden.

🔌 Usage

await client.transfers.createInternalTransferIn({
    domainName: "example.com",
    authCode: "ABC123"
});

⚙️ Parameters

request: Namecom.CreateInternalTransferInRequest

requestOptions: TransfersClient.RequestOptions

client.transfers.getTransferEligibility({ ...params }) -> Namecom.TransferEligibilityResponse

📝 Description

Returns whether a domain is currently registered at name.com and whether the TLD supports internal transfer between name.com accounts. Use this to decide whether to send your user through the Create Transfer external transfer flow or the Create Internal Transfer In flow before initiating a transfer-in.

Response semantics

atName is true if the domain is currently registered at name.com in any account. This information is also publicly available via RDAP.

supportsInternalTransfer mirrors the TLD-level value returned by Tld Requirements. It indicates whether the TLD is eligible for internal transfer between name.com accounts. It does not reflect per-account allowlist eligibility — if your account is not allowlisted for internal transfer in, calling Create Internal Transfer In will return 403 Forbidden.

Privacy

This endpoint never reveals which account a domain is in. To check whether a domain is in your own account, use Get Domain instead.

🔌 Usage

await client.transfers.getTransferEligibility({
    domainName: "domainName"
});

⚙️ Parameters

request: Namecom.GetTransferEligibilityRequest

requestOptions: TransfersClient.RequestOptions

Domain Info

client.domainInfo.getRequirement({ ...params }) -> Namecom.GetRequirementResponse

📝 Description

Returns the registration requirements some general information for a specific TLD. The response contains a detailed description of eligibility criteria and a fields object with all required and optional fields, including validation rules, conditional logic, and nested field structures. Provide the TLD as a path parameter to retrieve its complete registration requirements. Useful when you only need details for one TLD (e.g., when a user selects .fr from a dropdown).

🔌 Usage

await client.domainInfo.getRequirement({
    tld: "fr"
});

⚙️ Parameters

request: Namecom.GetRequirementRequest

requestOptions: DomainInfoClient.RequestOptions

client.domainInfo.checkDomainClaims({ ...params }) -> Namecom.DomainClaimsCheckResponse

📝 Description

Performs the actual claims check for a specific domain. This endpoint checks if a specific domain has trademark claims against it, returning detailed information about any matching trademarks and their holders. Use this to verify if a domain can be registered without trademark conflicts. Please see the claims flow for information on how to use this endpoint in your domain purchase flow.

🔌 Usage

await client.domainInfo.checkDomainClaims({
    domain: "tiktok.page"
});

⚙️ Parameters

request: Namecom.DomainClaimsCheckRequest

requestOptions: DomainInfoClient.RequestOptions

client.domainInfo.getTldRequirementsV2({ ...params }) -> Namecom.RequirementsJsonSchema

📝 Description

Returns the registration requirements as a JSON Schema (Draft 7) document. This endpoint is designed for form generation and validation libraries that consume JSON Schema directly.

🔌 Usage

await client.domainInfo.getTldRequirementsV2({
    tld: "fr"
});

⚙️ Parameters

request: Namecom.GetTldRequirementsV2Request

requestOptions: DomainInfoClient.RequestOptions

TLD Pricing

client.tldPricing.tldPriceList({ ...params }) -> Namecom.TldPriceListResponse

📝 Description

This endpoint returns an alphabetical list of all TLDs supported by name.com, including pricing for each supported order type. All prices are in US Dollars (USD) and apply to non-premium domains. name.com provides three pricing types for each TLD:

Account-Level Pricing - Your price, including any applicable rebates, promotions, or account-level discounts. This is referenced as 'registrationprice', 'renewalprice', 'transferinprice' and 'domainrestorationprice' in this endpoint.
Original Pricing (No Discounts Applied) - The suggested retail price (MSRP) before any discounts are applied.
Retail Pricing (Public Site Pricing) - The current public retail price on name.com, including any public rebates or promotions, but before any account-level discounts.

Important Notes:

Promo codes are not supported through the API, and therefore are not reflected in any pricing values returned.
General TLD pricing only: This represents standard pricing for domains registered under the specified TLD. Pricing for specific domains may differ based on multiple factors (e.g., premium classifications, registry pricing rules). To retrieve pricing for an individual domain, use the GetPricingForDomain endpoint.
Availability: If a pricing value is returned as null, that product type is not currently supported for the TLD. (Example: registrationPrice = null means registrations are not currently available.)
If you do not have account level pricing, the retail price will always match your account level price. (e.g., registration price = registration retail price)

🔌 Usage

await client.tldPricing.tldPriceList({
    duration: 1
});

⚙️ Parameters

request: Namecom.TldPriceListRequest

requestOptions: TldPricingClient.RequestOptions

Premium Domains

client.premiumDomains.premiumDomainLists() -> Namecom.PremiumDomainsDownloadResponse

📝 Description

Gets a pre-signed URL that will allow a user to download a list of premium domains, with their registration and renewal pricing. Please Note: The pre-signed URL will only be valid for 10 minutes. This endpoint is only available to approved reseller accounts. Contact name.com support to request access.

🔌 Usage

await client.premiumDomains.premiumDomainLists();

⚙️ Parameters

requestOptions: PremiumDomainsClient.RequestOptions

Contact Verification

client.contactVerification.unverifiedContactsList({ ...params }) -> Namecom.UnverifiedContactsResponse

📝 Description

Returns a list of contacts, related to domains within your account, that require verification as per ICANN procedures. When a new domain is created, unverified contacts are not immediately available in API responses. Records are added by a scheduled process that runs approximately every 10 minutes. As a result, there may be up to a 10-minute delay before unverified contacts appear in the API. This delay also applies to related events such as webhooks or other downstream systems that depend on contact verification data.

🔌 Usage

await client.contactVerification.unverifiedContactsList({
    perPage: 100,
    page: 2
});

⚙️ Parameters

request: Namecom.UnverifiedContactsListRequest

requestOptions: ContactVerificationClient.RequestOptions

client.contactVerification.verifyContact({ ...params }) -> void

📝 Description

Use this API to verify a contact. This API is only available to approved reseller accounts. Contact name.com support to request access.

🔌 Usage

await client.contactVerification.verifyContact({
    verificationId: 1,
    body: {}
});

⚙️ Parameters

request: Namecom.VerifyContactRequest

requestOptions: ContactVerificationClient.IdempotentRequestOptions

client.contactVerification.resendContactVerificationEmail({ ...params }) -> Namecom.ContactVerificationResendResponse

📝 Description

Resend the contact verification email for a pending verification record.

Throttling

This endpoint enforces strict throttling to prevent abuse:

Per verificationId: max 1 resend per 15 minutes
Per reseller account: max 200 resends per rolling hour

nextEligibleAt is always returned so the client knows when it can try again.

On 429, the response uses the standard error envelope, and details contains the earliest retry time (RFC3339 UTC).

🔌 Usage

await client.contactVerification.resendContactVerificationEmail({
    verificationId: 1,
    body: {}
});

⚙️ Parameters

request: Namecom.ResendContactVerificationEmailRequest

requestOptions: ContactVerificationClient.IdempotentRequestOptions

Uh oh!

FilesExpand file tree

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

📝 Description

🔌 Usage

⚙️ Parameters

Account Info

📝 Description

🔌 Usage

⚙️ Parameters

Accounts

📝 Description

🔌 Usage

⚙️ Parameters

Domains

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

Create Domain pricing

Getting the price for Create Domain

Best Practices For Domain Creates

Important Note on Dropcatching and Abuse Prevention

Contact Verification

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

Contact Verification

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters