Get Started

Introduction

Overview

The GoDaddy API allows developers to interact with the GoDaddy system to manage domains and accounts in the same way we do. The API can be used by anyone who wants to create their own experience for registering, purchasing, and managing a domain.

To use the API, you need two things:

  1. Account (aka Shopper), and its corresponding "Customer #" (aka ShopperId)
  2. API Key and Secret
These pieces are used to authenticate your identity with each request. Follow Getting Access below to get your account, key, and secret.

This page outlines the order you would call APIs for a high level process, like purchasing a domain. For details on calling APIs, navigate to our Documentation Page.

Getting Access

Get access by setting up an account and generating a key and secret via the Keys Page.

Get Access

Set up Payment Method

To complete any financial transactions, such as purchasing a domain, you will need to set up a Good as Gold account.

Set up Good as Gold

Scenarios

Here are a few of the access scenarios that are possible when using our APIs:

  • Self-Serve

    You're authenticated as and operating on your own account, so there's nothing special to consider. You can ignore references to Subaccounts and the X-Shopper-Id header.

  • Delegation

    You are authenticated as one Shopper, but performing actions on behalf of another. You will need to use the X-Shopper-Id header to specify who you're targeting, but must ignore references to Subaccounts.

  • Reseller

    You are a registered API Reseller, performing actions on behalf of your customers. You'll need to create a Subaccount to represent your end-user, and then specify you're operating on behalf of that Subaccount via the X-Shopper-Id header.

    Documentation for Subaccount Create

Making Calls

Now that you have your Account and API Key+Secret, you can make calls. Here's a sample curl HTTP Request that checks whether or not a specific Domain is available. To authenticate, you'll need to replace {API_KEY} and {API_SECRET} with your own.

curl -X GET -H "Authorization: sso-key {API_KEY}:{API_SECRET}" "https://api.godaddy.com/v1/domains/available?domain=example.guru"

Domain Purchase

Step 1. List of Top Level Domains (TLDs)

You can get a full list of TLDs that are available for sale to your customers.

Documentation Response Schema

Step 2. Check Domain Availability

You can check if a specific domain is available.

Documentation Response Schema

Step 3. [Optional] Domain Suggestions

Get a list of alternative domain names based on a domain name or keywords.

When a requested domain is not available, this request url will provide options for your customers.

Documentation Response Schema

Step 4. [Optional] Schema for TLDs

Get metadata for a specific TLD.

In order to purchase a domain name, you need to know what information the registrar requires, which varies per TLD. This call gives you the metadata schema so you can send appropriate data to the registrar.

Documentation Response Schema

Step 5. [Optional] Validate Metadata for a TLD

Ensure entered data is valid.

When you are ready to purchase a domain, you can validate that the information entered matches the TLD metadata schema. This call is optional since the Purchase call will automatically validate for you.

Documentation Request Schema

Step 6. Purchase and Register a Domain

Buy an available domain.

With this call, you purchase a domain for yourself, or on behalf of another Shopper by specifying the X-Shopper-Id header.

Documentation Request Schema Response Schema

Step 7. Check Status of Domain Purchase

Get the fulfillment status of an available domain purchase request.

Documentation Response Schema

Tools

Documentation

Full reference documentation and ways to try out the API one call at a time.

Browse API Documentation