Working with the CashParking API
The CashParking® API lets you download CashParking stats, add domain names to your CashParking account, and maintain keywords for your CashParking domain names — using your own software and server and our Web methods!
To Access the CashParking API
You can find WSDL (Web Service Description Language) for the CashParking API at https://mcc.godaddy.com/CashParkingAPI/cpapi.asmx?WSDL.
There are multiple Web methods available with the API interface. Each method requires specific parameters including:
- User Name — Your shopper (i.e., customer account) ID.
- Password — The password to your shopper account.
- CashParking API Key — The API Key is a unique identifier for each CashParking account. Use https://mcc.godaddy.com/CashParkingAPISettings.aspx, and log in to your account to view your API Key.
TIP: All parameter fields must be in string format.
Using the GetCashParkingAccountStats Method
This method lets you download reported stats for all domain names in your CashParking account.
- The report start date must be June 2, 2006 or later.
- Reports are limited to 90 days between the start date and the end date.
- Summary rows are returned, by domain name, for the requested date range.
| Parameter | Description |
| un | Shopper ID |
| pw | Password |
| key | The CashParking API key |
| startDate | Report begin date in MM/DD/YY format |
| endDate | Report end date in MM/DD/YY format |
| csvxml | Result format - xml for XML format, blank for CSV format |
Output Example in XML Return Format:
<Domain name="DOMAIN1.COM" rev="1.54" popunder_rev="0.00" clicks="28" imp="170" us_imp="95" cpc="0.0550" rpm="9.06" ctr="0.1647" />
<Domain name="DOMAIN2.COM" rev="0.53" popunder_rev="0.00" clicks="20" imp="20" us_imp="18" cpc="0.0265" rpm="26.50" ctr="1.0000" />
<Domain name="DOMAIN3.COM" rev="0.00" popunder_rev="0.00" clicks="0" imp="0" us_imp="0" cpc="0" rpm="0" ctr="0" />
<Domain name="DOMAIN4.COM" rev="1.13" popunder_rev="0.00" clicks="41" imp="185" us_imp="101" cpc="0.0276" rpm="6.11" ctr="0.2216" />
</DomainStats>
Output Example in CSV Return Format:
Using the AddDomainsToCashParking Method
Use this method to add domain names to a CashParking account.
When a domain name is registered with us, we automatically update its nameservers to the default CashParking nameservers.
When a domain name is not registered with us, we add it to the CashParking account but it remains in pending status until you update its nameservers (through your account at the domain name's registrar) to the following values:
ns01.cashparking.com
ns02.cashparking.com
NOTE: We add domain names as Auto-Optimized, and we automatically assign a template and keywords to them. See Working with Automated Keywords and Templates in CashParking for information on re-categorization of auto-optimized domain names.
This method returns an XML string of the method results. The result attribute of the Domain node indicates the success or failure of the addition. A "0" indicates that the operation succeeded and we added the domain name to the CashParking account.
| Parameter | Description |
| un | Shopper ID |
| pw | Password |
| key | CashParking API key |
| sDomains | Comma-delimited list of domain names to be added |
Output Example:
<Domain name="DOMAIN10.COM" result="0" errMessage=""/>
<Domain name="DOMAIN11.COM" result="-1" errMessage="Invalid domain name syntax."/>
<Domain name="DOMAIN12.COM" result="-2" errMessage="Domain is already monetized."/>
<Domain name="DOMAIN13.COM" result="-3" errMessage="Domain is suspended."/>
<Domain name="DOMAIN14.COM" result="-4" errMessage="Domain is or is about to be expired."/>
</AddDomainsResult>
Using the ChangeCashParkingKeywords Method
This method changes keywords for domain names in your CashParking account. These rules apply to keyword updates:
- Values are limited to characters A-Z, a-z, 0-9, apostrophe, and hyphen.
- Keyword parameter has a 100-character limit and might include up to four comma-separated keywords and phrases.
- All keyword submissions are subject to review and might be denied after review.
- Trademarked terms are not allowed.
NOTE: Calling this method deactivates auto-optimization for each domain name in the calling string.
Output for this method is an XML string of the Change Keyword result.
| Parameter | Description |
| un | Shopper ID |
| pw | Password |
| key | CashParking API key |
| sDomains | Comma-delimited list of domain names to be added |
| keywords | A list of up to four comma-separated words or phrases to be used as keywords for the included domain list |
Output Example:
<Domain name="DOMAIN4.COM" result="0" errMessage=""/>
<Domain name="DOMAIN10.COM" result="0" errMessage=""/>
<Domain name="DOMA,,,1@1.COM" result="-1" errMessage="Invalid domain name syntax."/>
</KeywordChangeResult>