OpenHLR

An open-source initiative to build an accurate, comprehensive, and global telecom intelligence database for mobile networks. Aiming to provide both free and community-made telco intelligence. This repo is availiable in kaggle or github.

What is a HLR ? (And why we don't provide some components of a HLR)

It is a database inside a mobile operator's core network that stores information about subscribers. Think of it as the operator's master registry for SIM cards. While this database doesn't return some data (like IMSI, Roaming, Subscribed Services, SMS Routing Information etc). These records are maintained by mobile network operators and are not publicly available. OpenHLR intentionally focuses on publicly available telecom metadata while respecting user privacy and avoiding access to secret operator-managed subscriber information.

Note: OpenHLR is an offline lookup database. Information such as roaming status, IMSI, live HLR status, subscriber reachability, and current serving network cannot be determined without access to mobile carrier infrastructure.

API (Python)

1. country. Parameters: Country Name (Case insensitive). Response Example:

{
  "query": "Bangladesh",
  "country": "Bangladesh",
  "country_code": "880",
  "operator_count": ...,
  "operators": [
    {
      "operator_id": 1705,
      "operator": "Grameenphone Ltd.",
      "brand": "Grameenphone",
      "mcc": "470",
      "mnc": "01",
      "network_type": "GSM 900 / GSM 1800 / UMTS 2100 / LTE 1800",
      "prefixes": 3
    },
    {
      "operator_id": 1707,
      "operator": "Banglalink Digital Communications Ltd.",
      "brand": "Banglalink",
      "mcc": "470",
      "mnc": "03",
      "network_type": "GSM 900 / GSM 1800 / UMTS 2100 / LTE 1800 / LTE 2100 / TD-LTE 2300",
      "prefixes": 2
    },
    {
      "operator_id": 1708,
      "operator": "Teletalk Bangladesh Limited",
      "brand": "TeleTalk",
      "mcc": "470",
      "mnc": "04",
      "network_type": "GSM 900 / UMTS 2100 / LTE 1800",
      "prefixes": 1
    }
    
  ]
}

2. phone. Parameter: Phone Number with country code. Example response:

{
  "number": "+19098583017",
  "area": "California",
  "e164": "+19098583017",
  "international": "+1 909-858-3017",
  "national_format": "(909) 858-3017",
  "national": "9098583017",
  "country_code": 1,
  "country_iso": "US",
  "country_name": "United States",
  "timezone": "America/Los_Angeles",
  "is_valid": true,
  "is_possible": true,
  "type": "FIXED_LINE_OR_MOBILE",
  "carrier": null,
  "is_portable": null,
  "mcc": null,
  "mnc": null,
  "operator_name": null,
  "brand": null,
  "is_a_brand": null,
  "parent_company": null,
  "network_type": null,
  "networks": null,
  "matched_prefix": null
}

Contribution

Contributons are welcome! Whether you would like to implement another version of the library in ANY programming language, add/remove/update an entry in the database or any other issue you would like to fix or report. Make an issue (for reporting issues or updating the dataset) or a pull-request (for updating the code or making another version in another programming language).

Sources

We have collected the data from the sources prescribed in sources.csv and telecom_dataset/metadata.json. We acknowledge that these are the only sources(for now) we have explored and collected from.