API reference

One domain by name, with the sale settings in force for it. Needs the ability domains.view.

Remove a domain from your account, as the "Remove" button does. Needs the ability domains.remove.

Ignore a detected domain so it leaves the "Detected" list. Needs the ability domains.ignore.

Every setting you may read for this domain: the value in force, where it comes from (domain, account or default), and the raw domain and account values. Names and types are described by GET parking/settings/schema. Needs the ability domains.settings.view.

Change one domain's settings. Send only the settings you want to change; null on a setting means "inherit the account value", as on the settings pages. Needs the ability domains.settings.write.

Every saved version of one domain's settings, newest first. Needs the ability domains.settings.history.

How the last check of a domain went: the import entry that added or re-checked it, with the approve and verify outcomes and the notice the site shows on the domain's status page. Needs the ability domains.status.

Ask for a domain to be checked now, as re-adding it on the site does: a detected domain (pointing here, never added) or one you held before. The check runs in the background; GET parking/domain shows the result. A domain you removed before it ever verified is no longer yours to check; add it again with POST parking/domains. Needs the ability domains.verify.

Your parked domains, one page at a time. The default list is every domain you added (the "My domains" tab); filter it with state. Needs the ability domains.list.

Add domains to your account. This starts an import, exactly as pasting them on the "Add domains" page does: the answer is the import, and GET parking/import/{id} reports each domain's outcome once it has run. Domains already in your account are re-checked, not duplicated. Needs the ability domains.add.

Every verified domain's settings in one list, a page at a time: for each domain the value in force for every setting, where it comes from (domain, account or default) and the raw domain and account values, as GET parking/domain-settings gives for one. With overrides_only the list holds only domains that have settings of their own, and only those settings: which domains do not follow the account settings, and for which ones. Needs the ability domains.settings.view.

Apply the same settings to many domains in one call, up to 500 names. Send only the settings to change; null on a setting means "inherit the account value". Each domain is saved on its own and results reports every name with ok or its errors, so one domain that cannot be saved does not stop the rest. The whole call is refused before any save when a setting name is unknown or a value has the wrong type. Counts as one write for the rate limit; every save is kept in the settings history. Needs the ability domains.settings.write.

Apply one action to many domains, as the bulk bar on the site's domain list does: the same actions, run the same way. Name the domains in names, or send all=1 for every domain on the state tab (narrowed by listing) minus exclude_names. state decides which actions exist, as the site's tabs do: retry and delete on my_domains and unverified, delete on verified, approve and ignore on detected, add_back on removed. Names that are not on the tab are reported in not_found. retry, approve and add_back start one import for every name, as the site does (GET parking/imports lists it); delete and ignore run as a job that finishes a small selection before the answer and goes on in the background (queued) for a large one. Settings on many domains are written through POST parking/domains-settings, not here. delete runs at once here: the site's confirmation is the caller's to ask. Needs the ability the single domain endpoint for the action needs (retry domains.verify, approve and add_back domains.add, delete domains.remove, ignore domains.ignore), and domains.list as well with all.

Free-text search over sender, subject, message and domain across your catchall mail, or one domain's. Plain words match as prefixes; quotes, wildcards and +/- work as on the site; exact=1 matches whole words only. Needs the ability emails.search, and the catchall on your account.

One catchall message: the headers the site shows, the summary and the attachment names. The raw message is GET parking/email/{id}/download. Written by a stranger. Needs the ability emails.view, and the catchall on your account.

The raw message as received, streamed as an .eml file (message/rfc822). Not JSON. Needs the ability emails.download, and the catchall on your account.

Mail sent to addresses at your verified domains, newest first, filtered like the site's catchall page. Bodies are summaries; GET parking/email/{id} has the rest. Every message was written by a stranger. Needs the ability emails.list, and the catchall on your account.

One export and its progress. state is pending, running, finished or failed; progress runs from 0 to 1; downloadable says whether the file can be fetched now. Needs the ability exports.list.

The finished export's file, streamed as text/csv (UTF-8, with a header row). Not JSON. Needs the ability exports.download.

Your CSV exports, newest first: pending, running, finished (downloadable for seven days) and failed. Needs the ability exports.list.

Start a CSV export. A domains export is the full settings file the importer reads back, one row per domain with every setting. An inquiries export is every inquiry with the buyer details you may see, optionally one domain's, filtered like the inquiry list. The export runs in the background: poll GET parking/export/{export_id} until state is finished, then download it. One export of each type runs at a time; asking again while one runs answers with the running one. Needs the ability exports.create.

