GeoIP2 PHP API v3.1.0

Traits
in package
implements JsonSerializable

Contains data for the traits record associated with an IP address.

This record is returned by all location services and databases.

Table of Contents

Interfaces

JsonSerializable

Properties

$autonomousSystemNumber  : int|null
$autonomousSystemOrganization  : string|null
$connectionType  : string|null
$domain  : string|null
$ipAddress  : string|null
$isAnonymous  : bool
$isAnonymousVpn  : bool
$isAnycast  : bool
$isHostingProvider  : bool
$isLegitimateProxy  : bool
$isp  : string|null
$isPublicProxy  : bool
$isResidentialProxy  : bool
$isTorExitNode  : bool
$mobileCountryCode  : string|null
$mobileNetworkCode  : string|null
$network  : string|null
$organization  : string|null
$staticIpScore  : float|null
$userCount  : int|null
$userType  : string|null

Methods

jsonSerialize()  : array<string, mixed>

Properties

$autonomousSystemNumber read-only

public int|null $autonomousSystemNumber

The autonomous system number associated with the IP address. See https://en.wikipedia.org/wiki/Autonomous_system_(Internet%29. This attribute is only available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$autonomousSystemOrganization read-only

public string|null $autonomousSystemOrganization

The organization associated with the registered autonomous system number for the IP address. See https://en.wikipedia.org/wiki/Autonomous_system_(Internet%29. This attribute is only available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$connectionType read-only

public string|null $connectionType

The connection type may take the following values: "Dialup", "Cable/DSL", "Corporate", "Cellular", and "Satellite". Additional values may be added in the future. This attribute is only available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$domain read-only

public string|null $domain

The second level domain associated with the IP address. This will be something like "example.com" or "example.co.uk", not "foo.example.com". This attribute is only available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$ipAddress read-only

public string|null $ipAddress

The IP address that the data in the model is for. If you performed a "me" lookup against the web service, this will be the externally routable IP address for the system the code is running on. If the system is behind a NAT, this may differ from the IP address locally assigned to it. This attribute is returned by all end points.

$isAnonymous read-only

public bool $isAnonymous

This is true if the IP address belongs to any sort of anonymous network. This property is only available from GeoIP2 Insights.

$isAnonymousVpn read-only

public bool $isAnonymousVpn

This is true if the IP address is registered to an anonymous VPN provider. If a VPN provider does not register subnets under names associated with them, we will likely only flag their IP ranges using the isHostingProvider property. This property is only available from GeoIP2 Insights.

$isAnycast read-only

public bool $isAnycast

This is true if the IP address belongs to an anycast network. This property is not available from GeoLite databases or web services.

$isHostingProvider read-only

public bool $isHostingProvider

This is true if the IP address belongs to a hosting or VPN provider (see description of isAnonymousVpn property). This property is only available from GeoIP2 Insights.

$isLegitimateProxy read-only

public bool $isLegitimateProxy

This attribute is true if MaxMind believes this IP address to be a legitimate proxy, such as an internal VPN used by a corporation. This attribute is only available in the GeoIP2 Enterprise database.

$isp read-only

public string|null $isp

The name of the ISP associated with the IP address. This attribute is only available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$isPublicProxy read-only

public bool $isPublicProxy

This is true if the IP address belongs to a public proxy. This property is only available from GeoIP2 Insights.

$isResidentialProxy read-only

public bool $isResidentialProxy

This is true if the IP address is on a suspected anonymizing network and belongs to a residential ISP. This property is only available from GeoIP2 Insights.

$isTorExitNode read-only

public bool $isTorExitNode

This is true if the IP address is a Tor exit node. This property is only available from GeoIP2 Insights.

$mobileCountryCode read-only

public string|null $mobileCountryCode

The mobile country code (MCC) associated with the IP address and ISP. This property is available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$mobileNetworkCode read-only

public string|null $mobileNetworkCode

The mobile network code (MNC) associated with the IP address and ISP. This property is available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$network read-only

public string|null $network

The network in CIDR notation associated with the record. In particular, this is the largest network where all of the fields besides $ipAddress have the same value.

$organization read-only

public string|null $organization

The name of the organization associated with the IP address. This attribute is only available from the City Plus and Insights web services and the GeoIP2 Enterprise database.

$staticIpScore read-only

public float|null $staticIpScore

An indicator of how static or dynamic an IP address is. This property is only available from GeoIP2 Insights.

$userCount read-only

public int|null $userCount

The estimated number of users sharing the IP/network during the past 24 hours. For IPv4, the count is for the individual IP. For IPv6, the count is for the /64 network. This property is only available from GeoIP2 Insights.

$userType read-only

public string|null $userType

The user type associated with the IP address. This can be one of the following values:

  • business
  • cafe
  • cellular
  • college
  • consumer_privacy_network
  • content_delivery_network
  • dialup
  • government
  • hosting
  • library
  • military
  • residential
  • router
  • school
  • search_engine_spider
  • traveler

This attribute is only available from the Insights web service and the GeoIP2 Enterprise database.

Methods

jsonSerialize()

public jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>

        
On this page

Search results