IP2Location.io PHP API#
Configuration Class#
- class Configuration($api_key)#
Configuration registry. Set the IP2Location.io API key.
- Parameters:
$api_key (string) – (Required) The IP2Location.io API key.
- Returns:
Returns the configuration in object.
- Return type:
object
IPGeolocation Class#
- class IPGeolocation($config)#
Initialize the IPGeolocation class.
- Parameters:
$config (object) – (Required) The IP2Location.io Configuration object returned by Configuration class.
- lookup($ip_address, $language)#
Retrieve geolocation information for an IP address.
- Parameters:
$ip_address (string) – (Required) The IP address (IPv4 or IPv6).
$language (string) – (Optional) Translation information(ISO639-1). The translation is only applicable for continent, country, region and city name.
Note
Note: This parameter is only available for Plus and Security plan only.
- Returns:
Returns the geolocation information in JSON. Refer below table for the fields avaliable in the JSON
- Return type:
json
RETURN FIELDS
Parameter
Type
Description
ip
string
IP address.
country_code
string
Two-character country code based on ISO 3166.
country_name
string
Country name based on ISO 3166.
region_name
string
Region or state name.
city_name
string
City name.
latitude
double
City latitude. Defaults to capital city latitude if city is unknown.
longitude
double
City longitude. Defaults to capital city longitude if city is unknown.
zip_code
string
ZIP/Postal code.
time_zone
string
UTC time zone (with DST supported).
asn
string
Autonomous system number (ASN).
as
string
Autonomous system (AS) name.
isp
string
Internet Service Provider or company’s name.
domain
string
Internet domain name associated with IP address range.
net_speed
string
Internet connection type. DIAL = dial-up, DSL = broadband/cable/fiber/mobile, COMP = company/T1
idd_code
string
The IDD prefix to call the city from another country.
area_code
string
A varying length number assigned to geographic areas for calls between cities.
weather_station_code
string
The special code to identify the nearest weather observation station.
weather_station_name
string
The name of the nearest weather observation station.
mcc
string
Mobile Country Codes (MCC) as defined in ITU E.212 for use in identifying mobile stations in wireless telephone networks, particularly GSM and UMTS networks.
mnc
string
Mobile Network Code (MNC) is used in combination with a Mobile Country Code (MCC) to uniquely identify a mobile phone operator or carrier.
mobile_brand
string
Commercial brand associated with the mobile carrier.
elevation
integer
Average height of city above sea level in meters (m).
usage_type
string
Usage type classification of ISP or company.
address_type
string
IP address types as defined in Internet Protocol version 4 (IPv4) and Internet Protocol version 6 (IPv6).
continent.name
string
Continent name.
continent.code
string
Two-character continent code.
continent.hemisphere
array
The hemisphere of where the country located. The data in array format with first item indicates (north/south) hemisphere and second item indicates (east/west) hemisphere information.
continent.translation
object
Translation data based on the given lang code.
country.name
string
Country name based on ISO 3166.
country.alpha3_code
string
Three-character country code based on ISO 3166.
country.numeric_code
string
Three-character country numeric code based on ISO 3166.
country.demonym
string
Native of the country.
country.flag
string
URL of the country flag image.
country.capital
string
Capital of the country.
country.total_area
integer
Total area in km2.
country.population
integer
Population of the country.
country.currency
object
Currency of the country.
country.language
object
Language of the country.
country.tld
string
Country-Code Top-Level Domain.
country.translation
object
Translation data based on the given lang code.
region.name
string
Region or state name.
region.code
string
ISO3166-2 code.
region.translation
object
Translation data based on the given lang code.
city.name
string
City name.
city.translation
object
Translation data based on the given lang code.
time_zone_info.olson
string
Time zone in Olson format.
time_zone_info.current_time
string
Current time in ISO 8601 format.
time_zone_info.gmt_offset
integer
GMT offset value in seconds.
time_zone_info.is_dst
boolean
Indicate if the time zone value is in DST.
time_zone_info.sunrise
string
Time of sunrise. (hh:mm format in local time, i.e, 07:47)
time_zone_info.sunset
string
Time of sunset. (hh:mm format in local time, i.e 19:50)
geotargeting.metro
string
Metro code based on zip/postal code.
ads_category
string
The domain category code based on IAB Tech Lab Content Taxonomy.
ads_category_name
string
The domain category based on IAB Tech Lab Content Taxonomy. These categories are comprised of Tier-1 and Tier-2 (if available) level categories widely used in services like advertising, Internet security and filtering appliances.
district
string
District or county name.
is_proxy
boolean
Whether is a proxy or not.
proxy.last_seen
integer
Proxy last seen in days.
proxy.proxy_type
string
Type of proxy.
proxy.threat
string
Security threat reported.
proxy.provider
string
Name of VPN provider if available.
proxy.is_vpn
boolean
Anonymizing VPN services.
proxy.is_tor
boolean
Tor Exit Nodes.
proxy.is_data_center
boolean
Hosting Provider, Data Center or Content Delivery Network.
proxy.is_public_proxy
boolean
Public Proxies.
proxy.is_web_proxy
boolean
Web Proxies.
proxy.is_web_crawler
boolean
Search Engine Robots.
proxy.is_residential_proxy
boolean
Residential proxies.
proxy.is_spammer
boolean
Email and forum spammers.
proxy.is_scanner
boolean
Network security scanners.
proxy.is_botnet
boolean
Malware infected devices.
proxy.is_consumer_privacy_network
boolean
Consumer Privacy Networks.
proxy.is_enterprise_private_network
boolean
Enterprise Private Networks.
DomainWhois Class#
- class DomainWhois($config)#
Initialize the DomainWhois class.
- Parameters:
$config (object) – (Required) The IP2Location.io Configuration object returned by Configuration class.
- lookup($domain)#
Lookup domain WHOIS information.
- Parameters:
$domain (string) – (Required) The domain name.
- Returns:
IP2WHOIS Domain WHOIS result in JSON. Refer below table for the fields avaliable in the JSON.
- Return type:
json
RETURN FIELDS
Parameter
Type
Description
domain
string
Domain name.
domain_id
string
Domain name ID.
status
string
Domain name status.
create_date
string
Domain name creation date.
update_date
string
Domain name updated date.
expire_date
string
Domain name expiration date.
domain_age
integer
Domain name age in day(s).
whois_server
string
WHOIS server name.
registrar.iana_id
string
Registrar IANA ID.
registrar.name
string
Registrar name.
registrar.url
string
Registrar URL.
registrant.name
string
Registrant name.
registrant.organization
string
Registrant organization.
registrant.street_address
string
Registrant street address.
registrant.city
string
Registrant city.
registrant.region
string
Registrant region.
registrant.zip_code
string
Registrant ZIP Code.
registrant.country
string
Registrant country.
registrant.phone
string
Registrant phone number.
registrant.fax
string
Registrant fax number.
registrant.email
string
Registrant email address.
admin.name
string
Admin name.
admin.organization
string
Admin organization.
admin.street_address
string
Admin street address.
admin.city
string
Admin city.
admin.region
string
Admin region.
admin.zip_code
string
Admin ZIP Code.
admin.country
string
Admin country.
admin.phone
string
Admin phone number.
admin.fax
string
Admin fax number.
admin.email
string
Admin email address.
tech.name
string
Tech name.
tech.organization
string
Tech organization.
tech.street_address
string
Tech street address.
tech.city
string
Tech city.
tech.region
string
Tech region.
tech.zip_code
string
Tech ZIP Code.
tech.country
string
Tech country.
tech.phone
string
Tech phone number.
tech.fax
string
Tech fax number.
tech.email
string
Tech email address.
billing.name
string
Billing name.
billing.organization
string
Billing organization.
billing.street_address
string
Billing street address.
billing.city
string
Billing city.
billing.region
string
Billing region.
billing.zip_code
string
Billing ZIP Code.
billing.country
string
Billing country.
billing.phone
string
Billing phone number.
billing.fax
string
Billing fax number.
billing.email
string
Billing email address.
nameservers
array
Name servers
- getPunycode($domain)#
Get Punycode for domain name.
- Parameters:
$domain (string) – (Required) Domain name.
- Returns:
Returns punycode in text.
- Return type:
string
- getNormalText($domain)#
Get Normal Text.
- Parameters:
$domain (string) – (Required) The punycode domain name.
- Returns:
Returns normal domain name in text.
- Return type:
string
- getDomainName($url)#
Get domain name from a URL.
- Parameters:
$url (string) – (Required) The URL that you want to extract domain name from.
- Returns:
Returns the extracted domain name in text.
- Return type:
string
- getDomainExtension($str)#
Get domain extension from a URL or domain.
- Parameters:
$str (string) – (Required) The URL or domain.
- Returns:
Returns the domain extension in text.
- Return type:
string