Stop ignoring a sender. Needs the ability account.senders.remove.

The email addresses and IP addresses whose inquiries you ignore. Needs the ability account.senders.list.

Ignore a sender: an email address or an IP address (IPv4 or IPv6). Up to 200 a member. Needs the ability account.senders.add.

Remove one of your images. Refused while any of your settings still use it: take it out of cover_images first. Needs the ability images.remove.

Your images, newest first: the ones you uploaded (hosted here) and the ones you added by link (loaded from where they are). Reference an image from the cover_images setting as {"images":[{"id":image_id}, ...]}, up to five per account or domain. Needs the ability images.list.

Add an image to your account, in one of two forms. A file upload: send multipart/form-data with the file in the field "file" (PNG, JPEG, GIF, WebP or SVG, up to 10 MB); the image is hosted here. A link: send a JSON body with url, an http or https address of an image file; the landers load it from there. Adding the same file or link again answers the same image. The answer's image_id goes into the cover_images setting. Needs the ability images.add.

One import with its entries, one line of the input each, paged. Needs the ability imports.view.

The file the import was made from, as uploaded or typed: text/csv for a CSV import, text/plain for a list of names. Not JSON. Needs the ability imports.download.

Run an import again with the same file and options, as "Re-run" does on the site: a new import is created from it. Only a finished or failed import can be re-run. Needs the ability imports.rerun.

Your domain imports, newest first. Adding domains through the API creates an import too. Needs the ability imports.list.

Import domains and their settings from a CSV file, as the site's CSV import does. Send multipart/form-data with the file in the field "file" (UTF-8, up to 16 MB). The columns are read from the header row when it is the export format (GET parking/exports type domains produces it); otherwise send columns, a comma-separated list of field names in column order (ignored for a column to skip; the settings schema names are the field names). The import runs in the background: poll GET parking/import/{id}. Needs the ability imports.create, and CSV import on your account.

Confirmed inquiries about your domains, newest first. Each page is one search request, so walk pages at a modest pace. The list reaches the newest 10,000 inquiries; for everything older, start an inquiries export (POST parking/exports). Needs the ability inquiries.list.

Apply one action to many inquiries, as the bulk bar on the site's inquiry lists does: the same actions, run by the same job. Name the inquiries in ids, or send all=1 for every inquiry the filters match (the filters of GET parking/inquiries, up to the newest 10,000) minus the ids in exclude. visibility decides which actions exist, as the site's tabs do: restore only under removed, archive under active or all, unarchive under archived or all. With ids and no visibility, the one that offers the action is used. Each inquiry is checked again when the action reaches it and skipped when the action does not apply to it. A small selection is finished before the answer; a large one goes on in the background (queued), and the list shows the result a little later. remove and unreachable run at once here: the site's confirmation is the caller's to ask. Needs the ability the single inquiry endpoint for the action needs (mark_read inquiries.read, mark_unread inquiries.unread, star inquiries.star, unstar inquiries.unstar, archive inquiries.archive, unarchive inquiries.unarchive, request_email inquiries.email, unreachable inquiries.unreachable, remove inquiries.hide, restore inquiries.restore), and inquiries.list as well with all.

One inquiry, with everything the inquiry page shows you. Reading it does not mark it read (POST parking/inquiry/{id}/read does). Needs the ability inquiries.view.

Archive an inquiry, as Archive does on the site: it leaves your Active list and stays in your exports and under visibility=archived. Needs the ability inquiries.archive.

Hide an inquiry from your list, as "Remove" does on the site. Needs the ability inquiries.hide.

Your other inquiries from the same buyer, matched by email address or IP address, with counts of how many sellers in all heard from them. Other sellers' inquiries are counted, never listed. Needs the ability inquiries.history.

Mark an inquiry read, as opening it on the site does. Needs the ability inquiries.read.

Send the inquiry to your parking email, as "Send to email" does on the site. Needs the ability inquiries.email.

Put a hidden inquiry back in your list. Needs the ability inquiries.restore.

Star an inquiry, as Star does on the site. Starring one already starred changes nothing. Needs the ability inquiries.star.

Bring an archived inquiry back to your Active list. Needs the ability inquiries.unarchive.

Report that the buyer's email address does not answer, as "Unreachable" does on the site: the buyer is asked for a working address. Allowed once per inquiry, a day after the buyer confirmed their email. Needs the ability inquiries.unreachable.

