ip2region README

The project's README from github.com/lionsoul2014/ip2region. As one markdown file: README.md.

:globe_with_meridians: 中文简体 | English

ip2region

ip2region - is an offline IP address localization library and IP localization data management framework. It supports both IPv4 and IPv6 with query efficiency at the 10-microsecond level. It provides xdb data generation and query client implementations for many mainstream programming languages.

Features

1. Offline Localization Library

The project itself provides raw data for both IPv4 (data/ipv4_source.txt) and IPv6 (data/ipv6_source.txt), along with corresponding xdb files (data/ip2region_v4.xdb and data/ip2region_v6.xdb) to achieve city-level query localization. The field format is: Country|Province|City|ISP|iso-alpha2-code. Localization information for China is entirely in Chinese, while regional information for non-China areas is entirely in English.

2. Data Management Framework

xdb supports hundreds of millions of IP data segment rows. Region information supports full customization. The region information of the built-in data is fixed in the format: Country|Province|City|ISP|iso-alpha2-Code. You can append data for specific business needs to the region, such as: GPS information/International Standard Regional Codes/Zip codes, etc. In other words, you can fully use ip2region to manage your own IP localization data.

3. Data Deduplication and Compression

The xdb format generation program automatically processes the input raw data, checks and completes the merging of adjacent IP segments, and performs deduplication and compression of identical regional information.

4. High-Speed Query Response

Even for queries based entirely on the xdb file, the single query response time is at the 10-microsecond level. Memory-accelerated queries can be enabled through the following two methods:

  1. vIndex Index Caching: Uses a fixed 512KiB of memory to cache vector index data, reducing one disk IO operation and maintaining average query efficiency within 100 microseconds.
  2. Entire xdb File Caching: Loads the entire xdb file into memory. Memory usage is equal to the xdb file size. There is no disk IO operation, maintaining 10-microsecond level query efficiency.

5. Unified Query Interface

xdb provides version-compatible query implementations. A unified API can simultaneously provide queries for both IPv4 and IPv6 data and return unified data.

xdb Query

For API introductions, usage documentation, and test programs, please refer to the README introduction under the corresponding searcher query client. All query binding implementations are as follows:

Language Description IPv4 Support IPv6 Support
Golang golang query client :white_check_mark: :white_check_mark:
PHP php query client :white_check_mark: :white_check_mark:
Java java query client :white_check_mark: :white_check_mark:
C C[std=c99] query client :white_check_mark: :white_check_mark:
Lua_c lua c extension query client :white_check_mark: :white_check_mark:
Lua lua query client :white_check_mark: :white_check_mark:
Rust rust query client :white_check_mark: :white_check_mark:
Python python query client :white_check_mark: :white_check_mark:
Javascript javascript query client :white_check_mark: :white_check_mark:
Csharp csharp query client :white_check_mark: :white_check_mark:
Erlang erlang query client :white_check_mark: :white_check_mark:
Nginx nginx extension query client :white_check_mark: :white_check_mark:
C++ C++ query client :white_check_mark: :white_check_mark:
Cangjie Cangjie query client :white_check_mark: :white_check_mark:

The following toolchain implementations are contributed by community developers via third-party repositories:

Language Description
ip2region-composer php composer management client
ip2region-ts node.js addon management client
ruby-ip2region ruby xdb query client implementation
Ip2regionTool ip2region data conversion tool

xdb Generation

For API introductions, usage documentation, and test programs, please refer to the README documents under the following maker generation programs:

Language Description IPv4 Support IPv6 Support
Golang golang xdb generation program :white_check_mark: :white_check_mark:
Java java xdb generation program :white_check_mark: :white_check_mark:
Python python xdb generation program :white_check_mark: :x:
Csharp csharp xdb generation program :white_check_mark: :x:
Rust rust xdb generation program :white_check_mark: :white_check_mark:
C++ C++ xdb generation program :white_check_mark: :white_check_mark:

xdb Update

The core of the ip2region project lies in researching the design and implementation of IP data storage and fast querying. The raw data ./data/ipv4_source.txt and ./data/ipv6_source.txt included in the project are updated irregularly. For scenarios with high requirements for data accuracy and update frequency, it is recommended to purchase commercial offline data from the Ip2Region Community or third-party vendors. You can try to update the data yourself using the following methods:

Manual Editing and Updating

