HLR Lookup Documentation

The HLR Lookup Developer Hub

Welcome to the HLR Lookup help pages. Here you'll find all the information you need to get started with our API or batch upload services.
Search the docs for explanations on the results you'll receive and a breakdown of all the possible parameters available.

Optional Cache Parameters

The parameters below can be added at the end of the base URL.

https://www.hlrlookup.com/api/hlr/?apikey=$key&password=$password&msisdn=$msisdn

&personalcache=

The amount of days you would like us to look back in your previous results to see if you have previously checked this number.

Set to 0 to ignore the cache.
Maximum length of 30 days.

If this parameter is omitted your default setting will be used. Your default cache settings can be found in your account settings.

For Example

https://www.hlrlookup.com/api/hlr/?apikey=$key&password=$password&msisdn=$msisdn&personalcache=10

*this example shows the Personal Cache set to 10 days

Note

Any results obtained from your Personal Cache are not charged for.

&sharedcache=

The amount of days you would like us to look back in our database of shared results to see if any of our users that have agreed for their results to be added to the Shared Cache have previously checked your number.

Set to 0 to ignore the shared cache.
Maximum length of 30 days.

If this parameter is omitted your default setting will be used. Your default cache settings can be found in your account settings.

For Example

https://www.hlrlookup.com/api/hlr/?apikey=$key&password=$password&msisdn=$msisdn&sharedcache=30

*this example shows the Shared Cache set to 30 days

Note

Any results obtained from the Shared Cache are charged at half credit.

&savetoshared=

Set to 'on' to save this result to the shared cache of results.
Set to 0 or 'off' to not save your result.

If this parameter is omitted your default setting will be used.Your default cache settings can be found in your account settings.

For Example

https://www.hlrlookup.com/api/hlr/?apikey=$key&password=$password&msisdn=$msisdn&savetoshared=on
*this example sets the Shared Cache to on

Note

Every time one of our users obtains a result you have added to the Shared Cache we will add 0.25 credits to your account balance.

For more information on our Cache options just visit our Personal and Shared Cache pages.

Optional Cache Parameters


The parameters below can be added at the end of the base URL.

https://www.hlrlookup.com/api/hlr/?apikey=$key&password=$password&msisdn=$msisdn

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.