Choose a database and complete a first local lookup.

Documentation overview

1. Using the offline data

Using the offline data takes three steps:

  1. Download the data: Sign in to the community, open Data services, and click Download data in the action navigation to start downloading the offline data. It includes the raw data in csv/txt format; you can also directly download the XDB-format data that meets your needs. The built-in XDB files currently include the following three variants:
Variant Field set Use case
Full variant all valid fields General-purpose variant that includes all valid fields of that data version; the XDB file is the largest.
Standard variant location fields down to the district For IP geolocation down to the district; the XDB file is usually a few dozen MiB smaller than the Full variant.
Simplified variant location fields down to the city For IP geolocation down to the city; the XDB file is usually a few dozen MiB smaller than the Standard variant.

  1. Generate the data: If none of the three XDB variants above meets your needs — for example, you only need region info down to the province — you can follow the XDB file generation doc to generate a custom XDB file. The resulting XDB file will be much smaller.

  2. Integrate the lookup: Go to Github/binding or Gitee/binding, find the implementation for the language used in your project, and follow its documentation to integrate the XDB search client.

2. Versions and descriptions

For any questions about the data, refer to:

  1. Commercial data manual

For detailed introductions to the data of each version, refer to:

  1. V4 Base / V4 Advanced / V4 Pro

  2. V6 Base / V6 Advanced / V6 Pro

3. XDB generation/use

Custom XDB generation doc:

  1. XDB file generation

4. XDB internals

  1. XDB data structure

  2. XDB search process

  3. XDB generation process

This guide is translated from the corresponding ip2region.net documentation. Product-specific facts and release metadata may change between snapshots.