Skip to content

daimon3332/address

Repository files navigation

Address logo

Address

A self-hosted address and synthetic test-profile generator for 27 countries and regions.

English · 简体中文 · 繁體中文

CI Release Node.js 24 MIT License Live Demo

Address combines real open-data streets, administrative areas, coordinates, and postcodes with clearly marked synthetic indoor details. It produces source-language, English, and Simplified-Chinese address presentations plus coherent profile fields for form and software testing.

Generated records are test data. They do not prove deliverability, residency, identity, payment-account validity, or ownership.

🚀 Workflow

Choose a country and location → select ordinary or evidence-backed residential mode → generate an address and test profile → copy individual fields or export the result.

✨ Features

  • Covers 27 countries and regions with region, city, and postcode filters.
  • Uses exact → nearby → same-region → nationwide fallback for synchronized countries.
  • Supports IP-nearby generation with a local SQLite RTree fallback.
  • Presents addresses in the source language, English, and Simplified Chinese.
  • Separates source-backed address components from labeled synthetic indoor fields.
  • Generates coherent basic profile, sandbox card, employment, finance, and network fields.
  • Provides Google coordinate preview, address search, and an AMap link for China.
  • Hot-reloads a custom blacklist and preserves evidence/source attribution.
  • Supports resumable initial imports, daily country rotation, quality gates, and storage limits.

🧭 Address Sources and Field Provenance

The default synchronized pool uses the following source family for each country. Live providers may be used only when the corresponding mode and credential are enabled; they do not replace the default offline pool.

Country / region Default source Real/source-backed address fields Generated/synthetic address fields
United States (US) Overture Maps House number, street, city, state, ZIP, source geometry None for ordinary records; missing apartment details may generate Apt/room
Canada (CA) Overture Maps House number, street, city, province, postal code, source geometry None for ordinary records; missing apartment details may generate Unit/room
Mexico (MX) Overture Maps House number, street, municipality, state, postcode, source geometry None for ordinary records; missing apartment details may be generated
United Kingdom (GB) Geofabrik OSM House number, street, town, postcode, source geometry None for ordinary records; missing apartment details may generate Flat
Germany (DE) Overture Maps House number, street, city, postcode, source geometry None for ordinary records; missing apartment details may be generated
France (FR) Overture Maps House number, street, city, postcode, source geometry None for ordinary records; missing apartment details may be generated
Italy (IT) Overture Maps House number, street, city, region, postcode, source geometry None for ordinary records; missing apartment details may be generated
Spain (ES) Overture Maps House number, street, city, province, postcode, source geometry None for ordinary records; missing apartment details may be generated
Netherlands (NL) Overture Maps House number, street, city, postcode, source geometry None for ordinary records; missing apartment details may be generated
Russia (RU) Geofabrik OSM House number, street, city, federal subject, postcode, source geometry None for ordinary records; missing apartment details may be generated
China (CN) AreaCity + AMap/Baidu/Tencent POI Province/municipality, city, district, township, registered community name/address, and provider coordinate Building 1–3, unit 1–3, floor 2–6, room 01–04
Hong Kong (HK) Geofabrik OSM Building/street, district, area, source geometry Missing floor/flat/room details may be generated
Taiwan (TW) Overture Maps House number, street, city/county, district, postcode, source geometry None for ordinary records; missing apartment details may be generated
Japan (JP) Overture Maps Block/house number, street, municipality, prefecture, postcode, source geometry None for ordinary records; missing apartment room details may be generated
South Korea (KR) Geofabrik OSM Road, building number, district, city/province, postcode, source geometry Missing building/unit/room details may be generated
Singapore (SG) Geofabrik OSM House number, street, locality, postcode, source geometry Missing apartment unit may be generated
Vietnam (VN) Geofabrik OSM House number, street, district, city, province, postcode, source geometry None for ordinary records; missing apartment details may be generated
Thailand (TH) Geofabrik OSM House number, street, city, province, postcode, source geometry None for ordinary records; missing apartment details may be generated
Philippines (PH) Geofabrik OSM House number, street, barangay/district, city, region, postcode, source geometry None for ordinary records; missing apartment details may be generated
Malaysia (MY) Geofabrik OSM House number, street, district, city, state, postcode, source geometry None for ordinary records; missing apartment details may be generated
India (IN) Geofabrik OSM House number, street, district, city, state, postcode, source geometry None for ordinary records; missing apartment details may be generated
Australia (AU) Overture Maps House number, street, suburb, state, postcode, source geometry None for ordinary records; missing apartment details may be generated
Türkiye (TR) Geofabrik OSM House number, street, city, province, postcode, source geometry None for ordinary records; missing apartment details may be generated
Saudi Arabia (SA) Geofabrik OSM House number, street, city, postcode, source geometry None for ordinary records; missing apartment details may be generated
Brazil (BR) Geofabrik OSM House number, street, city, state, postcode, source geometry None for ordinary records; missing apartment details may be generated
Nigeria (NG) Geofabrik OSM House number, street, city, state, postcode, source geometry None for ordinary records; missing apartment details may be generated
South Africa (ZA) Geofabrik OSM House number, street, suburb, postcode, source geometry None for ordinary records; missing apartment details may be generated

