Documentation

To make use of our APIs, you will need to authenticate yourself using an API key. An API key allows you to make calls to completeapi.com.

Your API key gives full access to your CompleteAPI.com account. It is important to be cautious when using the API key. Please consider the following tips:

• Always connect to CompleteAPI.com using HTTPS and not HTTP.
• DO NOT SHARE YOUR API KEY WITH ANYONE!
• If you suspect that your key has been compromised, please request a new one from the user dashboard

Your API key can be found on your dashboard.

The primary use of this call would be to get your credit balances or to see if our system is online. This API is free to use.

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/info

A typical JSON Response would look as follows:

{
  api: "CompleteAPI.com",
  api_version: "1.1",
  status: "success",
  errors: [ ],
  success: true,
  sms_credit_remaining: 458.6,
  geolocate_credits_remaining: 814,
  whois_credits_remaining: 4977,
  currency_credits_remaining: 98,
  server_timestamp: 1625157652,
  server_date_time: "2021-07-01T16:40:52+00:00",
  your_ip: "123.456.789.987",
  random_quote: "It is never too late to be what you might have been.",
  random_quote_author: "George Eliot"
}

To send SMS's to various cellphones networks across the globe.

Our API can be used to send to the following countries:

• Algeria
• Angola
• Austria
• Benin
• Botswana
• Brazil
• Burkina Faso
• Burundi
• Cameroon
• Canada
• Central African Republic
• Chad
• Comoros
• Democratic Republic of the Congo
• Denmark
• Djibouti
• Egypt
• Equatorial Guinea
• Eritrea
• Ethiopia
• France
• Gabon
• Gambia
• Germany
• Ghana
• Guinea
• Guinea-Bissau
• Ireland
• Italy
• Kenya
• Lesotho
• Liberia
• Libya
• Madagascar
• Malawi
• Mali
• Mauritania
• Mauritius
• Morocco
• Mozambique
• Namibia
• Netherlands
• Niger
• Nigeria
• Norway
• Republic of the Congo
• Russia
• Rwanda
• Sao Tome & Principe
• Senegal
• Seychelles
• Sierra Leone
• Somalia
• South Africa
• South Sudan
• Spain
• Sweden
• Switzerland
• Taiwan
• Tanzania
• Togo
• Tunisia
• Uganda
• United Kingdom
• United States
• Zambia
• Zimbabwe

Country not listed here? Contact us and we might be able to add the country.

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/sms/[cellphone_number]?message=[url_encoded_message]

A typical JSON Response would look as follows:

{
  api: "CompleteAPI.com",
  api_version: "1.1",
  status: "",
  errors: [ ],
  success: true,
  credit_used: 0.4,
  credit_remaining: 458.2,
  successCode: 900,
  successMessage: "Success. Message successfully queued for sending."
}

It is possible to schedule the SMS for a specific time by including a timestamp. For example, if you want the SMS to be sent on 3 May 2020, you could use the timestamp "1588464000" like this:

https://www.completeapi.com/v1/[api_key]/sms/[cellphone_number]?message=[url_encoded_message]&sendAt=[timestamp]

A contact list is a list of several cellphone numbers. These lists can be used to send one single message to multiple recipients.

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/sms/contactLists/create/[name]

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/sms/contactLists/get

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/sms/contactLists/[contact_list_id]/add/[number]

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/sms/contactLists/[contact_list_id]/remove/[number]

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/sms/contactLists/[contact_list_id]

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/sms/[list_id]?message=[url_encoded_message]

A typical JSON Response would look as follows:

{
  api: "CompleteAPI.com",
  api_version: "1.1",
  status: "",
  errors: [ ],
  success: true,
  credit_used: 0.4,
  credit_remaining: 458.2,
  successCode: 900,
  successMessage: "Success. Message successfully queued for sending."
}

To obtain whois data on domain names.

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/whois/[domain_name]

A typical JSON Response would look as follows:

