Download the PHP package ipgeolocation/ipgeolocation-php-sdk without Composer

On this page you can find all versions of the php package ipgeolocation/ipgeolocation-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ipgeolocation/ipgeolocation-php-sdk

Informations about the package ipgeolocation-php-sdk

IPGeolocation PHP SDK

Official PHP SDK for the IPGeolocation.io IP Location API.

Look up IPv4, IPv6, and domains with /v3/ipgeo and /v3/ipgeo-bulk. Get geolocation, company, ASN, timezone, network, hostname, abuse, user-agent, and security data.

Table of Contents

Installation

Quick Start

You can pass plain arrays to request methods. If you want validation before the request is sent, use LookupIpGeolocationRequest and BulkLookupIpGeolocationRequest.

At a Glance

Item Value
Package ipgeolocation/ipgeolocation-php-sdk
Namespace Ipgeolocation\Sdk
Supported Endpoints /v3/ipgeo, /v3/ipgeo-bulk
Supported Inputs IPv4, IPv6, domain
Main Data Returned Geolocation, company, ASN, timezone, network, hostname, abuse, user-agent, currency, security
Authentication API key, request-origin auth for /v3/ipgeo only
Response Formats Structured JSON, raw JSON, raw XML
Bulk Limit Up to 50,000 IPs or domains per request
Transport Guzzle

Get Your API Key

Create an IPGeolocation account and copy an API key from your dashboard.

  1. Sign up: https://app.ipgeolocation.io/signup
  2. Verify your email if prompted
  3. Sign in: https://app.ipgeolocation.io/login
  4. Open your dashboard: https://app.ipgeolocation.io/dashboard
  5. Copy an API key from the API Keys section

For server-side code, keep the API key in an environment variable or secret manager. For browser-based single lookups on paid plans, use request-origin auth instead of exposing an API key in frontend code.

Authentication

API Key

Request-Origin Auth

request_origin must be an absolute http or https origin with no path, query string, fragment, or userinfo.

[!IMPORTANT] Request-origin auth does not work with /v3/ipgeo-bulk. Bulk lookup always requires api_key.

[!NOTE] If you set both api_key and request_origin, both are sent. The API key appears in the query string, so avoid logging full request URLs.

Plan Behavior

Feature availability depends on your plan and request parameters.

Capability Free Paid
Single IPv4 and IPv6 lookup Supported Supported
Domain lookup Not supported Supported
Bulk lookup Not supported Supported
Non-English lang Not supported Supported
Request-origin auth Not supported Supported for /v3/ipgeo only
Optional modules via include Not supported Supported
include: ["*"] Base response only All plan-available modules

Paid plans still need include for optional modules. fields and excludes only trim the response. They do not turn modules on or unlock paid data.

Client Configuration

Field Type Default Notes
api_key string unset Required for bulk lookup. Optional for single lookup if request_origin is set.
request_origin string unset Must be an absolute http or https origin.
base_url string https://api.ipgeolocation.io Override the API base URL.
connect_timeout float 10.0 Time to open the connection, in seconds.
read_timeout float 30.0 Time to wait for response data before timing out, in seconds.

The client constructor accepts either an IpGeolocationClientConfig or an array with the same keys.

Available Methods

Method Returns Notes
lookupIpGeolocation($request = null) ApiResponse with typed data Single lookup. Typed JSON response.
lookupIpGeolocationRaw($request = null) ApiResponse with string data Single lookup. Raw JSON or XML string.
bulkLookupIpGeolocation($request) ApiResponse with bulk result array Bulk lookup. Typed JSON response.
bulkLookupIpGeolocationRaw($request) ApiResponse with string data Bulk lookup. Raw JSON or XML string.
close() void Closes the client. Do not reuse the client after this.

[!NOTE] Typed methods support JSON only. Use the raw methods when you need XML output.

Request Options

Field Applies To Notes
ip Single lookup IPv4, IPv6, or domain. Omit it for caller IP lookup.
ips Bulk lookup Array of 1 to 50,000 IPs or domains.
lang Single and bulk One of en, de, ru, ja, fr, cn, es, cs, it, ko, fa, pt.
include Single and bulk Array of module names such as security, abuse, user_agent, hostname, liveHostname, hostnameFallbackLive, geo_accuracy, dma_code, or *.
fields Single and bulk Array of field paths to keep, for example ["location.country_name", "security.threat_score"].
excludes Single and bulk Array of field paths to remove from the response.
user_agent Single and bulk Overrides the outbound User-Agent header.
headers Single and bulk Extra request headers. Use an associative array where each value is a string or an array of strings.
output Single and bulk "json" or "xml". Typed methods require JSON.

Examples

The examples below assume you already have a configured client in scope:

Caller IP

Omit ip to look up the public IP of the machine making the request.

Domain Lookup

Domain lookup is a paid-plan feature.

Security and Abuse

User-Agent Parsing

To parse a visitor user-agent string, pass include: ["user_agent"] and send the visitor string in the request User-Agent header.

[!NOTE] The user_agent request field overrides the SDK's default outbound User-Agent header. It takes precedence over headers["User-Agent"].

Filtered Response

Raw XML

Bulk Lookup

Bulk lookup is a paid-plan feature and always requires api_key.

Each bulk result is either a success or an error.

Response Metadata

Each method returns an ApiResponse with data and metadata.

metadata includes:

Field Meaning
credits_charged Credits charged for the request when the API returns that header
successful_records Number of successful bulk records when the API returns that header
status_code HTTP status code
duration_ms Client-side request time in milliseconds
raw_headers Response headers as an associative array of header names to string arrays

Helper methods:

JSON Helpers

Typed response objects extend ValueObject, so you can turn them into arrays or JSON when you need to log, cache, or forward them.

Errors

The SDK throws these exception classes:

Example:

Troubleshooting

Frequently Asked Questions

Can I pass a plain array instead of a request object? Yes. All client methods accept either the typed request object or a plain array with the same keys.
How do I look up my own public IP? Call lookupIpGeolocation() with no ip value.
How do I get XML? Use the raw methods with output => "xml".
How do I read bulk errors? Check $result->success. Success items use $result->data. Error items use $result->error->message.

Links

All versions of ipgeolocation-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ext-curl Version *
ext-json Version *
guzzlehttp/guzzle Version ^7.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ipgeolocation/ipgeolocation-php-sdk contains the following files

Loading the files please wait ...