David Bartle > WWW-DomainTools-0.11 > WWW::DomainTools::SearchEngine

Download:
WWW-DomainTools-0.11.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.06   Source  

NAME ^

WWW::DomainTools::SearchEngine - Search domain names for availability

SYNOPSIS ^

  use WWW::DomainTools::SearchEngine;

  my $api = WWW::DomainTools::SearchEngine->new(
        key => '12345',
        partner => 'yourname',
        customer_ip => '1.2.3.4'
  );

  my $res = $api->request(
        ext => "COM|NET|ORG|INFO",
        q => 'example.com',
  );

DESCRIPTION ^

This module allows you to use the Domain Tools domain search XML API. You will need to get a license key.

http://xml-api.domaintools.com

METHODS ^

request( url parameters hash )

The keys and values expected are documented on the Domain Tools website.

If the request is successful, the return value is either a hash reference or a string depending on the value of the 'format' parameter to the constructor.

See the documentation for the new() method for more detailed information about 'format' and other standard parameters.

If the HTTP request fails, this method will die.

domain_is_available( domain_name )

Pass in a domain name. It will return either a 1 or a 0 indicating that the domain name is available for registration (or not).

TLS's that are currently checked for availability are .com .net .org .info .biz .us

If you attempt to check availability of a domain name with an unsupported TLD, this method will die().

If the HTTP request fails, this method will die.

new( options hash )

Valid keys are:

  • url

    Your XML api full url. Eg. http://partnername.whoisapi.com/api.xml

    The default is http://engine.whoisapi.com/api.xml

  • key

    Your license key

  • partner

    Your partner ID

  • customer_ip

    The (optional) IP of the customer that you are making the request for

  • format

    How you want the response returned when you call the request method.

    'hash' is the default and means that you want a hash reference returned which is built by using XML::Simple.

    'xml' means that you want a string returned containing the raw XML response.

  • timeout

    The number of seconds that you want to wait before cancelling the HTTP request.

    default: 10

  • lwp_ua

    An instance of LWP::UserAgent to use for the requests. This will allow you to set up an LWP::UserAgent with all of the settings that you would like to use such as proxy settings etc.

    default: LWP::UserAgent->new

SEE ALSO ^

WWW::DomainTools http://xml-api.domaintools.com http://xml-api.domaintools.com/api23.html

BUGS ^

Please report bugs using the CPAN Request Tracker at http://rt.cpan.org/

AUTHOR ^

David Bartle <captindave@gmail.com>

COPYRIGHT ^

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

I am not affiliated with Domain Tools or Name Intelligence. The use of their API's are governed by their own terms of service:

http://www.domaintools.com/members/tos.html

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: