Technical details...

The Sphere 360° API-Interface

Our goal is to create an API interface for easy and secure data retrieval and verification:
We therefore rely exclusively on encrypted (SSL) POST queries when transmitting data.

The API package contains a php module with an example of the application.

API download


The query:
$obj = DataCheck($request_data, $myapikey, false);
$request_data = e-mail address, domain name, phone number
$myapikey = Your personal access key (API key)
false|true = Enable (true) or disable (false) error reporting


The evaluation / feedback in a JSON format:
$YourVariable = $obj['DataField'];


Available data fields:

Note: These data fields are unfortunately not available in our free package. A 'null' response will be given.


Basic features

data field description response
$obj['request_provided']
Return of the originally sent request. [string]
info-Entfernen Sie diesen Text-
												@example.com
example.com
+491234567890
$obj['request_type']
The type of request sent. [string]
domain
e-mail
phone
unknown
$obj['spam_result']
Whether the request has been recognized as SPAM or whether there is a suspicion of SPAM. A 'false'-message will be displayed if the contingent is used up or an error occurs. [boolean]
true
false
$obj['spam_result_str']
Return of the SPAM result. [string]
ok
listed
error
$obj['spam_result_type']
Listed SPAM category (if available). [string]
email
temporary email
spam
call
sms
none
$obj['error']
Error in API usage. [boolean]
false
true
$obj['error_details']
Detailed information about the errors that occurred. [string]
see error codes
null
$obj['api_version']
Version info of the Online API [string]
"Version"
"Buildnummer"
Account Features

data field description response
$obj['account_package']
Specifies the current package in the current billing period. [string]
FREE 100
BASIC
PROFESSIONAL
INDIVIDUAL
$obj['account_query_status']
Percentage of the already used query capacity. [double]
0.0 ... 100.0
E-Mail & Domain Features

data field description response
$obj['domain_name']
Domain name [string]
example.com
...
$obj['domain_tld_name']
Name of the domain extension (TLD - Top Level Domain) [string]
.com
...
$obj['domain_sub']
Feedback if it is a sub-domain [boolean]
true
false
$obj['domain_sub_name']
Subdomain name: subdomain.maindomain.tld [string]
subdomain
$obj['domain_main_name']
Name of the main domain including tld: subdomain.maindomain.tld [string]
maindomain.tld
Telephone Features

A complete evaluation can only be done by entering a phone number including country code (prefix)


data field description response
$obj['phone_number']
Return of the queried phone number according to the international guideline E.164 (successor to guideline E.163) [string]
+1234567890
$obj['phone_prefix']
Recognized country prefix (country code) [string]
+1
$obj['phone_city']
Geolocation or location of the phone number if available. [string]
city
$obj['phone_country_en']
Country name (English) of the recognized prefix [string]
country
$obj['phone_country_de']
Country name (German) of the recognized prefix [string]
Land
$obj['phone_country_iso2']
Country code according to ISO 3166 ALPHA-2 [string]
DE
US
...
$obj['phone_country_iso3']
Country code according to ISO 3166 ALPHA-3 [string]
DEU
USA
...
$obj['phone_continent']
Continental assignment of the phone number [string]
AFRICA
AMERICA
ASIA
EUROPE
AUSTRALIA & OCEANIA
$obj['phone_zone']
Specifying the telephone zone [string]
1 ... 9
$obj['phone_number_format_international']
Formatting of the phone number in international format [string]
+1 234 567890
$obj['phone_number_format_national']
Formatting of the phone number in national/local format [string]
0234 567890
$obj['phone_number_format_RFC3966']
Formatting of the telephone number in URI-Link (RFC3966) format [string]
tel:+1-234-567890
$obj['phone_number_initial_provider']
(Mobile) phone provider to which the prefix number range was originally assigned.Due to the possibility to take the phone number to another provider ( called phone number porting) no current assignment can be made! [string]
Provider-Name
$obj['phone_number_timezone']
Time zone of the phone number [string]
Time zone designation
$obj['phone_number_type']
Type of phone number (fixed network, mobile, toll-free service number) [string]
landline
mobile
landline / mobile
toll-free
unknown
Error Codes

code description
E000
Connection problem to the online API (see error description output) (offline error)
E01
Account error
E01.1
Invalid API key
E01.2
Account invalid / not available
E01.3
Payment period has expired
E01.4
Max. query limit reached
E01.5
The request has been blocked due to an account related issue
E02
The query type could not be determined (unknown or invalid query type)
E03
The request could not be processed internally.

All information without any guarantee, subject to change.