None for ordinary records means the street-level address fields are not invented; an apartment record can still receive a synthetic indoor field when the source has no official unit.

Real and synthetic fields

Field Provenance
Country, region, city, district, and street Source-backed and normalized from the address record; missing administrative labels may be filled from the local catalog.
House number Keeps the source/provider registration value when present; it is not replaced by a generated China number.
Postcode Uses a valid source postcode when available; invalid or missing values may be filled from the nearest catalog entry.
Coordinates Copied from the source geometry. Depending on the source, this may be an address point, building point, or the centroid of an OSM way.
Building or community Uses a source value when present. China residential mode only uses communities synchronized from AMap, Baidu, or Tencent; no lexicon fallback is used.
Apartment, building, unit, and room Keeps official/source-tagged values when present. Missing indoor details may be generated for China and apartment records in other countries.
Name, phone, email, employment, finance, network, and sandbox card Synthetic test data.

China therefore means AreaCity-validated administrative context plus a map-provider community, registered address, and coordinate, with only indoor hierarchy synthesized. The other countries keep source house numbers, while missing apartment/unit details may still be generated. verified means that source evidence and project quality checks passed; it does not mean that the address is current, occupied, or deliverable.

Google Maps and AMap behavior

  • Google coordinate preview opens latitude,longitude from the source geometry. It is a location preview, not a Google delivery or occupancy certificate.
  • Google address search includes the real China provider address and community name, while generated building/unit/room details stay out of the query.
  • AMap is generated only for China. The source WGS-84 coordinate is converted to GCJ-02 before opening the AMap marker URL.
  • A map pin may represent an address point, building centroid, or way centroid rather than an entrance or room. The default generation path does not claim that a Google Geocoding result has independently verified every record.

For detailed field examples and source notes, see address formats, data sources, and the API documentation.

🖼️ Webui Preview (Webui 预览)

View the complete United States and China WebUI preview
United States China
United States WebUI overview China WebUI overview
Generator Generator
United States generator controls China generator controls
Address Address
Generated United States address Generated China address
Basic profile Basic profile
United States basic test profile China basic test profile
Sandbox card Sandbox card
United States sandbox card data China sandbox card data
Employment Employment
United States employment data China employment data
Finance Finance
United States finance data China finance data
Network and extended fields Network and extended fields
United States network and extended data China network and extended data
Google Maps Google Maps
United States Google Maps preview China Google Maps preview

📚 Documentation

Document Contents
API documentation Public endpoints, parameters, errors, sync management, CORS, and examples
Deployment documentation API keys, private configuration, VPS, Nginx, synchronization, backup, and capacity
Development documentation Architecture, local setup, data pipeline, extension points, tests, and release gates

⚡ Quick start

Node.js 24 or newer is required.

git clone https://github.com/daimon3332/address.git
cd address
cp .env.example .env
npm ci
npm run db:migrate
npm run dev

A new database contains schema only. Run npm run data:address-pool:bootstrap for the resumable 27-country import. See the deployment guide before running a production VPS.

🔑 Configuration summary

Offline runtime generation does not call map providers after synchronization. Configure multiple AMap, Baidu, and Tencent keys in /admin/; they are encrypted in control.sqlite with the server-only CONFIG_MASTER_KEY. Put the master key and bootstrap password only in ignored .env, .deploy.env, or /root/address/runtime/address.env files. Never add credentials to source, browser code, screenshots, issues, or CI logs.

💾 Database size

Measured after all 27 countries were synchronized on 2026-07-23 at commit 084805e:

Item Measured size
address.sqlite 6.90 GiB
Complete data/ directory 7.89 GiB
Initial-import peak About 11.2 GiB

Actual size varies with upstream releases and WAL activity. A production application volume of at least 60 GiB is recommended for synchronization, backups, and recovery space.

🌍 Coverage

United States, Canada, Mexico, United Kingdom, Germany, France, Italy, Spain, Netherlands, Russia, China, Hong Kong, Taiwan, Japan, South Korea, Singapore, Vietnam, Thailand, Philippines, Malaysia, India, Australia, Turkey, Saudi Arabia, Brazil, Nigeria, and South Africa.

Data, privacy, and license

  • Overture Maps provides selected address records with source-specific metadata and terms.
  • OpenStreetMap and Geofabrik provide other source data under ODbL 1.0.
  • Client IP is used only for a requested location lookup and is not written to the address database.
  • Indoor details, profiles, and card fields are synthetic test data.

Project code is released under the MIT License. Redistributed data remains subject to its source licenses, attribution, and share-alike terms. The repository and releases contain no production database or private credentials.

Community

  • linux.do: Learn AI on L-Station!!!
  • Nodeseek.com: Nodeseek is a place for people who love web development, hosting, vps / server and other geek things.

About

A self-hosted address and synthetic test-profile generator for 27 countries and regions, built from real open-data streets, administrative areas, coordinates, and postcodes. Supports multilingual output, IP-nearby generation, map previews, and API access. 基于真实开放数据的自托管地址与合成测试资料生成器,覆盖 27 个国家和地区,支持多语言地址、IP 附近生成、地图预览与 API 调用

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages