Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

plevin

Location, network and abuse information for any IP address in one offline file.
No API, no rate limit, no lookup leaving the machine.

PyPI npm License Fields Boundaries Warm

pip install "plevin[db,full]"               # Python
npm install plevinjs                        # Node, Deno, Bun, Workers
curl https://plevin.tn3w.dev/api/1.1.1.1    # HTTP, nothing installed
<script type="module" src="https://cdn.jsdelivr.net/npm/plevinjs"></script>

import plevin

found = plevin.lookup("1.1.1.1")  # str, int, packed bytes or ipaddress object

Always a Result, never None; ValueError for anything that is not an address, and an integer reads as v6 only above 0xFFFFFFFF, so lookup(1) is 0.0.0.1.

>>> found.place.city.name, found.place.city.region.name, found.place.country.name
('Brisbane', 'Queensland', 'Australia')

>>> found.network.asn, found.network.operator.brand, found.network.cidr
(13335, 'Cloudflare', '1.1.1.0/24')

>>> exit_node = plevin.lookup("185.220.101.1")
>>> exit_node.abuse.service, exit_node.abuse.risk, exit_node.abuse.is_tor_exit_node
('tor_exit_node', 0.98, True)

The database is a separate wheel, found without being given a path. Install one, or several and the richest wins.

pip install "plevin[db]" 19.3 MB every field
pip install "plevin[place]" 6.6 MB city, region, postal, coordinates, metro
pip install "plevin[network]" 10.3 MB ASN, operator, routing, abuse
pip install "plevin[country]" 423 KB the country code

PLEVIN_DB=/path/to/plevin.plv or plevin.use("plevin.plv") reads a file of your own instead; plevin.Plevin(path) opens one without touching the module's.

Every field

address to place, network and abuse

found.place is where the address is, found.network who announces it, found.abuse what has been seen from it. Any of the three is None where the build carries none of it, and every leaf is None rather than "" or 0 where a source says nothing.

Place(
    lat=-27.4675,
    lon=153.0281,
    accuracy=200,
    confidence=36,
    granularity='city',
    city=City(
        id=2174003,
        name='Brisbane',
        ascii='Brisbane',
        country='AU',
        population=2780063,
        elevation=27,
        postal='4000',
        postal_partial=None,
        timezone='Australia/Brisbane',
        type='regional capital',
        capital='region',
        region=Region(id=2152274, code='04', iso='AU-QLD', name='Queensland',
                      type='State'),
        district=District(id=7839562, code='31000', name='Brisbane'),
        metro=None,
    ),
    country=Country(
        code='AU',
        name='Australia',
        official=None,
        common=None,
        iso3='AUS',
        numeric='036',
        flag='🇦🇺',
        european_union=False,
        driving_side='left',
    ),
    time=Time(
        timezone='Australia/Brisbane',
        abbreviation='AEST',
        local='2026-08-13T19:20:00+10:00',
        utc_offset='+10:00',
        is_dst=False,
        dst_start=None,
        dst_end=None,
    ),
)

country and time are derived, not stored: country from the two-letter code through pycountry, time from the zone name through zoneinfo, both only with the full extra. Without it the code, the flag, the EU and driving-side answers and the zone name still come through. capital says which capital the city is, region.iso is ISO 3166-2 and region.code the GeoNames admin1 number, postal_partial is the leading part of postal a source could only narrow that far.

Network(
    asn=13335,
    handle='CLOUDFLARENET',
    prefix=24,
    cidr='1.1.1.0/24',
    start='1.1.1.0',
    end='1.1.1.255',
    rir='apnic',
    rpki='valid',
    roas=1,
    operator=Operator(
        company='Cloudflare, Inc.',
        brand='Cloudflare',
        domain='cloudflare.com',
        website='https://www.cloudflare.com',
        category='content',
        tier=2,
        peering=356,
        scope='Global',
        rir='arin',
        since=2010,
        street='101 Townsend St',
        state='CA',
        postal='94107-1934',
        country='US',
        abuse_email='abuse@cloudflare.com',
        city=City(name='San Francisco', ...),  # a full City, as above
    ),
    carrier=Carrier(user_type='hosting', user_count=19, mcc=None, mnc=None,
                    is_mobile=False),
)

