Parking API

Overview

The Parking API lets your own programs and scripts do most of what you can do on your parking dashboard: add and verify domains, change their settings, manage your inquiries, read your Insights, and more.

It can do what your account can do on the site, and nothing more: every request runs as you, with the permissions you gave the token.

What it covers

• Domains: list your domains, view one, read and change its settings, add, verify, ignore, and remove domains, and read the nameservers to set at your registrar.
• Account settings: read and change the settings that apply to all of your domains, your profile, your portfolio, and the senders you ignore, and read the settings reference.
• Insights: the traffic and inquiry figures for your portfolio and for each domain.
• Inquiries: the inquiries buyers send, with the actions you have on the site (star, mark as read, archive, hide, restore, and send to your email).
• Catchall emails: list, search, read, and download the emails sent to your parked domains.
• Imports and exports: start an import and read its entries, and create and download exports.
• Images: list, add, and remove the images your landers use.

Base URL

https://www.namepros.com/api/v1/parking/

Requests and responses are JSON. Lists are paged with page and per_page, and every list answers with a pagination block (current_page, last_page, per_page, shown, total).

Domains are addressed by name (e.g., ?name=example.com), in Unicode or punycode.

Authentication

Every request needs a token that belongs to you. You do not need to be a programmer to create one: it takes a minute, one step at a time.

Step 1: Open "API access"

Go to API access in your account. This page lists your tokens and any apps you have connected.

Step 2: Create a token

A token is the key your program uses. Each program should have its own.

1. Select "Create token". If we ask for your password, enter it: we check it is you before every new token, at most once an hour.
2. Give it a "Name", so you recognize it later (e.g., "Portfolio spreadsheet").
3. Under "Permissions", tick only what your program needs. You can create another token with more later.
4. Choose when it "Expires". "Never" suits a program you keep running, but a date is safer.
5. Select "Create token" at the bottom of the form.

Step 3: Copy your token

Your new token appears once. Copy it now and keep it somewhere safe.

Step 4: Send it with every request

Your program sends the token in the Authorization header:

Authorization: Bearer npp_your_token

The quick start has requests to try.

Step 5: Keep an eye on your tokens

Back on "API access", each token shows when it was last used. Select "view the log" to see every request it made.

If you no longer use a token, or you think someone else has it, select "Revoke". It stops working right away.

When you change or reset your password, all your tokens stop working, so create new ones for your programs afterwards.

Connected apps

An app that supports "Connect to NamePros" gets its own access without you copying a token. You sign in, see what the app asks for, and allow or deny it. The app can only do what you allowed.

Connected apps are listed on the same "API access" page, where you can disconnect any of them at any time.

Quick start

Replace npp_your_token with a personal token that has the permission each call needs.

List your domains

curl -H "Authorization: Bearer npp_your_token" \
  "https://www.namepros.com/api/v1/parking/domains?page=1&per_page=50"

View one domain

curl -H "Authorization: Bearer npp_your_token" \
  "https://www.namepros.com/api/v1/parking/domain?name=example.com"

Read a domain's settings

curl -H "Authorization: Bearer npp_your_token" \
  "https://www.namepros.com/api/v1/parking/domain-settings?name=example.com"

Change a domain's settings

Send only the settings you want to change. A value of null makes the domain inherit your account setting again.

curl -X POST \
  -H "Authorization: Bearer npp_your_token" \
  -H "Content-Type: application/json" \
  -d '{"settings": {"for_sale": "for_sale", "bin_price": 1500}}' \
  "https://www.namepros.com/api/v1/parking/domain-settings?name=example.com"

Nameservers for your registrar

curl -H "Authorization: Bearer npp_your_token" \
  "https://www.namepros.com/api/v1/parking/nameservers"

The API reference lists every endpoint with its parameters and response.

For a complete program that uses these calls, see the example app.

Permissions

Each endpoint needs one permission, named in the reference as its ability (e.g., domains.list). A token only has the abilities you gave it.

When you create a token you pick abilities in groups, so the common cases are one click:

• View domains: list and view domains, their nameservers, their status, their settings, and settings history.
• Add and remove domains: add, verify, ignore, and remove domains, and create nameservers.
• Change domain settings: change a domain's settings and undo a change.
• View account settings: your account settings, the settings reference, your settings history, your profile, your portfolio, your Insights, and the senders you ignore.
• Change account settings: change your account settings, profile, portfolio, and ignored senders, and undo a change.
• View imports: your imports, their entries, and their files.
• Manage imports: start an import and run one again.
• View inquiries: the inquiries buyers sent, including their names, email addresses, and messages.
• Manage inquiries: star, mark as read, archive, hide, and restore inquiries, have one sent to your email, and ask a buyer for a reply.
• Exports: create exports and download them.
• Images: list, add, and remove your images.
• Catchall emails: list, search, read, and download your Catchall emails.

"Full parking access" ticks all of them. A connected app asks for the groups it needs, and you see them before you allow it.

Changes and history

Every settings change made through the API is saved as a version, exactly like a change made on the site. The version records which token made it.

• GET parking/settings-history lists the versions of your account settings.
• GET parking/domain-settings-history?name=example.com lists the versions of one domain's settings.
• POST parking/settings-undo with a history_id undoes that change: the settings it changed go back to what they were before it. A change with nothing before it cannot be undone (409).

An undo is saved as a new version, so it can itself be undone. You can see the same history on "Settings history" in the parking menu.

Errors and limits

Errors use the standard NamePros API shape: an errors list where each entry has a code and a message.

• 401: the token is missing, revoked, or expired.
• 403: the token cannot do this. The message says why (e.g., it names the ability the endpoint needs).
• 404: no domain, import, or inquiry by that name or id is in your account.
• 400: a parameter or setting value was refused. For settings, the error's params.errors names each setting that failed and why.
• 429: too many requests, or changes made too quickly. If the response has a Retry-After header, wait that many seconds; otherwise wait a minute. Then try again.

Each account can make 60 requests a minute. Upgraded accounts, VIP Members and Large Portfolio Holders can make 120. Changes (requests that add, remove, or save something) are also limited to one a second. Every response carries your limit in the X-RateLimit-Limit header and what is left of it this minute in X-RateLimit-Remaining. Space out large jobs, use the bulk endpoints where you can (e.g., parking/domains-settings reads or changes the settings of many domains in one request), and stop and wait when you receive a 429.

Support

Questions about the API, or something that does not work as described here? Post in the parking help thread and we will take a look.

When you report a problem, include the endpoint, the time, and the error code and message. Never include your token.