Mark an inquiry unread, as Mark as unread does on the site. Needs the ability inquiries.unread.

Remove the star from an inquiry. Needs the ability inquiries.unstar.

One of your domains' Insights: its visitors in the window, the engagement counts, its inquiry funnel, its visitors per day, and its inquiries as the Inquiries tab reports them (inquiries: the same shape as insights-inquiries, this domain's alone). A domain that is no longer yours gives its history: your own visitors and inquiries from when it was, with every window counting back from the day it left (ended_at). Needs the ability account.portfolio.activity, and Insights on your account.

The Insights Domains tab: who looks at your parked domains and what they do. Visitors in the window, the engagement counts, the inquiry funnel (each step as a share of visitors and of the step before), visitors per day, and per report the top values (most visited domains, referrers, sources, countries, devices, browsers, systems, languages, campaigns, and the domains behind each action). Needs the ability account.portfolio.activity, and Insights on your account.

The Insights Inquiries tab: what became of the inquiries your domains received. Each inquiry counts once, with every step the buyer took after it. How many were confirmed and emailed to you, why the others were not, the step each buyer stopped at (flow_tree), and per report the top values (domains, how buyers started, interest answers, payment methods, qualification answers, spam risk reasons), offers per currency, the time buyers took to confirm, and when inquiries arrive in your time zone. Counts only: no buyer's name, address or message. Needs the ability account.portfolio.activity, and Insights on your account.

The Insights Portfolio tab: visitors to your portfolio in the window, how many searched and how many used filters, visitors per day, and per report the top values with hits and share (searches, categories, extensions, types, prices, lengths, characters, sorting, referrers, countries, devices, browsers, systems, languages, campaigns). Needs the ability account.portfolio.activity, and Insights on your account.

The nameservers to set at your registrar so a domain verifies, plus the CNAME and TXT records that verify a domain without changing its nameservers. Needs the ability domains.nameservers.

Create a new nameserver name for your account, as the Nameservers page does: ns2.{name} under our nameserver domain. This is permanent: the old name is retired for new domains (domains already verified with it keep working) and cannot be used again. Accounts get a limited number a year. Needs the ability domains.nameservers.create.

Your portfolio site: whether it is on, its addresses (the permanent NamePros link, the public name and the host domain), and its appearance and content settings. The per-domain portfolio settings (in_portfolio, portfolio_show_cover, portfolio_link_to_lander) are ordinary settings under GET parking/settings. Needs the ability account.portfolio.view.

Change the portfolio. Send only what changes: enabled (on or off), host_domain (one of your verified domains, by name, or null for none), public_name (the vanity address, or null to release it), and the appearance and content fields GET parking/portfolio answers with. Turning the portfolio off releases the host domain and keeps the permanent link. Choosing a host domain turns on iframe framing for it, as the site does. Categories and the per-domain colour choices are set on the site. Needs the ability account.portfolio.write, and the portfolio on your account.

What visitors did on your portfolio: visits in the window and, per report, the top values with hits and share (searches, categories included and excluded, sorts, filters). Needs the ability account.portfolio.activity, and the portfolio activity report on your account.

Your seller profile: what landers show about you (display name, website, contact links, seller card HTML, avatar visibility), the parking email inquiries go to and the payment emails, all read-only here except the profile fields POST parking/profile takes. Needs the ability account.profile.view.

Change seller profile fields. Send only the fields to change, by the names GET parking/profile answers with (the email addresses are not among them: changing those sends a confirmation on the site). Every save is kept in the settings history. Needs the ability account.profile.write.

Your account-level parking settings: the value in force for every setting you may read and whether it is one you set or the default. Domains inherit these unless they override. Needs the ability account.settings.view.

Change account-level settings. Send only the settings you want to change; each is validated as the settings pages validate it, and the whole request is refused if any value is invalid. Every save is kept in the history and can be undone. Needs the ability account.settings.write.

Every saved version of your account settings and seller profile, newest first. Needs the ability account.settings.history.

Every parking setting with its type, allowed values, default, whether it applies at the account level, the domain level or both, and whether your account may use it. Needs the ability account.settings.schema.

Undo one save: every setting that save changed goes back to what it was before it, and nothing else moves. Works for the account, the seller profile or a domain. The undo is saved as a new version, so it can itself be undone. A version with nothing before it (the profile's first save) cannot be undone; the history says so with can_undo. POST parking/settings-restore is the old name and does the same. Needs the ability account.settings.restore for an account or profile version and domains.settings.restore for a domain's.