You can modify the data yourself based on the raw IP data provided by ip2region in ./data/ipv4_source.txt and ./data/ipv6_source.txt using the editing tools provided by ip2region. Currently, the data sources include:

  1. Data provided by the ip2region community (please refer to the official account at the bottom for community notifications)
  2. Project Issues tagged with [Data_Updates]
  3. Other custom data: e.g., data provided by customers, data obtained through GPS and WIFI positioning, or legal and compliant data from other platforms.

For instructions on using the raw IP data editing tools, please refer to the README documents under the following maker generation programs:

Language Description IPv4 Support IPv6 Support
Golang golang IP raw data editor :white_check_mark: :white_check_mark:
C++ C++ IP raw data editor :white_check_mark: :white_check_mark:

Detection Automatic Update

If you want to update data via your own API or data source, you can refer to the update algorithm based on the "Detection Algorithm" shared in the following videos to write your own update program:

  1. Data Update Implementation Video Sharing - part1
  2. Data Update Implementation Video Sharing - part2

Official Community

The Ip2Region official community was officially launched on 2025/06/12. On one hand, it provides stable commercial offline data services. On the other hand, it facilitates the strengthening of the IP toolchain and data services outside the core code, such as usage documentation, query testing, and data correction. For more information and services regarding the community, please visit the Ip2Region Official Community.

Related Remarks

1. xdb Technical Documents:

  1. xdb Data Structure Analysis: "ip2region xdb - Data Structure Description"
  2. xdb Query Process Analysis: "ip2region xdb - Query Process Description"
  3. xdb Generation Process Analysis: "ip2region xdb - Generation Process Description"
  4. xdb File Generation Tutorial: "ip2region xdb - File Generation Tutorial"
  5. xdb Concurrent Safety Query: "ip2region xdb - Concurrent Safety Query"
  6. xdb Data Update Method: "ip2region Data Update and Use of xdb Data Editor"

3. Technical Information Blogs

  1. WeChat Official Account - lionsoul-org, the author's active technical sharing channel
  2. Ip2Region Official Community

ip2region (lionsoul2014/ip2region)

ipv6-support
Searching Database…

19.7K ·GitHub
Ip2region
What is this?An offline IP-to-region localization library and data management framework: it maps IPv4 and IPv6 addresses to city-level regions with 10-microsecond queries, shipping xdb data files plus query clients for many programming languages.
Is it a service I have to run somewhere, or a library I embed in my app?A library plus a local data file: your code opens the xdb file with a searcher client and queries it in process — nothing to deploy. The repo also ships maker programs for generating your own xdb files.
How do I make my first lookup?Take data/ip2regionv4.xdb or data/ip2regionv6.xdb from the repo and open it with the searcher client for your language; each client's README documents the API, usage and test programs.
Do I need a database server or an internet connection for lookups to work?No. Lookups run entirely against the local xdb file — no server, no network calls — which is what makes the microsecond-level response times possible.
How fresh is the bundled IP data?The raw data is updated irregularly, so freshness is not guaranteed. For accuracy-critical scenarios the README recommends commercial data from the Ip2Region Community or third-party vendors; you can also update the data yourself.
What does a lookup actually return?A region string in a fixed format: Country|Province|City|ISP|iso-alpha2-code, at city-level precision. Region information for China is entirely in Chinese, while non-China areas are given entirely in English.
Does one API cover both IPv4 and IPv6?Yes. xdb ships version-compatible query implementations, so a single unified API can query both IPv4 and IPv6 data and return results in one unified format.
Which languages have ready-made query clients?Fourteen official clients, all with IPv4 and IPv6 support: Go, PHP, Java, C, Lua (C extension and pure Lua), Rust, Python, JavaScript, C#, Erlang, nginx, C++ and Cangjie. Community projects add a PHP Composer client, a Node.js addon and a Ruby client.
Can I manage my own IP data with it instead of using the built-in set?Yes — it is a full data management framework. xdb handles hundreds of millions of IP segment rows, region info is fully customizable (append GPS coordinates, zip codes and more), and generation auto-merges adjacent segments and dedupes identical regions.
What are similar projects?go-redis, CloudflareSpeedTest, badger, phpredis, tokio, uvicorn, BRUTAL, liteparse
Which topics is it in?ipv6-support, polyglot, geo, embedded-database, geolocation, high-performance, offline, sdk, china, developers, backend, database
Creator
lionsoul2014
Size
308.4 MB
Stars
19.7K
Updated
CommitOct 18Releasev3.18.0Sep 08
Age
10y
Commits · 90 Days