cidr is the announcement the address falls in, masked out of the address itself, so 1.1.1.1 and 1.0.0.1 reach one operator through two prefixes. rir is the registry that holds the address, which is the registry of the address and not of the ASN, so a block APNIC gave out can be announced by an operator ARIN registered. rpki is valid, invalid or unknown and roas how many ROAs agree.

Where nothing is announced, the registries still answer. asn, rpki and roas fall silent, cidr becomes the block a registry gave out rather than one a router carries, and handle and operator name whoever holds it.

>>> found = plevin.lookup("36.50.238.1")
>>> found.network.asn, found.network.cidr, found.network.rir
(None, '36.50.238.0/23', 'apnic')

>>> found.network.handle, found.network.operator.company
('GMTECH-BD', 'GM Tech')

RIPE, APNIC and AFRINIC publish the holder of every block they gave out; ARIN and LACNIC publish none, so an unannounced address in either region answers rir and cidr but no name. Roughly a seventh of routable IPv4 is announced by no one. brand drops the legal form and the words every network carries, so GOOGLE and Google LLC both read Google; domain is the host of website, else of abuse_email. tier is 1 transit-free, 2 has customers, 3 edge; peering the exchange count; category one of residential, business, hosting, education, government, military, cdn, content, infrastructure, cellular, search_engine_spider, traveler, transit, exchange or non-profit.

>>> plevin.lookup("185.220.101.1").abuse
Abuse(
    name='Tor',
    service='tor_exit_node',
    evidence='measured',
    risk=0.98,
    network_risk=0.82,
    last_seen_days=1,
    is_anycast=False,
    is_satellite=False,
    is_hosting_provider=True,
    is_proxy=False,
    is_public_proxy=False,
    is_residential_proxy=False,
    is_anonymous_vpn=False,
    is_tor_exit_node=True,
    is_private_relay=False,
    is_anonymous=True,
)

risk is 0 to 1 for the address, network_risk the same for the whole ASN, None where nothing has ever been seen, so which is not a risk of zero. It is a total, not a verdict any one source hands down: what the service the address runs is worth on its own, and what every feed that named it scored it, combined so each agreeing source raises the total and none of them replaces the rest. Feeds sharing an upstream count once, and the scale stops at 0.99, since enough feeds agreeing still is not proof. A Tor exit no feed has reported still reads high on the service alone; the same exit on four blocklists reads higher. evidence is published, measured, reported or inferred, strongest first; service is tor_exit_node, private_relay, anonymous_vpn, residential_proxy or public_proxy, most specific first. A public proxy on a residential or cellular line reads as residential_proxy with evidence='inferred'. The ten booleans are read off service and the carrier's type, never stored.

What an address says on its own

Answered without the database, so they hold for every address:

>>> found = plevin.lookup("2606:4700::1111")
>>> found.number, found.compressed
(50543257672059871404715951523469725969, '2606:4700::1111')

>>> found.expanded
'2606:4700:0000:0000:0000:0000:0000:1111'

>>> found.arpa
'1.1.1.1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.7.4.6.0.6.2.ip6.arpa'

is_global and is_bogon, then is_private, is_loopback, is_multicast, is_reserved, is_link_local, is_unique_local, is_documentation, is_shared (100.64/10) and is_benchmark (198.18/15), bisected out of the IANA special-purpose registries.

>>> plevin.lookup("::ffff:8.8.8.8").tunnel, plevin.lookup("::ffff:8.8.8.8").embedded_ipv4
('ipv4-mapped', '8.8.8.8')

>>> plevin.lookup("2002:808:808::1").is_6to4
True

tunnel is ipv4-mapped, 6to4, teredo, nat64 or None, with embedded_ipv4 the address it carries; is_ipv4_mapped, is_6to4 and is_teredo beside it.

>>> plevin.lookup("2001:67c:e60:c0c:192:42:116:55").decimal_ipv4
'192.42.116.55'

decimal_ipv4 is a guess and never a tunnel: the last four hextets where an operator wrote a v4 address into them as decimal. It is None wherever a real tunnel answers.

>>> found = plevin.lookup("8.8.8.8")
>>> found.as_ipv4_mapped, found.as_6to4, found.as_nat64
('::ffff:8.8.8.8', '2002:808:808::', '64:ff9b::808:808')

as_ipv4_mapped, as_6to4 and as_nat64 write a v4 address the other way about, as the v6 addresses that carry it; all three are None for a v6 address, where embedded_ipv4 already says what it carries.

