API reference
Every endpoint, its parameters, its response and the permission it needs.
GET parking/domain
One domain by name, with the sale settings in force for it. Needs the ability domains.view.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
Response
| Output | Type | Description |
|---|---|---|
| domain | array | The domain as in the list, plus sale: for_sale, bin_price, target_price, accept_offers. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_domain_not_found | 404 No parked domain by that name is in your account. |
DELETE parking/domain
Remove a domain from your account, as the "Remove" button does. Needs the ability domains.remove.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 The domain cannot be removed from your account right now. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
POST parking/domain-ignore
Ignore a detected domain so it leaves the "Detected" list. Needs the ability domains.ignore.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 The domain is not one you can ignore. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/domain-settings
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.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
Response
| Output | Type | Description |
|---|---|---|
| settings | array | Keyed by setting name: value, source, domain_value, account_value. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_domain_not_found | 404 No parked domain by that name is in your account. |
POST parking/domain-settings
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.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
| settings | array | Setting name to new value (null to inherit). |
Response
| Output | Type | Description |
|---|---|---|
| settings | array | The domain settings after the save, as GET parking/domain-settings. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_unknown_settings | 400 A name in settings is not a setting. |
| np_parking_api_error_invalid_settings | 400 Some settings were refused; errors names each one. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/domain-settings-history
Every saved version of one domain's settings, newest first. Needs the ability domains.settings.history.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| versions | array | As GET parking/settings-history, scope domain. |
| pagination | array | current_page, last_page, per_page, shown, total. |
GET parking/domain-status
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.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
Response
| Output | Type | Description |
|---|---|---|
| domain | array | The domain as in the list. |
| entry | array | The latest import entry for it: entry_id, import_id, line, domain, was_added, was_updated, was_ignored, has_warning, has_error, approve_outcome, verify_outcome, notice. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_domain_not_found | 404 No parked domain by that name is in your account. |
| np_parking_api_error_no_status | 404 The domain has never been through an import for your account. |
POST parking/domain-verify
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.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name, Unicode or punycode. |
Response
| Output | Type | Description |
|---|---|---|
| import | array | The import that carries the check. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 The domain is already in your account. |
| np_parking_api_error_domain_not_found | 404 The domain is not one you can see: not detected, not held before. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/domains
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.
Parameters
| Input | Type | Description |
|---|---|---|
| state | string | One of my_domains (default), verified, unverified, detected, removed. |
| query | string | Only domains whose name contains this text (Unicode or punycode), as the site's "Find domains" does. Applies to my_domains and verified. |
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| domains | array | Domains on this page: domain_id, name, punycode, state, is_approved, is_verified, is_portfolio_host, added_date, verified_since, last_verified, next_check, lander_url. |
| pagination | array | current_page, last_page, per_page, shown, total. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_invalid_state | 400 state is not one of the allowed values. |
POST parking/domains
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.
Parameters
| Input | Type | Description |
|---|---|---|
| domains | string[] | Domain names, Unicode or punycode (or one string, one per line). |
| casing_mode | string | auto (default) or manual: whether to keep the casing you typed. |
Response
| Output | Type | Description |
|---|---|---|
| import | array | The import, as GET parking/imports. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_no_domains | 400 domains is empty. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/domains-settings
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.
Parameters
| Input | Type | Description |
|---|---|---|
| overrides_only | bool | Only domains with their own settings, and only those settings. |
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| domains | array | Rows of domain (as in GET parking/domains) and settings (keyed by setting name: value, source, domain_value, account_value). |
| pagination | array | current_page, last_page, per_page, shown, total. |
POST parking/domains-settings
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.
Parameters
| Input | Type | Description |
|---|---|---|
| names | array | Domain names, Unicode or punycode, at most 500. |
| settings | array | Setting name to new value (null to inherit). |
Response
| Output | Type | Description |
|---|---|---|
| saved | integer | How many domains were saved. |
| failed | integer | How many were not. |
| results | array | One row per name: name, ok, and for a failure error (an error code) and, for refused values, errors keyed by setting name. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_no_domains | 400 names is empty. |
| np_parking_api_error_too_many_domains | 400 names holds more than 500 domains. |
| np_parking_api_error_unknown_settings | 400 A name in settings is not a setting. |
| np_parking_api_error_invalid_settings | 400 A value has the wrong type; errors names each one. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/email-search
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.
Parameters
| Input | Type | Description |
|---|---|---|
| query | string | What to search for. |
| exact | bool | Whole words only. |
| domain | string | Only mail to this parked domain (Unicode or punycode). |
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 100 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| emails | array | Rows as in GET parking/emails. |
| pagination | array | current_page, last_page, per_page, shown, total. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_no_query | 400 query is empty. |
| np_parking_api_error_domain_not_found | 404 No parked domain by that name is in your account. |
GET parking/email/{id}
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| array | id, date, domain, from, to, envelope_from, envelope_to, sender, reply_to, subject, summary, attachments, match_labels. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_email_not_found | 404 No message by that id is in your catchall. |
GET parking/email/{id}/download
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| data | binary | The message is output directly, not JSON. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_email_not_found | 404 No message by that id is in your catchall, or its raw data is gone. |
GET parking/emails
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.
Parameters
| Input | Type | Description |
|---|---|---|
| match | string | Which mail: inbox (default: sender's domain contains or resembles a parked domain), domain_contains, domain_similarity, domain_contains_extension, all. |
| domain | string | Only mail to this parked domain (Unicode or punycode). |
| extensions | string | For domain_contains_extension: a comma-separated list of your parked extensions to keep (default all). |
| extension_locations | string | For domain_contains_extension: name, subdomain or both (comma-separated). |
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 100 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| emails | array | Rows: id, date, domain (the parked domains addressed), from, to, envelope_to, subject, summary, match_labels. |
| pagination | array | current_page, last_page, per_page, shown, total. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_invalid_email_filter | 400 match is not one of the allowed values. |
| np_parking_api_error_domain_not_found | 404 No parked domain by that name is in your account. |
GET parking/export/{export_id}
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| export | array | The export, as in GET parking/exports. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_export_not_found | 404 No export by that id is in your account. |
GET parking/export/{export_id}/download
The finished export's file, streamed as text/csv (UTF-8, with a header row). Not JSON. Needs the ability exports.download.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| data | binary | The CSV is output directly, not JSON. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_export_not_found | 404 No export by that id is in your account. |
| np_parking_api_error_export_not_ready | 409 The export has not finished, or it failed. |
GET parking/exports
Your CSV exports, newest first: pending, running, finished (downloadable for seven days) and failed. Needs the ability exports.list.
Parameters
| Input | Type | Description |
|---|---|---|
| type | string | Only exports of this type: domains or inquiries. |
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| exports | array | Exports on this page: export_id, type, state, progress, total_expected, total_fetched, total_bytes, queue_date, start_date, finish_date, error_message, filters (status, delivery, order, domain), file_name, downloadable. |
| pagination | array | current_page, last_page, per_page, shown, total. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_invalid_export_type | 400 type is not domains or inquiries. |
POST parking/exports
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.
Parameters
| Input | Type | Description |
|---|---|---|
| type | string | domains or inquiries. |
| domain | string | Inquiries only: one domain's inquiries (Unicode or punycode). |
| status | string | Inquiries only: all (default), confirmed or unconfirmed. |
| delivery | string | Inquiries only: all (default), delivered or unsent. |
| order | string | Inquiries only: newest (default) or offer. |
Response
| Output | Type | Description |
|---|---|---|
| export | array | The export, as in GET parking/exports. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_invalid_export_type | 400 type is not domains or inquiries. |
| np_parking_api_error_invalid_export_filter | 400 status, delivery or order is not an allowed value. |
| do_not_have_permission | 403 Inquiry exports need the export permission on your account. |
| np_parking_api_error_domain_not_found | 404 No parked domain by that name is in your account. |
| np_parking_api_error_nothing_to_export | 404 Nothing matches: no domains, or no inquiries for the filters. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
DELETE parking/ignored-sender/{id}
Stop ignoring a sender. Needs the ability account.senders.remove.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_sender_not_found | 404 No ignored sender by that id is in your list. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/ignored-senders
The email addresses and IP addresses whose inquiries you ignore. Needs the ability account.senders.list.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| senders | array | Rows: id, type (email or ip), value, date. |
POST parking/ignored-senders
Ignore a sender: an email address or an IP address (IPv4 or IPv6). Up to 200 a member. Needs the ability account.senders.add.
Parameters
| Input | Type | Description |
|---|---|---|
| sender | string | The address to ignore. |
Response
| Output | Type | Description |
|---|---|---|
| sender | array | The new row: id, type, value, date. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_sender_refused | 400 Not an address, already ignored, or the list is full; message says which. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
DELETE parking/image/{image_id}
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_image_not_found | 404 No image by that id is in your account. |
| np_parking_api_error_image_in_use | 409 A cover_images setting still references the image. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/images
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.
Parameters
| Input | Type | Description |
|---|---|---|
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| images | array | Images on this page: image_id, type (hosted or external), url, date_added. |
| pagination | array | current_page, last_page, per_page, shown, total. |
POST parking/images
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.
Parameters
| Input | Type | Description |
|---|---|---|
| file | file | The image file, multipart/form-data only. |
| url | string | An http or https link to an image file, instead of a file. |
Response
| Output | Type | Description |
|---|---|---|
| image | array | The image: image_id, type (hosted or external), url, date_added. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_too_many_images | 400 Your account already holds the maximum number of images. |
| np_parking_api_error_image_input | 400 Neither a file nor a url was sent, or both were. |
| np_parking_api_error_image_invalid | 400 The upload failed or the file is not an image we can host. |
| np_parking_api_error_image_url_invalid | 400 url is not an http or https link to an image file. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/import/{id}
One import with its entries, one line of the input each, paged. Needs the ability imports.view.
Parameters
| Input | Type | Description |
|---|---|---|
| page | integer | Entry page number, from 1. |
| per_page | integer | Entries per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| import | array | As in the list. |
| entries | array | entry_id, line, domain, was_added, was_updated, was_ignored, has_warning, has_error, approve_outcome, verify_outcome, notice. |
| pagination | array | Pagination of the entries. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_import_not_found | 404 No import by that id is in your account. |
GET parking/import/{id}/download
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| data | binary | The file is output directly, not JSON. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_import_not_found | 404 No import by that id is in your account. |
POST parking/import/{id}/rerun
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| import | array | The new import. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_import_not_found | 404 No import by that id is in your account. |
| np_parking_api_error_import_cannot_rerun | 409 The import is still running or cannot be re-run. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/imports
Your domain imports, newest first. Adding domains through the API creates an import too. Needs the ability imports.list.
Parameters
| Input | Type | Description |
|---|---|---|
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| imports | array | import_id, status (queued, running, finished, failed), data_type, dates, progress and the new, update, ignore, warning and error counts. |
| pagination | array | current_page, last_page, per_page, shown, total. |
POST parking/imports
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.
Parameters
| Input | Type | Description |
|---|---|---|
| file | file | The CSV, multipart/form-data only. |
| columns | string | Field name per column, comma-separated, when the header is not the export format. |
| skip_rows | integer | Rows to skip at the top (default 1 with a recognised header, else 0). |
| casing_mode | string | auto (default) or manual: how the domain's display casing is taken from the file. |
| update_casing_for_existing | bool | Also apply the casing to domains already in the account. |
Response
| Output | Type | Description |
|---|---|---|
| import | array | The import, as in GET parking/imports. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 CSV import is not on for your account. |
| np_parking_api_error_csv_missing | 400 No file was sent, or it is not a CSV. |
| np_parking_api_error_csv_columns | 400 The header is not the export format and columns was not sent, or names a field that does not exist, twice, or misses the domain. |
| import_refused | 400 The importer refused the file; message says why. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/inquiries
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.
Parameters
| Input | Type | Description |
|---|---|---|
| domain | string | Only inquiries about this domain (Unicode or punycode). |
| status | string | confirmed (default), unconfirmed or all: whether the buyer confirmed their email. |
| delivery | string | all (default), delivered or unsent: whether the inquiry was sent to you by email. |
| order | string | newest (default) or offer (highest offer first). |
| visibility | string | active (default) or removed: the inquiries you removed from your list. |
| spam_risk | string | all (default), not_high, low, medium or high. |
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 100 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| inquiries | array | inquiry_id, reference, inquire_date, domain, intent, origin, country, full_name, email, company, phone, message, offer, offer_text, offer_currency, email_confirmed, seller_notified, bant. |
| pagination | array | current_page, last_page, per_page, shown, total. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_invalid_inquiry_filter | 400 status, delivery, order, visibility or spam_risk is not an allowed value. |
| np_parking_api_error_domain_not_found | 404 No parked domain by that name is in your account. |
GET parking/inquiry/{id}
One inquiry. Needs the ability inquiries.view.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| inquiry | array | As in the list. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_inquiry_not_found | 404 No inquiry by that id is visible to you. |
POST parking/inquiry/{id}/hide
Hide an inquiry from your list, as "Remove" does on the site. Needs the ability inquiries.hide.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_inquiry_not_found | 404 No inquiry by that id is visible to you. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/inquiry/{id}/history
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.
Parameters
| Input | Type | Description |
|---|---|---|
| match | string | all (default), email or ip: which link to the buyer to follow. |
| days | integer | 7, 30, 90 or 0 for all time (default 0). |
| page | integer | Page number, from 1 (20 rows a page). |
Response
| Output | Type | Description |
|---|---|---|
| inquiries | array | Your inquiries from this buyer, newest first, as in the list, each with matched_by (email, ip or both). |
| stats | array | Counts across every seller: by email and by ip per window (count and distinct domains), first and last dates, own (yours) and total. |
| capped | bool | True when the buyer has more than 2,000 inquiries and the list stops there. |
| pagination | array | current_page, last_page, per_page, shown, total. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_inquiry_not_found | 404 No inquiry by that id is visible to you. |
POST parking/inquiry/{id}/request-email
Send the inquiry to your parking email, as "Send to email" does on the site. Needs the ability inquiries.email.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_inquiry_not_found | 404 No inquiry by that id is visible to you. |
| do_not_have_permission | 403 The inquiry cannot be sent to your email now (no confirmed parking email, or it was sent recently). |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
POST parking/inquiry/{id}/restore
Put a hidden inquiry back in your list. Needs the ability inquiries.restore.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_inquiry_not_found | 404 No inquiry by that id is visible to you. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
POST parking/inquiry/{id}/unreachable
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| success | true |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_inquiry_not_found | 404 No inquiry by that id is visible to you. |
| do_not_have_permission | 403 Not yet (unconfirmed, too soon, or already reported); message says which. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/insights-domain
One of your domains' Insights: its visitors in the window, the engagement counts, its inquiry funnel and its visitors per day. Needs the ability account.portfolio.activity, and Insights on your account.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The domain name (Unicode or punycode). |
| days | integer | 7, 30 (default), 90 or 0 for all time. |
| verified | bool | Only verified human visitors (default true). |
Response
| Output | Type | Description |
|---|---|---|
| domain | array | name and id. |
| days | integer | The window used. |
| only_verified | bool | Whether unverified visits were left out. |
| visitors | integer | Visitors to this domain in the window, each counted once per day. |
| engagement | array | continue, form_start, contact. |
| chart | array | Visitors per day: slots (ts, hits) and peak; null when the window holds nothing. |
| funnel | array | steps, side and since, as for insights-domains, for this domain alone. |
| average_active_seconds | integer | Active seconds per timed visit to this domain, null before any visit was timed. |
| visit_time | array | A typical page visit on this domain, as for insights-domains. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 Insights is not on for your account. |
| np_parking_api_error_domain_not_found | 404 No such domain on your account. |
GET parking/insights-domains
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.
Parameters
| Input | Type | Description |
|---|---|---|
| days | integer | 7, 30 (default), 90 or 0 for all time. |
| verified | bool | Only verified human visitors (default true); false includes visits that never passed the human check. |
Response
| Output | Type | Description |
|---|---|---|
| days | integer | The window used. |
| only_verified | bool | Whether unverified visits were left out. |
| visitors | integer | Visitors in the window, each counted once per day. |
| unverified | integer | Visits in the window that never passed the human check. |
| engagement | array | Visitor-days that clicked Continue, started the form, opened a contact link: continue, form_start, contact. |
| countries | integer | Distinct visitor countries. |
| chart | array | Visitors per day: slots (ts, hits) and peak; null when the window holds nothing. |
| funnel | array | steps and side rows of key, label, count, share (percent of visitors), conversion (percent of the step before, null on the first step); since is the day the inquiry steps count from when it is later than the window's start. |
| sections | array | Keyed by report name: rows of label, hits, share, unknown (contact_via is the kind of contact link used). |
| visit_time | array | A typical page visit: average (active seconds per timed visit, null before any), timed (visits timed), bands (from, visitors, share), still (at, share of visits still active), actions (continue, form_start, contact: count and the band their middle visitor acted in). Active time counts while the page is visible and was used in the last 30 seconds. |
| ever_used | bool | Whether the account has ever recorded a lander visit. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 Insights is not on for your account. |
GET parking/insights-portfolio
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.
Parameters
| Input | Type | Description |
|---|---|---|
| days | integer | 7, 30 (default), 90 or 0 for all time. |
Response
| Output | Type | Description |
|---|---|---|
| days | integer | The window used. |
| visits | integer | Portfolio visitors in the window, each counted once per day. |
| searched | integer | Visitor-days that searched. |
| filtered | integer | Filter facts used. |
| chart | array | Visitors per day: slots (ts, hits) and peak; null when the window holds nothing. |
| sections | array | Keyed by report name: rows of label, hits, share (percent of visitors), unknown. |
| ever_used | bool | Whether the portfolio has ever recorded a visit. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 Insights is not on for your account. |
GET parking/nameservers
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| ns | string[] | Nameserver hostnames, in order. |
| cname | string | Value for a verification CNAME record. |
| txt | string | Value for a verification TXT record. |
POST parking/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.
Parameters
| Input | Type | Description |
|---|---|---|
| name | string | The part after ns2., letters and digits only. |
Response
| Output | Type | Description |
|---|---|---|
| nameservers | array | As GET parking/nameservers, after the change. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 Your account cannot create nameservers. |
| np_parking_api_error_nameserver_refused | 400 The name is not allowed, is your current one, was yours before, or is taken; message says which. |
| np_parking_api_error_nameserver_limit | 429 You have created the yearly maximum; message says when the next is possible. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/portfolio
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| portfolio | array | enabled, url, slug_url, public_name, host_domain, and every field POST parking/portfolio takes. |
POST parking/portfolio
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.
Parameters
| Input | Type | Description |
|---|---|---|
| enabled | bool | Turn the portfolio on or off. |
| host_domain | string | A verified domain of yours to serve the portfolio from, or null. |
| portfolio | array | Field name to new value for the appearance and content fields. |
Response
| Output | Type | Description |
|---|---|---|
| portfolio | array | As GET parking/portfolio, after the save. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 The portfolio is not on for your account. |
| np_parking_api_error_unknown_settings | 400 A name in portfolio is not a portfolio field. |
| np_parking_api_error_invalid_settings | 400 Some fields were refused; errors names each one. |
| np_parking_api_error_domain_not_found | 404 host_domain is not a verified domain of yours. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/portfolio-activity
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.
Parameters
| Input | Type | Description |
|---|---|---|
| days | integer | 7, 30 (default), 90 or 0 for all time. |
Response
| Output | Type | Description |
|---|---|---|
| visits | integer | Portfolio visits in the window. |
| days | integer | The window used. |
| sections | array | Keyed by report name: rows of label, hits, share (percent), unknown, portfolios. |
| ever_used | bool | Whether the portfolio has ever recorded a visit. |
Errors
| Error key | Description |
|---|---|
| do_not_have_permission | 403 The activity report is not on for your account. |
GET parking/profile
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| profile | array | display_name, website, website_use_portfolio, atom_network_id, wise_business_id, user_card_html, social_email, social_phone_number, social_whatsapp, social_telegram, social_signal, social_sms, social_x, social_linkedin, contact_icons_position, avatar_visibility, default_currency. |
| parking_email | string | The confirmed address inquiries are sent to, or null. |
| payment_emails | array | Confirmed payment addresses keyed by account type. |
POST parking/profile
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.
Parameters
| Input | Type | Description |
|---|---|---|
| profile | array | Field name to new value. |
Response
| Output | Type | Description |
|---|---|---|
| profile | array | The profile after the save, as GET parking/profile. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_unknown_settings | 400 A name in profile is not a profile field. |
| np_parking_api_error_invalid_settings | 400 Some fields were refused; errors names each one. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/settings
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| settings | array | Keyed by setting name: value, source (account or default). |
POST parking/settings
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.
Parameters
| Input | Type | Description |
|---|---|---|
| settings | array | Setting name to new value, names as in GET parking/settings-schema. |
Response
| Output | Type | Description |
|---|---|---|
| settings | array | The account settings after the save, as GET parking/settings. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_unknown_settings | 400 A name in settings is not a setting. |
| np_parking_api_error_invalid_settings | 400 Some settings were refused; errors names each one. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
GET parking/settings-history
Every saved version of your account settings and seller profile, newest first. Needs the ability account.settings.history.
Parameters
| Input | Type | Description |
|---|---|---|
| page | integer | Page number, from 1. |
| per_page | integer | Rows per page, 1 to 200 (default 50). |
Response
| Output | Type | Description |
|---|---|---|
| versions | array | history_id, date, scope (account or profile), changed (setting names), changes (each changed setting with before and after), can_undo, source (ui, api, import, undo, admin, system), source_ref. |
| pagination | array | current_page, last_page, per_page, shown, total. |
GET parking/settings-schema
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.
Parameters
| Input | Type | Description |
|---|---|---|
| None. | ||
Response
| Output | Type | Description |
|---|---|---|
| schema | array | One entry per setting: name, type, label, explain, account_level, domain_level, permission_gated, available, allowed_values, default, category. |
POST parking/settings-undo
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.
Parameters
| Input | Type | Description |
|---|---|---|
| history_id | integer | A history_id from a history listing. |
Response
| Output | Type | Description |
|---|---|---|
| version | array | The version that was undone. |
Errors
| Error key | Description |
|---|---|
| np_parking_api_error_history_not_found | 404 No saved version by that id is in your account. |
| np_parking_api_error_history_cannot_undo | 409 The version has nothing before it to go back to. |
| np_parking_api_error_flood | 429 You are making changes too quickly; wait the number of seconds in Retry-After. |
New posts ➔
-
The USA Political Thread
- 448 posters
- jadie
-
ThemeDesigners.com - $100 BIN
- Post by marcusw
-
EVfunding.com - $999- Reply by vmgtch
Polls of interest ➔
-
What are your strengths as an investor?- 204 voters
- 31 replies
-
What's your domain portfolio size?
- 534 voters
- 169 replies
-
How do you think a potential buyer first checks if your domain is for sale?- 689 voters
- 56 replies
Hot this week ➔
-
Math teacher thinking about domaining as a side hustle - worth it in 2026?
- 52 replies
- 8 points
-
Could AI Make .CC Undervalued? The Case Nobody Is Talking About- 46 replies
- 9 points
-
Built a modern WHOIS that answers the "why" behind the search - feedback welcome- 38 replies
- 45 points
-
Trump just called AI “Super Intelligence (SI)” at the UN — anyone watching .SI?- 12 replies
- 2 points
Hot this month ➔
-
Ads for Escrowly - really?
- 222 replies
- 40 points
-
RIPONTHEWEBGUY refused to deliver domain I purchaed- 87 replies
- 17 posters
-
Looking to Buy Short & Brandable Domains- 53 replies
- 52 posters
-
Is Brandable Domaining Dead?- 46 comments
- 45 points
