This document describes typical usage of the Carrier Lookup Service API. The API can be utilized to determine the carrier for a give phone number.

URI: https://www.carrierlookupservice.com/service
SSL: Required
HTTP Method: POST

Required POST Parameters:

Parameter	Notes	Example
format	JSON is the only currently supported return object type	format=json
key	API key associated with your account	key=1234567abcdefg.12345
min	Phone number, numbers only	min=15555555555

JSON Response Object:

Field	Notes	Sample
error	If there is an issue with your account and/or request, a message will appear in the error field, otherwise it will be omitted	"error":"Credits Depleted"
result	Result of the lookup - either the carrier name, or Boolean false if not found in carrier database (i.e. not mobile).	"result":false "result":"Sprint PCS Wireless"
creditsRemain	Remaining credits associated with account. An email is sent to the registered account when credits are depleted.	"creditsRemain":"49"
min	Number submitted to lookup database (reformatted, if required)	"min":"15555555555"
carrierId	Carrier ID number	"carrierId":"5"
ip	Detected IP address of caller	"ip":"192.168.0.1"

Sample Responses:

{"creditsRemain":"49","ip":"192.168.0.1","min":"15555555555","carrierId":"5","result":"Sprint PCS Wireless"}

{"error":"Account Error"}

{"error":"Credits Depleted"}

{"error":"Incorrect Parameters - please refer to documentation and POST the correct parameters"}

{"error":"SSL Required"}