{
  api: "CompleteAPI.com",
  api_version: "1.1",
  status: "clientTransferProhibited",
  errors: [ ],
  success: true,
  credit_used: 1,
  credit_remaining: 4976,
  available: 0,
  registered: 1,
  createdDate: "2018-07-31T08:56:00.00Z",
  updatedDate: "2020-10-20T10:43:23.00Z",
  expiresDate: "2023-07-31T08:56:00.00Z",
  registrant: {
    name: "REDACTED FOR PRIVACY",
    organization: "REDACTED FOR PRIVACY",
    street1: "REDACTED FOR PRIVACY",
    city: "REDACTED FOR PRIVACY",
    state: "Western Cape",
    postalCode: "REDACTED FOR PRIVACY",
    country: "SOUTH AFRICA",
    countryCode: "ZA",
    telephone: [ ],
    fax: [ ],
    rawText: "Registrant Name: REDACTED FOR PRIVACY Registrant Organization: REDACTED FOR PRIVACY Registrant Street: REDACTED FOR PRIVACY Registrant City: REDACTED FOR PRIVACY Registrant State/Province: Western Cape Registrant Postal Code: REDACTED FOR PRIVACY Registrant Country: ZA Registrant Phone: REDACTED FOR PRIVACY Registrant Fax: REDACTED FOR PRIVACY Registrant Email: https://tieredaccess.com/contact/a24f8cd6-57c2-459a-8878-5841de3bd43c"
  },
  administrativeContact: {
    name: "REDACTED FOR PRIVACY",
    organization: "REDACTED FOR PRIVACY",
    street1: "REDACTED FOR PRIVACY",
    city: "REDACTED FOR PRIVACY",
    state: "REDACTED FOR PRIVACY",
    postalCode: "REDACTED FOR PRIVACY",
    country: "REDACTED FOR PRIVACY",
    telephone: [ ],
    fax: [ ],
    rawText: "Admin Name: REDACTED FOR PRIVACY Admin Organization: REDACTED FOR PRIVACY Admin Street: REDACTED FOR PRIVACY Admin City: REDACTED FOR PRIVACY Admin State/Province: REDACTED FOR PRIVACY Admin Postal Code: REDACTED FOR PRIVACY Admin Country: REDACTED FOR PRIVACY Admin Phone: REDACTED FOR PRIVACY Admin Fax: REDACTED FOR PRIVACY Admin Email: REDACTED FOR PRIVACY"
  },
  technicalContact: {
    name: "REDACTED FOR PRIVACY",
    organization: "REDACTED FOR PRIVACY",
    street1: "REDACTED FOR PRIVACY",
    city: "REDACTED FOR PRIVACY",
    state: "REDACTED FOR PRIVACY",
    postalCode: "REDACTED FOR PRIVACY",
    country: "REDACTED FOR PRIVACY",
    telephone: [ ],
    fax: [ ],
    rawText: "Tech Name: REDACTED FOR PRIVACY Tech Organization: REDACTED FOR PRIVACY Tech Street: REDACTED FOR PRIVACY Tech City: REDACTED FOR PRIVACY Tech State/Province: REDACTED FOR PRIVACY Tech Postal Code: REDACTED FOR PRIVACY Tech Country: REDACTED FOR PRIVACY Tech Phone: REDACTED FOR PRIVACY Tech Fax: REDACTED FOR PRIVACY Tech Email: REDACTED FOR PRIVACY"
  },
  domainName: "completeapi.com",
  nameServers: {
    rawText: "NS1.GOLD.NAMHOST.COM NS2.GOLD.NAMHOST.COM ",
    hostNames: {
      Address: [
      "NS1.GOLD.NAMHOST.COM",
      "NS2.GOLD.NAMHOST.COM"
      ]
    },
    ips: [ ]
  },
  rawText: "Domain Name: completeapi.com Registry Domain ID: 2292156538_DOMAIN_COM-VRSN Registrar WHOIS Server: WHOIS.ENOM.COM Registrar URL: WWW.ENOM.COM Updated Date: 2020-10-20T10:43:23.00Z Creation Date: 2018-07-31T08:56:00.00Z Registrar Registration Expiration Date: 2023-07-31T08:56:00.00Z Registrar: ENOM, INC. Registrar IANA ID: 48 Domain Status: clientTransferProhibited https://www.icann.org/epp#clientTransferProhibited Registrant Name: REDACTED FOR PRIVACY Registrant Organization: REDACTED FOR PRIVACY Registrant Street: REDACTED FOR PRIVACY Registrant Street: Registrant City: REDACTED FOR PRIVACY Registrant State/Province: Western Cape Registrant Postal Code: REDACTED FOR PRIVACY Registrant Country: ZA Registrant Phone: REDACTED FOR PRIVACY Registrant Phone Ext: Registrant Fax: REDACTED FOR PRIVACY Registrant Email: https://tieredaccess.com/contact/a24f8cd6-57c2-459a-8878-5841de3bd43c Admin Name: REDACTED FOR PRIVACY Admin Organization: REDACTED FOR PRIVACY Admin Street: REDACTED FOR PRIVACY Admin Street: Admin City: REDACTED FOR PRIVACY Admin State/Province: REDACTED FOR PRIVACY Admin Postal Code: REDACTED FOR PRIVACY Admin Country: REDACTED FOR PRIVACY Admin Phone: REDACTED FOR PRIVACY Admin Phone Ext: Admin Fax: REDACTED FOR PRIVACY Admin Email: REDACTED FOR PRIVACY Tech Name: REDACTED FOR PRIVACY Tech Organization: REDACTED FOR PRIVACY Tech Street: REDACTED FOR PRIVACY Tech Street: Tech City: REDACTED FOR PRIVACY Tech State/Province: REDACTED FOR PRIVACY Tech Postal Code: REDACTED FOR PRIVACY Tech Country: REDACTED FOR PRIVACY Tech Phone: REDACTED FOR PRIVACY Tech Phone Ext: Tech Fax: REDACTED FOR PRIVACY Tech Email: REDACTED FOR PRIVACY Name Server: NS1.GOLD.NAMHOST.COM Name Server: NS2.GOLD.NAMHOST.COM DNSSEC: unsigned Registrar Abuse Contact Email: ABUSE@ENOM.COM Registrar Abuse Contact Phone: +1.4259744689 URL of the ICANN WHOIS Data Problem Reporting System: HTTP://WDPRS.INTERNIC.NET/ >>> Last update of WHOIS database: 2021-07-01T17:16:12.00Z <<< For more information on Whois status codes, please visit https://icann.org/epp The data in this whois database is provided to you for information purposes only, that is, to assist you in obtaining information about or related to a domain name registration record. We make this information available "as is," and do not guarantee its accuracy. By submitting a whois query, you agree that you will use this data only for lawful purposes and that, under no circumstances will you use this data to: (1) enable high volume, automated, electronic processes that stress or load this whois database system providing you this information; or (2) allow, enable, or otherwise support the transmission of mass unsolicited, commercial advertising or solicitations via direct mail, electronic mail, or by telephone. The compilation, repackaging, dissemination or other use of this data is expressly prohibited without prior written consent from us. We reserve the right to modify these terms at any time. By submitting this query, you agree to abide by these terms. Version 6.3 4/3/2002",
  parseCode: "3579",
  header: [ ],
  strippedText: "Domain Name: completeapi.com Registrar WHOIS Server: WHOIS.ENOM.COM Registrar URL: WWW.ENOM.COM Updated Date: 2020-10-20T10:43:23.00Z Creation Date: 2018-07-31T08:56:00.00Z Registrar Registration Expiration Date: 2023-07-31T08:56:00.00Z Registrar: ENOM, INC. Registrar IANA ID: 48 Domain Status: clientTransferProhibited https://www.icann.org/epp#clientTransferProhibited Registrant Name: REDACTED FOR PRIVACY Registrant Organization: REDACTED FOR PRIVACY Registrant Street: REDACTED FOR PRIVACY Registrant City: REDACTED FOR PRIVACY Registrant State/Province: Western Cape Registrant Postal Code: REDACTED FOR PRIVACY Registrant Country: ZA Registrant Phone: REDACTED FOR PRIVACY Registrant Fax: REDACTED FOR PRIVACY Registrant Email: https://tieredaccess.com/contact/a24f8cd6-57c2-459a-8878-5841de3bd43c Admin Name: REDACTED FOR PRIVACY Admin Organization: REDACTED FOR PRIVACY Admin Street: REDACTED FOR PRIVACY Admin City: REDACTED FOR PRIVACY Admin State/Province: REDACTED FOR PRIVACY Admin Postal Code: REDACTED FOR PRIVACY Admin Country: REDACTED FOR PRIVACY Admin Phone: REDACTED FOR PRIVACY Admin Fax: REDACTED FOR PRIVACY Admin Email: REDACTED FOR PRIVACY Tech Name: REDACTED FOR PRIVACY Tech Organization: REDACTED FOR PRIVACY Tech Street: REDACTED FOR PRIVACY Tech City: REDACTED FOR PRIVACY Tech State/Province: REDACTED FOR PRIVACY Tech Postal Code: REDACTED FOR PRIVACY Tech Country: REDACTED FOR PRIVACY Tech Phone: REDACTED FOR PRIVACY Tech Fax: REDACTED FOR PRIVACY Tech Email: REDACTED FOR PRIVACY Name Server: NS1.GOLD.NAMHOST.COM Name Server: NS2.GOLD.NAMHOST.COM Registrar Abuse Contact Email: ABUSE@ENOM.COM Registrar Abuse Contact Phone: +1.4259744689 ",
  footer: [ ],
  audit: {
    createdDate: "2021-07-01 17:16:12 UTC",
    updatedDate: "2021-07-01 17:16:12 UTC"
  },
  customField1Name: "RegistrarContactEmail",
  customField1Value: "ABUSE@ENOM.COM",
  registrarName: "ENOM, INC.",
  registrarIANAID: "48",
  whoisServer: "WHOIS.ENOM.COM",
  createdDateNormalized: "2018-07-31 08:56:00 UTC",
  updatedDateNormalized: "2020-10-20 10:43:23 UTC",
  expiresDateNormalized: "2023-07-31 08:56:00 UTC",
  customField2Name: "RegistrarContactPhone",
  customField3Name: "RegistrarURL",
  customField2Value: "+1.4259744689",
  customField3Value: "WWW.ENOM.COM",
  dataError: "MASKED_WHOIS_DATA",
  registryData: {
  createdDate: "2018-07-31T08:56:11Z",
  updatedDate: "2020-10-20T10:43:23Z",
  expiresDate: "2023-07-31T08:56:11Z",
  domainName: "completeapi.com",
  nameServers: {
  rawText: "NS1.GOLD.NAMHOST.COM NS2.GOLD.NAMHOST.COM ",
  hostNames: {
      Address: [
        "NS1.GOLD.NAMHOST.COM",
        "NS2.GOLD.NAMHOST.COM"
      ]
    },
    ips: [ ]
  },
  status: "clientTransferProhibited",
  rawText: "Domain Name: COMPLETEAPI.COM Registry Domain ID: 2292156538_DOMAIN_COM-VRSN Registrar WHOIS Server: whois.enom.com Registrar URL: http://www.enomdomains.com Updated Date: 2020-10-20T10:43:23Z Creation Date: 2018-07-31T08:56:11Z Registry Expiry Date: 2023-07-31T08:56:11Z Registrar: eNom, LLC Registrar IANA ID: 48 Registrar Abuse Contact Email: Registrar Abuse Contact Phone: Domain Status: clientTransferProhibited https://icann.org/epp#clientTransferProhibited Name Server: NS1.GOLD.NAMHOST.COM Name Server: NS2.GOLD.NAMHOST.COM DNSSEC: unsigned URL of the ICANN Whois Inaccuracy Complaint Form: https://www.icann.org/wicf/ >>> Last update of whois database: 2021-07-01T17:16:00Z <<< For more information on Whois status codes, please visit https://icann.org/epp NOTICE: The expiration date displayed in this record is the date the registrar's sponsorship of the domain name registration in the registry is currently set to expire. This date does not necessarily reflect the expiration date of the domain name registrant's agreement with the sponsoring registrar. Users may consult the sponsoring registrar's Whois database to view the registrar's reported date of expiration for this registration. TERMS OF USE: You are not authorized to access or query our Whois database through the use of electronic processes that are high-volume and automated except as reasonably necessary to register domain names or modify existing registrations; the Data in VeriSign Global Registry Services' ("VeriSign") Whois database is provided by VeriSign for information purposes only, and to assist persons in obtaining information about or related to a domain name registration record. VeriSign does not guarantee its accuracy. By submitting a Whois query, you agree to abide by the following terms of use: You agree that you may use this Data only for lawful purposes and that under no circumstances will you use this Data to: (1) allow, enable, or otherwise support the transmission of mass unsolicited, commercial advertising or solicitations via e-mail, telephone, or facsimile; or (2) enable high volume, automated, electronic processes that apply to VeriSign (or its computer systems). The compilation, repackaging, dissemination or other use of this Data is expressly prohibited without the prior written consent of VeriSign. You agree not to use electronic processes that are automated and high-volume to access or query the Whois database except as reasonably necessary to register domain names or modify existing registrations. VeriSign reserves the right to restrict your access to the Whois database in its sole discretion to ensure operational stability. VeriSign may restrict or terminate your access to the Whois database for failure to abide by these terms of use. VeriSign reserves the right to modify these terms at any time. The Registry database contains ONLY .COM, .NET, .EDU domains and Registrars.",
  parseCode: "251",
  header: [ ],
  strippedText: "Domain Name: COMPLETEAPI.COM Registry Domain ID: 2292156538_DOMAIN_COM-VRSN Registrar WHOIS Server: whois.enom.com Registrar URL: http://www.enomdomains.com Updated Date: 2020-10-20T10:43:23Z Creation Date: 2018-07-31T08:56:11Z Registry Expiry Date: 2023-07-31T08:56:11Z Registrar: eNom, LLC Registrar IANA ID: 48 Registrar Abuse Contact Email: Registrar Abuse Contact Phone: Domain Status: clientTransferProhibited https://icann.org/epp#clientTransferProhibited Name Server: NS1.GOLD.NAMHOST.COM Name Server: NS2.GOLD.NAMHOST.COM DNSSEC: unsigned URL of the ICANN Whois Inaccuracy Complaint Form: https://www.icann.org/wicf/ >>> Last update of whois database: 2021-07-01T17:16:00Z <<< For more information on Whois status codes, please visit https://icann.org/epp NOTICE: The expiration date displayed in this record is the date the registrar's sponsorship of the domain name registration in the registry is currently set to expire. This date does not necessarily reflect the expiration date of the domain name registrant's agreement with the sponsoring registrar. Users may consult the sponsoring registrar's Whois database to view the registrar's reported date of expiration for this registration. TERMS OF USE: You are not authorized to access or query our Whois database through the use of electronic processes that are high-volume and automated except as reasonably necessary to register domain names or modify existing registrations; the Data in VeriSign Global Registry Services' ("VeriSign") Whois database is provided by VeriSign for information purposes only, and to assist persons in obtaining information about or related to a domain name registration record. VeriSign does not guarantee its accuracy. By submitting a Whois query, you agree to abide by the following terms of use: You agree that you may use this Data only for lawful purposes and that under no circumstances will you use this Data to: (1) allow, enable, or otherwise support the transmission of mass unsolicited, commercial advertising or solicitations via e-mail, telephone, or facsimile; or (2) enable high volume, automated, electronic processes that apply to VeriSign (or its computer systems). The compilation, repackaging, dissemination or other use of this Data is expressly prohibited without the prior written consent of VeriSign. You agree not to use electronic processes that are automated and high-volume to access or query the Whois database except as reasonably necessary to register domain names or modify existing registrations. VeriSign reserves the right to restrict your access to the Whois database in its sole discretion to ensure operational stability. VeriSign may restrict or terminate your access to the Whois database for failure to abide by these terms of use. VeriSign reserves the right to modify these terms at any time. The Registry database contains ONLY .COM, .NET, .EDU domains and Registrars. ",
  footer: [ ],
  audit: {
    createdDate: "2021-07-01 17:16:10 UTC",
    updatedDate: "2021-07-01 17:16:10 UTC"
  },
  registrarName: "eNom, LLC",
  registrarIANAID: "48",
  createdDateNormalized: "2018-07-31 08:56:11 UTC",
  updatedDateNormalized: "2020-10-20 10:43:23 UTC",
  expiresDateNormalized: "2023-07-31 08:56:11 UTC",
  customField3Name: "RegistrarURL",
  customField3Value: "http://www.enomdomains.com",
  whoisServer: "whois.enom.com"
  },
  contactEmail: "ABUSE@ENOM.COM",
  domainNameExt: ".com",
  estimatedDomainAge: "1066"
}

