Unlock GoDaddy Aftermarket: A Deep Dive into GdAuctionsBiddingWS_v2 API for Domain Name Search
In the world of domain investing, having the right tools at your disposal can make all the difference. This comprehensive tutorial explores how to leverage the GdAuctionsBiddingWS_v2 API to efficiently search and retrieve domain names listed on GoDaddy’s Aftermarket. While access to this API isn’t universally available, this guide provides invaluable insights for those who do possess it.
Understanding the GdAuctionsBiddingWS_v2 API
The GdAuctionsBiddingWS_v2 API is a powerful interface that allows programmatic interaction with the GoDaddy Aftermarket. It provides a suite of methods for searching, retrieving, and managing domain names listed for auction or sale. While it’s an older API, its functionality remains relevant for domain investors seeking automated solutions.
This tutorial caters to users who already have access to this API. If you don’t currently have access, this information may still be valuable for understanding the underlying mechanisms and potential benefits. Alternative solutions using GoDaddy’s more recent APIs are also available, and links to relevant tutorials are provided below.
Key Methods for Domain Name Search
The GdAuctionsBiddingWS_v2 API offers a range of methods for interacting with the GoDaddy Aftermarket. Here are some of the key functionalities:
- EstimateCloseoutDomainPrice: Estimates the price of a closeout domain.
- GetAuctionDetails: Retrieves detailed information about a specific auction.
- GetAuctionDetailsByDomainName: Retrieves auction details based on a domain name.
- GetAuctionList: Retrieves a list of auctions.
- GetAuctionList2: An enhanced version of GetAuctionList with pagination.
- GetAuctionListByAuctionType: Retrieves a list of auctions based on the auction type.
- GetAuctionListByAuctionType2: An enhanced version of GetAuctionListByAuctionType with pagination and search type options.
- GetAuctionListByAuctionTypeAdultBidsCloseDays: Retrieves a list of adult-related auctions.
- GetAuctionListByAuctionTypeAdultBidsCloseDays2: An enhanced version of GetAuctionListByAuctionTypeAdultBidsCloseDays.
- GetAuctionListByAuctionTypeAdultFilter: Retrieves a list of adult-related auctions with filtering options.
- GetAuctionListByAuctionTypeAdultFilter2: An enhanced version of GetAuctionListByAuctionTypeAdultFilter.
- GetAuctionListByAuctionTypeAndDates: Retrieves a list of auctions based on auction type and date range.
- GetServiceStatus: Checks the service status of the API.
- GetTermsOfServiceUrls: Retrieves the URLs for the terms of service.
- InstantPurchaseCloseoutDomain: Instantly purchases a closeout domain.
- PlaceBlackorder: Places a backorder for a domain name.
- PlaceBid: Places a bid on an auction.
- PlaceBidOrPurchase: Places a bid or purchases a domain outright.
- PlaceBidWithPurchaseProfile: Places a bid using a specific purchase profile.
Focusing on GetAuctionListByAuctionType and GetAuctionListByAuctionType2
This tutorial will primarily focus on two specific API methods: GetAuctionListByAuctionType and GetAuctionListByAuctionType2. These methods are particularly useful for searching the aftermarket based on keywords, auction types, and search criteria.
The key difference between the two methods lies in their parameters. GetAuctionListByAuctionType utilizes beginsWithKeyword and auctionType. In contrast, GetAuctionListByAuctionType2 offers more flexibility with keyWord, auctionType, and searchType, along with pagination parameters like pageNumber and rowsPerPage, which are available in both methods.
Example Script Overview
For the purpose of this tutorial, we will provide a high-level overview of an example script that implements the GetAuctionListByAuctionType2 method. This script serves as a starting point for understanding how to interact with the API and retrieve domain name data.
Important Note: Access to the GdAuctionsBiddingWS_v2 API is a prerequisite for using this script. Without access, the script will not function. Unfortunately, GoDaddy is no longer granting new access to this particular API.
Defining Key Variables
The example script requires defining several variables with their corresponding string values. These variables control the search parameters and pagination settings:
- pageNumber: This variable specifies the page number to retrieve. It’s typically set to 1 for the first page.
- rowPerPage: This variable determines the number of results to display per page. Valid values include 15, 25, 50, 100, 200, 300, and 500.
- keyword: This variable allows you to specify a keyword or phrase that should be contained within the domain names being searched. Avoid using spaces, special characters, and hyphens in the keyword.
- auctionType: This variable defines the type of auction to search for. Possible values are “auction” or “buy now”.
- searchType: This variable specifies the search criteria. Valid options include “most active”, “featured”, “expiring”, “ending soon”, “buy now”, “closeouts”, “bargainbin”, and “a-z listings”.
For example, setting the keyword variable to “domain” will return a list of domains in auction that contain the keyword “domain”.
SOAP Request and Response
Once the variables are defined, you can construct and send a SOAP request to the GetAuctionListByAuctionType2 method. While PHP provides a built-in SOAP class, the example script utilizes cURL to manually craft the SOAP header and body request for demonstration purposes.
SOAP 1.2 Request (Example)
The following is an example of a SOAP 1.2 request structure:
1
50
domain
auction
ending soon
Note: Replace “[API Namespace]” with the actual namespace of the GoDaddy API.
To authenticate the API request, you’ll need GoDaddy API credentials from the more recent API release. These credentials should be included in the SOAP header.
In the example code, replace the placeholder X’s in the line ‘Authorization: sso-key XXXXXXXXXXXXXXX:XXXXXXXXXXXXXXX’ with your actual API credentials.
SOAP Response
After successfully making the SOAP request, the API will return a SOAP response containing the auction data. The key element in the response is GetAuctionListByAuctionType2Result, which contains a string of auction data.
The following is an example of the XML structure within the GetAuctionListByAuctionType2Result element:
For each domain returned, an Auction element will be present, containing the following attributes:
- ID: The auction ID.
- Name: The domain name.
- Traffic: The estimated traffic to the domain.
- BidCount: The number of bids placed on the domain.
- Price: The current price of the domain in the auction.
- ValuationPrice: The GoDaddy GoValue or estimated value of the domain.
- TimeLeft: The time remaining in the auction.
- RowID: The record ID or occurrence ID of the domain.
Parsing the SOAP Response
To effectively utilize the data in the SOAP response, you’ll need to parse it using PHP’s built-in functions such as str_ireplace, htmlspecialchars, simplexml_load_string, json_encode, and json_decode.
These functions help to clean and transform the SOAP response into XML format and then into a workable PHP array, allowing you to easily access the attributes of the Auction element for each domain.
Closing Thoughts and Further Extensions
This tutorial provides a foundational understanding of how to use the GdAuctionsBiddingWS_v2 API to search for domain names on the GoDaddy Aftermarket. The example script serves as a starting point for building more complex applications and automating your domain investing activities.
Possible extensions to this tutorial include:
- Data Storage: Adding the ability to parse the retrieved data and store it in a database for analytics and tracking purposes.
- Automated Monitoring: Implementing a scheduled task to automatically run the script at regular intervals and notify you of new or expiring domains that match your criteria.
- Advanced Filtering: Adding more sophisticated filtering options to refine your search results based on factors such as price, traffic, and valuation.
While GoDaddy’s Saved Search functionality offers a convenient way to monitor the aftermarket, the API provides the flexibility to automate the process and gain real-time insights.
By leveraging the GdAuctionsBiddingWS_v2 API, domain investors can gain a competitive edge and make more informed decisions.