What DNS says, where you ask for it

Off unless dns=True says otherwise, since it is the one part of a lookup that leaves the machine:

>>> plevin.lookup("8.8.8.8", dns=True).dns
Dns(
    asked='8.8.8.8',
    hostname='dns.google',
    hostnames=('dns.google',),
    ipv4='8.8.4.4',
    ipv6='2001:4860:4860::8888',
    ipv4_addresses=('8.8.4.4', '8.8.8.8'),
    ipv6_addresses=('2001:4860:4860::8888', '2001:4860:4860::8844'),
    alias=None,
    zone='8.8.8.in-addr.arpa',
    zone_primary='ns1.google.com',
    zone_contact='dns-admin@google.com',
    is_confirmed=True,
    is_signed=True,
)

hostname is the first PTR name and hostnames all of them, ipv4 and ipv6 that name resolved forward with ipv4_addresses and ipv6_addresses all of those, so each address names its other half; is_confirmed says the name leads back to the address, which is forward-confirmed reverse DNS; zone, zone_primary and zone_contact come from the reverse zone's SOA, naming who runs the range; is_signed is the DNSSEC verdict and alias a CNAME in the way; asked is the address actually asked about, which for a tunnel is the v4 it carries. Four questions go out in two rounds, PTR and SOA on the reverse name together and then A and AAAA of the hostname, written onto the wire and sent to every server at once, so the system's own from /etc/resolv.conf or the Windows registry and 1.1.1.1, 8.8.8.8 and 9.9.9.9, so first real answer winning, TCP where one comes back truncated, and kept for an hour, so a log with a thousand lines from one address asks once.

Good for

  • Country routing, pricing and compliance without a third-party call
  • Local time and flag before the user types anything
  • Bulk log enrichment, at 2M lookups/s on repeats
  • Abuse handling and RPKI triage in the same process, no whois or RDAP
  • Air-gapped deployments, where no address leaves the process

Data

v4 boundaries 2,629,342, plus 3,902,469 host rows
v6 boundaries 396,430
cities 76,805 in 3,177 regions
districts, metros 19,941 and 210
ASNs, operators 86,237 and 147,621, registry holders included
timezones 394
abuse records 2,556 over 156 feeds

Rebuilt daily from MaxMind GeoLite2, IP2Location LITE, GeoNames, Natural Earth, a RIPE RIS RIB, RPKI ROAs, the NRO delegations, the RIPE, APNIC and AFRINIC whois dumps, CAIDA, PeeringDB, asn-abuse and the feeds in builder/data/feeds.json. Plevin(path).built dates your copy, .selection names which fields it carries and .fields lists them.

Python 3.10+. No dependencies on 3.14, where compression.zstd is in the standard library; pyzstd below it. pycountry and, on Windows, tzdata come with the full extra.

Speed

open 2 ms, mmapped and read-only
first answer 12 ms
repeats 2,060,000/s
uniformly random v4 16,000/s, every one a fresh block decode

Blocks decode on reach and stay decoded, so a real log lands between the two: the boundary a lookup found, the rows it linked to and the answer itself are all kept.

Your own file

from plevin import Plevin

with_places = Plevin("dist/plevin.metro-place.plv")
with_places.lookup("1.1.1.1").place.city.name

Read-only and memory-mapped, so processes and threads share one file. For the stored rows without any of the shaping above, so dictionaries, codes already read as words, so Plevin(path).file.row(value, wide) is the reader underneath.

Builder

The Rust builder, its sources, the file format and the selection language are in builder/README.md.

cd builder && cargo build --release
./target/release/plevin-builder              # dist/plevin.plv, every field
./target/release/plevin-builder place+metro  # dist/plevin.metro-place.plv

JavaScript

The same reader, field for field, as one ESM package with no dependencies: Node, Deno, Bun, Cloudflare Workers and the browser. js/README.md has all of it.

npm install plevinjs
import { open } from "plevinjs";                 // or "plevinjs/node" for a path on disk

const db = await open("https://plevin.tn3w.dev/db/plevin.plv");
db.lookup("1.1.1.1").network.operator.brand;   // 'Cloudflare'

const named = await db.resolve("1.1.1.1", { dns: true });  // the one call that asks DNS
named.dns.hostname;                            // 'one.one.one.one'

