# DomainGenius

## Pages

- [Welcome](/introduction): DomainGenius is a domain registrar built for people who like the command line as much as the dashboard.
- [Quickstart](/quickstart): Sign up, mint an API key, and register a domain — five minutes.
- [Concepts](/concepts): The vocabulary the rest of the docs assumes you know.
- [Buy a domain](/guides/buying-a-domain): Search, check availability, and register through the dashboard or the API.
- [Transfer a domain in](/guides/transferring-in): Bring a domain registered elsewhere over to DomainGenius.
- [Manage DNS records](/guides/dns-records): Add, update, and delete A, AAAA, CNAME, MX, TXT, and other records on a managed zone.
- [Apply a DNS preset](/guides/dns-presets): One-click templates for Vercel, Google Workspace, Microsoft 365, and other common providers.
- [Contacts and WHOIS](/guides/contacts-and-whois): Manage the registrant, admin, technical, and billing contacts on your domains.
- [URL forwarding and redirects](/guides/redirects): Forward a domain to another URL with optional path forwarding and priority rules.
- [Park a domain or list it for sale](/guides/parking-and-for-sale): Configure a parked landing page or put a domain on the marketplace with a minimum offer.
- [Renewals and auto-renew](/guides/renewals-and-auto-renew): Stop a domain from expiring — manually, automatically, or both.
- [Estimate a domain's value](/guides/valuation): Run a domain through DomainGenius's valuation model for a market-comp-backed price.
- [Bulk search and batch availability](/guides/bulk-search): Check thousands of names at once via bulk endpoints and the streaming search API.
- [Organisations and members](/guides/organizations): Create orgs, invite teammates, set roles.
- [Create and rotate API keys](/guides/api-keys): Mint, scope, and revoke keys for scripts and CI.
- [Billing and balance](/guides/billing-and-balance): Top up the prepaid balance, set auto-top-up, and download invoices.
- [Configure webhooks](/guides/webhooks): Subscribe an HTTPS endpoint to domain lifecycle and billing events.
- [Registration FAQ](/faq/registration): Common questions about registering a domain.
- [DNS FAQ](/faq/dns): Common questions about DNS, propagation, and record types.
- [Transfers FAQ](/faq/transfers): Moving a domain in to or out of DomainGenius.
- [Pricing and billing FAQ](/faq/pricing-and-billing): How DomainGenius charges, refunds, and bills.
- [Security and privacy FAQ](/faq/security-and-privacy): How we protect accounts, data, and your domains.
- [.au domains FAQ](/faq/au-domains): Eligibility, registry rules, and quirks of the .au namespace.
- [API overview](/api/introduction): HTTP JSON API for domain search, registration, DNS, billing, and account management.
- [Authentication](/api/authentication): Bearer tokens — Clerk session JWTs for browsers, API keys for scripts.
- [API keys and scopes](/api/api-keys-and-scopes): Mint keys, choose scopes, rotate, and revoke.
- [Errors](/api/errors): HTTP status codes and error body shape.
- [Rate limits](/api/rate-limits): Per-key limits, headers, and how to recover from 429.
- [Pagination](/api/pagination): Cursor-based pagination on list endpoints.
- [Webhooks](/api/webhooks): Event delivery for domain lifecycle and billing changes.
- [MCP overview](/mcp/introduction): Connect AI assistants to DomainGenius via Model Context Protocol.
- [MCP authentication](/mcp/authentication): Two ways to authenticate — Clerk OAuth or an API key.
- [MCP scopes](/mcp/scopes): Per-tool scope requirements — what your token needs to call what.
- [Claude Desktop](/mcp/install/claude-desktop): Connect DomainGenius MCP to Anthropic's Claude Desktop app.
- [Claude Code](/mcp/install/claude-code): Connect DomainGenius MCP to Claude Code (CLI).
- [Cursor](/mcp/install/cursor): Connect DomainGenius MCP to Cursor.
- [Windsurf](/mcp/install/windsurf): Connect DomainGenius MCP to Windsurf (Codeium).
- [VS Code](/mcp/install/vscode): Connect DomainGenius MCP to VS Code's MCP support.
- [Zed](/mcp/install/zed): Connect DomainGenius MCP as a Zed context server.
- [Cline](/mcp/install/cline): Connect DomainGenius MCP to the Cline VS Code extension.
- [Availability tools](/mcp/tools/availability): Check whether domains can be registered, and look up TLD pricing and eligibility.
- [Contact tools](/mcp/tools/contacts): Manage org-wide contacts and assign them to domains as registrant, admin, technical, or billing.
- [DNS tools](/mcp/tools/dns): Read and write DNS records, plus apply preset templates for common providers.
- [Domain tools](/mcp/tools/domains): List, inspect, and update settings on domains the org owns.
- [Organisation tools](/mcp/tools/orgs): Discover the caller's identity and orgs, then read org details and members.
- [Registration tools](/mcp/tools/registration): Register and renew domains, read the org balance, and poll pending confirmations.
- [CONTRIBUTING](/CONTRIBUTING)
- [List Market Domains](/reference/list-market-domains-api-v1-market-get): List all active for-sale domains with optional filters.

This is a public endpoint for the DomainGenius marketplace.
- [Get Market Domain](/reference/get-market-domain-api-v1-market-domain-get): Get single for-sale domain with full stats.
- [Check Availability](/reference/check-availability-api-v1-domains-availability-get): Check if a single domain is available for registration.

Args:
    domain: Domain name to check (e.g., example.com)

Returns:
    Availability status with timestamp
- [Check Bulk Availability](/reference/check-bulk-availability-api-v1-domains-availability-bulk-post): Check availability for multiple domains (max 30).

Args:
    request: List of domains to check

Returns:
    Availability results for all domains
- [Search Stream](/reference/search-stream-api-v1-domains-search-stream-get): Stream domain availability results via SSE.
- [Get For Sale](/reference/get-for-sale-api-v1-domains-domain-for-sale-get): Get for-sale listing for a domain.
- [Create Or Update For Sale](/reference/create-or-update-for-sale-api-v1-domains-domain-for-sale-put): Create or update for-sale listing for a domain.
- [Delete For Sale](/reference/delete-for-sale-api-v1-domains-domain-for-sale-delete): Delete for-sale listing for a domain.
- [Get Parked](/reference/get-parked-api-v1-domains-domain-parked-get): Get parked config for a domain. Auto-creates with defaults if missing.
- [Update Parked](/reference/update-parked-api-v1-domains-domain-parked-put): Update parked config for a domain.
- [Estimatevaluation](/reference/estimate-valuation-api-v1-valuation-estimate-post): Estimate the market value of a domain name.
- [Getvaluation](/reference/get-valuation-api-v1-valuation-valuation-id-get): Get a persisted valuation by ID.
- [Getvaluationbydomain](/reference/get-valuation-by-domain-api-v1-valuation-domain-domain-get): Get the latest valuation for a domain.
- [Submitfeedback](/reference/submit-feedback-api-v1-valuation-valuation-id-feedback-patch): Submit thumbs up/down feedback for a valuation.
- [Getvaluationhistory](/reference/get-valuation-history-api-v1-valuation-history-list-get): Get paginated valuation history (admin).
- [Getme](/reference/get-me-api-v1-me-get): Return authenticated user profile. Accepts Clerk JWT or dg_xxx API key.
- [Updateme](/reference/update-me-api-v1-me-patch): Update first/last name.
- [Listmyorgs](/reference/list-my-orgs-api-v1-me-orgs-get): List orgs the user belongs to with role and domain count.

Accepts Clerk JWT or dg_xxx API key. API keys must include `orgs:read`.
- [Listapikeys](/reference/list-api-keys-api-v1-me-api-keys-get): List all API keys for the authenticated user.
- [Createapikey](/reference/create-api-key-api-v1-me-api-keys-post): Create a new API key. The full key is returned once — store it immediately.
- [Revokeapikey](/reference/revoke-api-key-api-v1-me-api-keys-key-id-delete): Revoke an API key. Immediately invalidates all requests using this key.
- [Checkslug](/reference/check-slug-api-v1-orgs-check-slug-get): Check if an org slug is available.
- [Createorg](/reference/create-org-api-v1-orgs-post): Create org. Creator becomes owner. Max 5 owned orgs per user.
- [Getorg](/reference/get-org-api-v1-orgs-org-oid-get): Org detail with counts.
- [Updateorg](/reference/update-org-api-v1-orgs-org-oid-patch): Update org name, slug or billing_email.
- [Deleteorg](/reference/delete-org-api-v1-orgs-org-oid-delete): Soft delete org.
- [Listmembers](/reference/list-members-api-v1-orgs-org-oid-members-get): List org members.
- [Addmember](/reference/add-member-api-v1-orgs-org-oid-members-post): Add member by email. User must already exist.
- [Updatememberrole](/reference/update-member-role-api-v1-orgs-org-oid-members-user-oid-patch): Update member role. Cannot change own role or demote last owner.
- [Removemember](/reference/remove-member-api-v1-orgs-org-oid-members-user-oid-delete): Remove member. Cannot remove last owner.
- [Listdomains](/reference/list-domains-api-v1-orgs-org-oid-domains-get): List domains with pagination, search, filters, and sort.
- [Getdomain](/reference/get-domain-api-v1-orgs-org-oid-domains-domain-get): Full domain detail.
- [Updatedomain](/reference/update-domain-api-v1-orgs-org-oid-domains-domain-patch): Update domain configuration.
- [Getdomainstatus](/reference/get-domain-status-api-v1-orgs-org-oid-domains-domain-status-get): Domain status summary.
- [Renewdomain](/reference/renew-domain-api-v1-orgs-org-oid-domains-domain-renew-post): Manually renew a domain. Routes through requestAction so threshold,
balance + auto top-up, idempotency, and audit log all apply.
- [Syncdomainfromregistrar](/reference/sync-domain-from-registrar-api-v1-orgs-org-oid-domains-domain-sync-post): Refresh this domain's state from the registrar (Synergy).
- [Getdomainhealth](/reference/get-domain-health-api-v1-orgs-org-oid-domains-domain-health-get): Get latest health check for a domain.
- [Triggerhealthcheck](/reference/trigger-health-check-api-v1-orgs-org-oid-domains-domain-health-check-post): Trigger a fresh health check for a domain.
- [Enabledns](/reference/enable-dns-api-v1-orgs-org-oid-domains-domain-dns-enable-post): Enable DomainGenius-managed DNS (sets up Cloudflare zone + records + worker).
- [Disabledns](/reference/disable-dns-api-v1-orgs-org-oid-domains-domain-dns-disable-post): Switch to external DNS management (keeps Cloudflare zone for re-enable).
- [Checktransfer](/reference/check-transfer-api-v1-orgs-org-oid-domains-transfer-check-post): Check if a domain can be transferred in.
- [Transferdomain](/reference/transfer-domain-api-v1-orgs-org-oid-domains-transfer-post): Initiate domain transfer into this org.

All transfers are treated as external regardless of whether the domain
exists elsewhere in the system — the recipient never sees source account info.
The domain record is only created/updated when the transfer completes.
- [Listtransfers](/reference/list-transfers-api-v1-orgs-org-oid-domains-transfers-get): List pending and recent domain transfers for this org.
- [Listdnsrecords](/reference/list-dns-records-api-v1-orgs-org-oid-domains-domain-dns-get): List DNS records from Cloudflare.
- [Creatednsrecord](/reference/create-dns-record-api-v1-orgs-org-oid-domains-domain-dns-post)
- [Updatednsrecord](/reference/update-dns-record-api-v1-orgs-org-oid-domains-domain-dns-record-id-put)
- [Deletednsrecord](/reference/delete-dns-record-api-v1-orgs-org-oid-domains-domain-dns-record-id-delete)
- [Listpresetsendpoint](/reference/list-presets-endpoint-api-v1-orgs-org-oid-domains-domain-dns-presets-get)
- [Applydnspreset](/reference/apply-dns-preset-api-v1-orgs-org-oid-domains-domain-dns-presets-apply-post)
- [Getactivepresetsendpoint](/reference/get-active-presets-endpoint-api-v1-orgs-org-oid-domains-domain-dns-presets-active-get)
- [Removednspresetendpoint](/reference/remove-dns-preset-endpoint-api-v1-orgs-org-oid-domains-domain-dns-presets-remove-post)
- [Listforwarding](/reference/list-forwarding-api-v1-orgs-org-oid-domains-domain-forwarding-get)
- [Createforwarding](/reference/create-forwarding-api-v1-orgs-org-oid-domains-domain-forwarding-post)
- [Updateforwarding](/reference/update-forwarding-api-v1-orgs-org-oid-domains-domain-forwarding-forwarding-id-patch)
- [Deleteforwarding](/reference/delete-forwarding-api-v1-orgs-org-oid-domains-domain-forwarding-forwarding-id-delete)
- [Setwwwtoapex](/reference/set-www-to-apex-api-v1-orgs-org-oid-domains-domain-forwarding-www-to-apex-post)
- [Getwwwtoapex](/reference/get-www-to-apex-api-v1-orgs-org-oid-domains-domain-forwarding-www-to-apex-get)
- [Listcontactsendpoint](/reference/list-contacts-endpoint-api-v1-orgs-org-oid-contacts-get): List contacts belonging to this org.
- [Createcontactendpoint](/reference/create-contact-endpoint-api-v1-orgs-org-oid-contacts-post): Create a contact for this org.
- [Updatecontactendpoint](/reference/update-contact-endpoint-api-v1-orgs-org-oid-contacts-contact-id-put): Update an existing contact.
- [Deletecontactendpoint](/reference/delete-contact-endpoint-api-v1-orgs-org-oid-contacts-contact-id-delete): Delete a contact.
- [Listaueligibility](/reference/list-au-eligibility-api-v1-orgs-org-oid-contacts-eligibility-get): List AU eligibility records for this org.
- [Createaueligibility](/reference/create-au-eligibility-api-v1-orgs-org-oid-contacts-eligibility-post): Create an AU eligibility record for this org.
- [Updateaueligibility](/reference/update-au-eligibility-api-v1-orgs-org-oid-contacts-eligibility-eligibility-id-put): Update an AU eligibility record.
- [Deleteaueligibility](/reference/delete-au-eligibility-api-v1-orgs-org-oid-contacts-eligibility-eligibility-id-delete): Delete an AU eligibility record.
- [Listuseligibility](/reference/list-us-eligibility-api-v1-orgs-org-oid-contacts-eligibility-us-get): List US eligibility records for this org.
- [Createuseligibility](/reference/create-us-eligibility-api-v1-orgs-org-oid-contacts-eligibility-us-post): Create a US eligibility record for this org.
- [Updateuseligibility](/reference/update-us-eligibility-api-v1-orgs-org-oid-contacts-eligibility-us-eligibility-id-put): Update a US eligibility record.
- [Deleteuseligibility](/reference/delete-us-eligibility-api-v1-orgs-org-oid-contacts-eligibility-us-eligibility-id-delete): Delete a US eligibility record.
- [Listdomaincontacts](/reference/list-domain-contacts-api-v1-orgs-org-oid-domains-domain-contacts-get): Get contact assignments for a domain. Auto-syncs from registrar if stale.
- [Assigncontact](/reference/assign-contact-api-v1-orgs-org-oid-domains-domain-contacts-contact-type-put): Assign an org contact to a domain for a given type. Also pushes to Synergy.
- [Removecontactassignment](/reference/remove-contact-assignment-api-v1-orgs-org-oid-domains-domain-contacts-contact-type-delete): Remove a contact assignment for a domain type.
- [Copyregistranttoall](/reference/copy-registrant-to-all-api-v1-orgs-org-oid-domains-domain-contacts-copy-registrant-post): Copy registrant contact to admin, technical, and billing. Pushes to Synergy.
- [Syncfromregistrar](/reference/sync-from-registrar-api-v1-orgs-org-oid-domains-domain-contacts-sync-post): Pull contacts from Synergy and update DB.
- [Getauditlog](/reference/get-audit-log-api-v1-orgs-org-oid-audit-log-get): Paginated audit log for the org. Filterable by domain, action, actor.
- [Getbilling](/reference/get-billing-api-v1-orgs-org-oid-billing-get): Get billing overview — balance, auto-topup settings, payment methods.
- [Createdeposit](/reference/create-deposit-api-v1-orgs-org-oid-billing-deposit-post): Top up balance.

If the org has a saved default card → charge it inline and return
`{ ok, balance_cents }`. If 3DS is required → return
`{ requires_action, client_secret, payment_intent_id }`. Otherwise →
fall back to Stripe Checkout and return `{ checkout_url }`.
- [Updateautotopup](/reference/update-auto-topup-api-v1-orgs-org-oid-billing-auto-topup-patch): Update auto top-up settings. Captures PSD2 consent on enable.

Agent-initiated callers (X-Initiator: agent) are rejected on this route —
payment-method changes always require a human in the dash.
- [Detachpaymentmethod](/reference/detach-payment-method-api-v1-orgs-org-oid-billing-payment-methods-payment-method-id-delete): Detach a saved payment method. Clears default if it was the default.

Agent-initiated callers are rejected — payment-method delete is dashboard-only.
- [Listtransactions](/reference/list-transactions-api-v1-orgs-org-oid-billing-transactions-get): Paginated transaction history.
- [Listpaymentmethods](/reference/list-payment-methods-api-v1-orgs-org-oid-billing-payment-methods-get): List saved payment methods.
- [Createsetupintentendpoint](/reference/create-setup-intent-endpoint-api-v1-orgs-org-oid-billing-setup-intent-post): Create a Stripe SetupIntent for adding a payment method.
- [Createsavecardcheckout](/reference/create-save-card-checkout-api-v1-orgs-org-oid-billing-save-card-checkout-post): Create a Stripe-hosted Checkout in setup mode to save a card.
- [Createportalsession](/reference/create-portal-session-api-v1-orgs-org-oid-billing-portal-post): Create a Stripe billing portal session.
- [Processcheckoutendpoint](/reference/process-checkout-endpoint-api-v1-orgs-org-oid-billing-checkout-post): Process cart checkout — debit balance, charge Stripe if needed, enqueue registrations.
- [Getconfirmation](/reference/get-confirmation-api-v1-confirmations-token-get)
- [Approveconfirmationroute](/reference/approve-confirmation-route-api-v1-confirmations-token-approve-post): Approve a pending confirmation and execute the queued action.
- [Denyconfirmationroute](/reference/deny-confirmation-route-api-v1-confirmations-token-deny-post)
- [Listmyconfirmations](/reference/list-my-confirmations-api-v1-me-confirmations-get)
- [Listpricing](/reference/list-pricing-api-v1-pricing-get): List all enabled TLDs with RRP prices.
- [Gettldpricing](/reference/get-tld-pricing-api-v1-pricing-tld-get): Get full RRP pricing for a single TLD.
- [List Redirects](/reference/list-redirects-api-v1-domains-domain-redirects-get): List all redirects for a domain.
- [Create Redirect](/reference/create-redirect-api-v1-domains-domain-redirects-post): Create a new redirect for a domain.
- [Update Redirect](/reference/update-redirect-api-v1-domains-domain-redirects-redirect-id-put): Update an existing redirect.
- [Delete Redirect](/reference/delete-redirect-api-v1-domains-domain-redirects-redirect-id-delete): Delete a redirect.
- [Update Redirect Priorities](/reference/update-redirect-priorities-api-v1-domains-domain-redirects-priorities-patch): Update redirect priorities (for drag-drop reordering).
- [Gettraffic](/reference/get-traffic-api-v1-tools-traffic-get): Get traffic estimation for domain + competitors.
- [Gettechnology](/reference/get-technology-api-v1-tools-technology-get): Get technology stack for domain.
- [Getblacklistcheck](/reference/get-blacklist-check-api-v1-tools-blacklist-get): Check domain against Spamhaus, SURBL, URIBL, Barracuda, SpamCop blacklists.
- [Getkeyworddifficultyendpoint](/reference/get-keyword-difficulty-endpoint-api-v1-tools-keyword-difficulty-post): Get keyword difficulty scores for up to 5 keywords.
- [Health Check](/reference/health-check-health-get): Health check endpoint.
- [Root](/reference/root-get): Root endpoint.