README

A PHP wrapper for the Domainr API.

Installation

The package can be installed using Composer:

composer require theprivateer/domainr

Usage

For detailed documentation please visit the Domainr API on Mashape or Domainr API on Domainr.build. You will need to subscribe to the Domainr API to get a Mashape API key - there is currently a free plan that allows for 10,000 requests per month, however you will need to enter credit card details to cover any overage.

// autoload
include 'path/to/autoload.php'

$client = new \Privateer\Domainr\Domainr('YOUR_MASHAPE_API_KEY');

Search

$client->search($query, $location = null, $registrar = null, $defaults = null);

The search method allows you to search for domains by keyword, and receive multiple alternatives back from Domainr.

$client->search('acme.coffee');

JSON data will be returned:

[
   {
      "domain":"acme.coffee",
      "host":"",
      "subdomain":"acme.",
      "zone":"coffee",
      "path":"",
      "registerURL":"https:\/\/api.domainr.com\/v2\/register?client_id=mashape-salimgrsy&domain=acme.coffee&registrar=&source="
   },
   {
      "domain":"acme.cafe",
      "host":"",
      "subdomain":"acme.",
      "zone":"cafe",
      "path":"",
      "registerURL":"https:\/\/api.domainr.com\/v2\/register?client_id=mashape-salimgrsy&domain=acme.cafe&registrar=&source="
   },
   {
      "domain":"acme.com.tr",
      "host":"",
      "subdomain":"acme.",
      "zone":"com.tr",
      "path":"",
      "registerURL":"https:\/\/api.domainr.com\/v2\/register?client_id=mashape-salimgrsy&domain=acme.com.tr&registrar=&source="
   }
]

Register

$client->register($domain, $registrar = null);

This method returns a string, the value of which is the URL to the domain's registrar:

$client->register('acme.coffee');

// https://domains.google.com/registrar?s=acme.coffee&utm_campaign=domainr.com&utm_content=&af=domainr.com

Status

$client->status($domain);

The status method allows you to check domain availability:

$status = $client->status('acme.coffee');

This will return an instance of \Privateer\Domainr\Status. The values of the underlying JSON response will be accessible via the get() method on the Status object:

$status = $client->status('acme.coffee');

$status->get('domain');
// acme.coffee

$status->get('zone');
// coffee

$status->get('status');
// undelegated inactive

$status->get('summary');
// inactive

The Status object has a number of utility helpers to further explain the response.

$status->get('description');
// Available for new registration.

$status->get('available');
// true

These dynamic properties are derived from the status descriptions in the Domainr API documentation].

The Status object also static method to access these values:

Status::description($summary);

\Privateer\Domainr\Status::description('inactive'); 
// Available for new registration.

\Privateer\Domainr\Status::available('inactive'); 
// true

theprivateer / domainr

Maintainers

Details