WHMCS does not support lookups for all domain names. For example, there is no support for .NA domain names. However, WHMCS has a nifty feature where you can add a custom socket or URL as the target for the lookup. That basically means you can specify your CompleteAPI url as the target and it can be used to provide whois information for just about any domain name you can think of.

Click here to get the full details on how to add custom whois servers to WHMCS. Or alternatively, follow these simple steps:

• Open up the WHMCS file located at:

  /resources/domains/dist.whois.json

• Add the following entry at the top after the first "[":

  {
          "extensions": ".com.na,.na,.edu.na,.co.na,.alt.na,org.na",
          "uri": "https://www.completeapi.com/v1/[yourApiKey]/whois/",
          "available": "No Object Found"
  },

Please note:

• You can test this by logging in on the WHMCS Admin Area and clicking on Utilities and then WHOIS Lookup.
• The above example shows how to add support for .NA domain names, but you can follow this approach to add any other domain name. Just be sure to change the "available" value to whatever the result is when no object is found.

To get detailed information on an IP Address.

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/geolocate/[ip]

A typical JSON Response would look as follows:

{
  api: "CompleteAPI.com",
  api_version: "1.1",
  status: "",
  errors: [ ],
  success: false,
  credit_used: 1,
  credit_remaining: 813,
  ipAddress: "41.75.110.97",
  continentCode: "AF",
  continentName: "Africa",
  countryCode: "ZA",
  countryName: "South Africa",
  isEuMember: false,
  currencyCode: "ZAR",
  currencyName: "Rand",
  phonePrefix: "27",
  languages: [
    "zu",
    "xh",
    "af",
    "nso",
    "en-ZA",
    "tn",
    "st",
    "ts",
    "ss",
    "ve",
    "nr"
  ],
  stateProvCode: "GP",
  stateProv: "Gauteng",
  district: "City of Johannesburg Metropolitan Municipality",
  city: "Randburg (Fairland)",
  geonameId: 1004599,
  zipCode: "2032",
  latitude: -26.1366,
  longitude: 27.9395,
  gmtOffset: 2,
  timeZone: "Africa/Johannesburg",
  weatherCode: "SFXX5770",
  asNumber: 37276,
  asName: "VOFFICE",
  isp: "Sonic Wifi",
  linkType: "wireless",
  usageType: "consumer",
  isCrawler: false,
  isProxy: false,
  threatLevel: "low"
}

To get detailed currency information.

You can call the API as follows:

https://www.completeapi.com/v1/[api_key]/currency/[base_currency]

A typical JSON Response would look as follows:

{
api: "CompleteAPI.com",
api_version: "1.1",
status: "",
errors: [ ],
success: false,
credit_used: 1,
credit_remaining: 97,
forex: {
    ZAR_AED: "0.256932",
    ZAR_AFN: "5.560982",
    ZAR_ALL: "7.201106",
    ZAR_AMD: "34.684308",
    ZAR_ANG: "0.125607",
    ...
    ZWL_ZAR: "0.044405"
  },
  crypto: {
    luno: {
      LTC_BTC: {
        bid: "0.00408900",
        ask: "0.00409300"
      },
      ...
    }
  }
}

Not yet, but there will be one available before August 2021.

You do not have to! All the functionality in our APIs are available in the backend with an easy-to-use interface. Simply log in on completeapi.com and you will get access to all the tools.