Getting Started with our API

v1 / v2

Getting Started with our API

Overview

The following pages will help you to get started with using our V1 API to check your numbers.

We recommend you submit all requests to HLR Lookup API over HTTPS.

HLR Lookup’s V1 API is based on GET standards, enabling you to use your browser for accessing URLs. Use any HTTP client in any programming language to interact with our API.

To use the HLR Lookup V1 API use the following base URL

Method:        GET

Required Parameters

For all lookups you need to include your KEY and PASSWORD so we can authenticate your request.

Required Parameter

Value

Notes

apikey

The API KEY you want to use

You can find your KEY by navigating to your account settings

password

The password to go with the API KEY

This is the Password you created when creating an account

msisdn

The number you want to check

Making a request

To make a request you can copy the following code into your browser replacing $KEY, $PASSWORD and $MSISDN with your own details.

A successful HLR Lookup of a valid number will result in one credit being removed from your balance.

Code Examples

Copy our code examples below to integrate a real time HLR Lookup into your own code

Code