A page needs no install: https://cdn.jsdelivr.net/npm/plevinjs is the reader, as is https://esm.sh/plevinjs, and open() takes the database from wherever it is hosted.

The file is Zstandard with trained dictionaries, which no runtime decompresses on its own, so the package carries a decoder condensed from fzstd (MIT) with dictionary support added, checked block for block against libzstd. 4,600,000 warm lookups a second.

Lookup page

plevin.tn3w.dev reads the database in the tab and answers there: no API, and no address of yours sent anywhere except to the service that tells you your own, and to a resolver for the DNS card. It is plain HTML, CSS and JavaScript in site/, built and deployed by pages.yml whenever a database is released.

The same deployment rehosts every release file with open CORS, which the GitHub release downloads do not carry:

https://plevin.tn3w.dev/db/plevin.plv every field, 19.3 MB
https://plevin.tn3w.dev/db/plevin.metro-place.plv city, region, postal, coordinates, metro, 6.6 MB
https://plevin.tn3w.dev/db/plevin.abuse-network.plv ASN, operator, routing, abuse, 10.3 MB
https://plevin.tn3w.dev/db/plevin.place-country-code.plv the country code, 423 KB
https://plevin.tn3w.dev/db/index.json the tag and what it carries
https://plevin.tn3w.dev/plevin/plevin.min.js the reader, one file

The API at plevin.tn3w.dev/api

worker/ is the smallest useful API around the file, running at plevin.tn3w.dev/api: it reads plevin.plv out of a KV namespace once per isolate and answers from memory after that, in the same JSON the two readers return.

curl https://plevin.tn3w.dev/api/1.1.1.1        # any address
curl https://plevin.tn3w.dev/api/me             # the caller's own
curl https://plevin.tn3w.dev/api/about          # what the file carries
curl "https://plevin.tn3w.dev/api?ip=9.9.9.9"
curl "https://plevin.tn3w.dev/api/1.1.1.1?dns=1"   # with the DNS block filled in

An unknown address answers 400 with {"error": …}; every answer carries access-control-allow-origin: *, and lookups cache for five minutes. dns is null unless ?dns=1 asks for it, since that is the one part of an answer the worker leaves Cloudflare to find; those answers cache for a minute.

cd worker && npm install
npx wrangler kv namespace create PLEVIN   # the id goes in the KV_NAMESPACE_ID secret
npx wrangler kv key put --binding PLEVIN --remote plevin.plv --path ../plevin.plv
npx wrangler deploy

.github/workflows/deploy-worker.yml deploys a push to worker/ or js/, and puts the newest plevin.plv in KV on a release. It fills wrangler.toml from the KV_NAMESPACE_ID, ZONE_ID, CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_API_TOKEN secrets and the WORKER_ROUTE variable. The token needs Workers Scripts:Edit and Workers KV Storage:Edit on the account and Workers Routes:Edit on the zone.

DATABASE picks a smaller file than plevin.plv where it is set.

Mini file

plevin_mini.py is the lookup with no package around it. Drop it beside a .plv and it runs.

python plevin_mini.py plevin.plv 8.8.8.8
>>> from plevin_mini import Plevin
>>> Plevin("plevin.plv").lookup("8.8.8.8")["network"]["asn"]
15169

Plain dictionaries of the stored rows, codes already read as words, and nothing derived: no models, no country, no clock, no discovery. 3,600,000 lookups a second warm. It is linted and type-checked with the package.

Development

cd python
uv run pytest          # 168 tests, 100% branch coverage
uv run mypy
uv run basedpyright
uvx ruff check . ../plevin_mini.py --config pyproject.toml
uv build --wheel

cd ../js
npm ci && npm test     # node --test
npm run lint           # biome
npm run typecheck      # tsc, strict
npm run build          # dist/, ESM and .d.ts

cd ../builder && cargo fmt --check && cargo clippy

js/test/compare.ts reads every field of both readers for the same addresses and fails on any difference; js/test/blocks.ts checks the JavaScript zstd decoder against libzstd over every block of a file.

License

Apache 2.0 for the readers and the builder, see LICENSE; the JavaScript zstd decoder is condensed from fzstd, MIT, and says so in the file. The database carries the licenses of the sources it was built from, listed in builder/README.md.

Releases

Sponsor this project

Contributors

Languages