Skip to content
This repository was archived by the owner on Nov 13, 2026. It is now read-only.

Replace the README with a notice that the repository is archived #46

Merged
jwrosewell merged 1 commit into from
Nov 12, 2026
Merged

Replace the README with a notice that the repository is archived #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 26 additions & 114 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,35 @@
# ![51Degrees](https://51degrees.com/img/logo.png?utm_source=github&utm_medium=readme&utm_campaign=ip-intelligence-data&utm_content=readme.md&utm_term=ip-intelligence-data-files "Data rewards the curious") **IP Intelligence Data Files**
# IP Intelligence data files (archived)

## Introduction
This repository is archived and kept read-only. Its Asn data file, evidence
files, country codes, country name translations, scripts and tests are now in
the `ip-intelligence` folder of the [data](https://github.com/51Degrees/data)
repository.

This repo allows to obtain data needed to run IP Intelligence examples:
- evidence files with lists of random IP addresses needed for some examples
- scripts to generate lists of random IP addresses like the above
- scripts to download 'Lite' IP Intelligence data file
- translation files to support translation engine and examples
## Get the free data files

## Download Lite data file
The data repository lists each free data file as a link, and a script
downloads the files into place. No License Key is needed. To clone the
repository and download every free file in one command, run this.

The Lite data file is too large to commit to this repository, so one of the
scripts below downloads it from 51Degrees storage instead:

| Script | Language | OS |
| -- | -- | -- |
| `./get-lite-file-from-azure.ps1` | PowerShell | [Windows](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.5), [Linux](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-linux?view=powershell-7.5), [macOS](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-macos?view=powershell-7.5) |
| `./get-lite-file-from-azure.sh` | Shell | Linux, macOS |

Run the script from this directory, because the examples and tests look for
the file here:

```pwsh
cd ip-intelligence-data
./get-lite-file-from-azure.ps1
```

The script downloads the archive as `51Degrees-LiteV41.ipi.gz` (about 230 MB),
prints its MD5 hash and unpacks it to `51Degrees-LiteV41.ipi` (about 460 MB)
in the directory it is run from. If the archive is already present the
download is skipped and the existing archive is unpacked again. Pass `-Force`
(PowerShell) or `-f` (shell) to download a fresh copy, for example when a new
monthly data file has been published. The shell script needs `curl`, `gunzip`
and `md5sum` (`md5` on macOS) to be available.


## Files

### `51Degrees-IPIV4AsnIpiV41.ipi`

The on-premise IP Intelligence data file for Asn properties.

The [properties](https://51degrees.me/developers/property-dictionary?item=Asn%7CAll) available in this file are:

- Asn
- AsnName

More properties are available as part of the Enterprise data file - [contact us](https://51degrees.com/contact-us?utm_source=github&utm_medium=readme&utm_campaign=ip-intelligence-data&utm_content=readme.md&utm_term=51degrees-ipiv4asnipiv41-ipi).

This file is updated monthly.

### `51Degrees-LiteV41.ipi`

The 'lite' on-premise IP Intelligence data file.

The properties available in this file are:

- RegisteredCountry
- RegisteredName
- RegisteredOwner

More properties are available as part of the Enterprise data file - [contact us](https://51degrees.com/contact-us?utm_source=github&utm_medium=readme&utm_campaign=ip-intelligence-data&utm_content=readme.md&utm_term=51degrees-litev41-ipi).

This 'lite' file is built from a subsection of all IPs and is updated less frequently than the Enterprise IPI data file.

### `get-lite-file-from-azure.ps1`/`.sh`

Convenience scripts to download (and unpack) data file, stored on Azure Blob Storage.

### `evidence-gen.ps1`

A script to re-/generate the "evidence" files (CSV/YML) with a designated number of random IPv4 and/or IPv6 addresses.

Useful invocations:

```pwsh
./evidence-gen.ps1 -v4 10000 -v6 10000 "evidence.yml"
./evidence-gen.ps1 -v4 10000 -v6 10000 -csv "evidence.csv"
```

### `evidence.csv`/`.yml`

Pre-generated test files containing 20,000 of random IPs.

- evidence.csv - Each line contains a single IP.
- evidence.yml - A multi-record yaml file where each line contains the HTTP header name and value as the key/value pair. Values may be wrapped in single quotes.

## Tests

The download scripts are covered by a Pester 5 test suite:

| File | Role |
| -- | -- |
| `ci/run-unit-tests.ps1` | Entry point. Installs Pester if needed, runs the suite, and writes a NUnit XML report to `test-results/`. |
| `tests/check-dl-script.tests.ps1` | Pester test suite with 8 test cases (4 per download script). |

Run all tests (requires [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell)):

```pwsh
cd ip-intelligence-data
./ci/run-unit-tests.ps1
```sh
git clone https://github.com/51Degrees/data.git && data/get-data-files.sh
```

Each test performs a **real download** from 51Degrees storage into an isolated
temporary directory and verifies the archive is fetched, its printed MD5
matches a re-computed hash, and the file unpacks correctly. The test cases are:

- `Downloads both files (no args)` - no flags (both Lite + Asn files)
- `Downloads Lite only (-Lite)` - only the Lite file
- `Downloads Asn only (-Asn)` - only the Asn file
- `Forces re-download (-Force)` - pre-seeds dummy files then passes `-Force` to verify they are overwritten

## Translation
In PowerShell, run `./get-data-files.ps1` in the `data` folder instead. The
[data README](https://github.com/51Degrees/data#get-the-data-files) says how
to download only some files, or the newer versions of files you already have.

Folder containing yaml files for translation of country names into several target languages. This data is used in examples and by the translation engine.
## Examples and APIs

### Folder structure
|--Translations
| |--Translation Source (e.g. "OSM")
| | |-- Translation File (e.g. "countries.fr_FR.yml")
The examples and APIs that used these files are now in these repositories.

Each translation file contains key-value pairs of "English country name: country name in target language".
- [C and C++](https://github.com/51Degrees/51degrees-cxx)
- [.NET](https://github.com/51Degrees/51degrees-dotnet)
- [Go](https://github.com/51Degrees/51degrees-go)
- [Java](https://github.com/51Degrees/51degrees-java)
- [Nginx](https://github.com/51Degrees/51degrees-nginx)
- [Node.js](https://github.com/51Degrees/51degrees-node)
- [PHP](https://github.com/51Degrees/51degrees-php)
- [Python](https://github.com/51Degrees/51degrees-python)
- [Rust](https://github.com/51Degrees/51degrees-rust)
- [Varnish](https://github.com/51Degrees/51degrees-varnish)
Loading