API Basics
Data Tools
Browser Bot
HTML Clean
URL Info
Security and Networking
Legacy APIs

HLR Lookup

Connect to the global mobile cellular network and retrieve the status of a mobile device.

The home location register (HLR) is a central database that contains details of each mobile phone subscriber connected to the global mobile network. You can use this API to validate that a mobile number is live and registered on a mobile network in real-time. Find out the carrier name, ported number status and fetch up-to-date device status information.

We don't charge for HLR lookups if we already know the number is not a valid mobile number. This API automatically calls the Phone Validate API first to validate the number type without any need to connect to the carrier network.

HLR Pricing

Volume Cost / per lookup
10k 0.009
50k 0.008
50k+ 0.007

End Point

Test API
API Request
numberyesstringA phone number
country-codenostringISO 2-letter country code, assume numbers are based in this country.
If not set numbers are assumed to be in international format (with or without the leading + sign)
API Response
number-validbooleanTrue if this a valid phone number
hlr-validbooleanWas the HLR lookup successful. If true then this is a working and registered cell-phone or mobile device (SMS and phone calls will be delivered)
hlr-statusstringThe HLR lookup status, possible values are:
  • ok - the HLR lookup was successful and the device is connected
  • absent - the number was once registered but the device has been switched off or out of network range for some time
  • unknown - the number is not known by the mobile network
  • invalid - the number is not a valid mobile MSISDN number
  • fixed-line - the number is a registered fixed-line not mobile
  • voip - the number has been detected as a VOIP line
  • failed - the HLR lookup has failed, we could not determine the real status of this number
is-mobilebooleanTrue if this is a mobile number (only true with 100% certainty, if the number type is unknown this value will be false)
is-portedbooleanHas this number been ported to another network
is-roamingbooleanIs this number currently roaming from its origin country
imsistringThe mobile IMSI number (International Mobile Subscriber Identity)
mccstringThe mobile MCC number (Mobile Country Code)
mncstringThe mobile MNC number (Mobile Network Code)
msinstringThe mobile MSIN number (Mobile Subscription Identification Number)
mscstringThe mobile MSC number (Mobile Switching Center)
current-networkstringThe currently used network/carrier name
origin-networkstringThe origin network/carrier name
ported-networkstringThe ported to network/carrier name (only set if the number has been ported)
number-typestringThe number type, possible values are:
  • mobile
  • fixed-line
  • premium-rate
  • toll-free
  • voip
  • unknown
locationstringThe number location. Could be a city, region or country depending on the type of number
countrystringThe phone number country
country-codestringThe number location as an ISO 2-letter country code
country-code3stringThe number location as an ISO 3-letter country code
currency-codestringISO 4217 currency code associated with the country
roaming-country-codestringIf the number is currently roaming, the ISO 2-letter country code of the roaming in country
international-calling-codestringThe international calling code
international-numberstringThe number represented in full international format
local-numberstringThe number represented in local dialing format
API Performance
Avg Latency1-5s (variable)This API has a non-deterministic latency based on outside factors
Max Rate20/secondMaximum inbound request rate. Exceeding this will result in request throttling
Max Concurrency50Maximum concurrent/simultaneous requests. Exceeding this will result in error code 06 [TOO MANY CONNECTIONS]

API Example
curl https://neutrinoapi.net/hlr-lookup \ --header "User-ID: <your-user-id>" \ --header "API-Key: <your-api-key>" \ --data-urlencode "number=+12106100045" \ --data-urlencode "country-code="
{ country: "United States", country-code: "US", country-code3: "USA", currency-code: "USD", current-network: "Sinch Voice -Port", hlr-status: "voip", hlr-valid: false, imsi: "", international-calling-code: "1", international-number: "+12106100045", is-mobile: false, is-ported: true, is-roaming: false, local-number: "(210) 610-0045", location: "San Antonio, TX", mcc: "", mnc: "", msc: "LANDLINE", msin: "", number-type: "voip", number-valid: true, origin-network: "BANDWIDTH.COM", ported-network: "Sinch Voice -Port", roaming-country-code: "" }