Endpoints
Advanced Phone Number Lookup
Curl Request
curl --request GET \
--url 'https://scout.p.rapidapi.com/v1/numbers/search?dialcode=+16502530000' \
--header 'x-rapidapi-host: scout.p.rapidapi.com' \
--header 'x-rapidapi-key: {api_key}'
Response Body
{
"dialcode_e164": "+16502530000",
"timezone": "America/Los_Angeles",
"timezone_short": "PDT",
"timezone_utc_offset": "-08:00",
"region": "West",
"sub_region": "Pacific",
"administrative_area_level_3": null,
"administrative_area_level_2": "San Francisco County",
"administrative_area_level_1": "California",
"administrative_area_level_1_short": "CA",
"locality": "San Francisco",
"sublocality_level_1": null,
"point_of_interest": null,
"neighborhood": null,
"clli": "SNFCCASY",
"switch_assignment_date": "2005-12-28T00:00:00.000Z",
"country": "United States",
"country_short": "US",
"postal_code": "94108",
"operating_company_name": "Twilio",
"operating_company_type": "clec",
"lata": "722",
"ocn": "8826",
"line_type": "voip",
"location_routing_number": "+14159686199",
"ported": true,
"risk_rating": "highly_likely",
"risk_level": 94,
"ported_date": null,
"dialcode_invalid": false,
"dialcode_impossible": false,
"notes": "Email us at support@icehook.com with any inquiries."
}
Response Attributes
Response Key |
Type |
Description |
dialcode_e164 |
string |
The requested dialcode after parsing and formatting in the E164 international standard. |
timezone |
string |
Time Zone in which the phone number’s central office is located. |
timezone_short |
string |
Time Zone in which the phone number’s central office is located. |
timezone_utc_offset |
string |
Time Zone UTC offset. |
region |
string |
Region of the country the number is orinally located. |
sub_region |
string |
A more granular location within the Region. |
administrative_area_level_3 |
string |
Third geographic adminstrative division where the local exchange associated with the phone number is located. |
administrative_area_level_2 |
string |
Second geographic adminstrative division where the local exchange associated with the phone number is located. |
administrative_area_level_1 |
string |
Two letter abbreviation of administrative_area_level_1 as defined by the United States Postal Service. |
administrative_area_level_1_short |
string |
First geographic adminstrative division where the local exchange associated with the phone number is located. |
locality |
string |
The locality where the local exchange associated with the phone number is located. Typically the city name. |
sublocality_level_1 |
string |
The sublocality where the local exchange associated with the phone number is located. Boro of Brooklyn, for example. |
point_of_interest |
string |
A point of interest in the area where the local exchange associated with the phone number is located. |
neighborhood |
string |
The neighborhood where the local exchange associated with the phone number is located. |
clli |
string |
CLLI code (sometimes referred to as COMMON LANGUAGE Location Identifier Code and often pronounced as silly) is a Common Language Information Services identifier used within the North American telecommunications industry to specify the where the local exchange associated with the phone number is located. |
switch_assignment_date |
string |
The date in which the switch initially went into service. |
country |
string |
Name of country where the local exchange associated with the phone number is located. |
country_short |
string |
Two letter country code (ISO 3166-1 alpha-2 format) where the local exchange associated with the phone number is located. |
postal_code |
string |
Postal code where the local exchange associated with the phone number is located. |
operating_company_name |
string |
The company that provides service for the phone number. |
operating_company_type |
string |
The type of operating company associated with the phone number. |
lata |
string |
Local Access and Transport Area (LATA) represents a geographical area of the United States. |
ocn |
string |
Operating Company Number (OCN) is a 4 character ID for North American phone companies. |
line_type |
string |
The type of phone service associted with the phone number. |
location_routing_number |
string |
If ported, a Location Routing Number (or LRN) is a unique number that uses the format of a telephone number, which represents the local exchange in which the phone number is located. |
risk_rating |
string |
The likelihood a number is associated with a robo-call. |
risk_level |
integer |
The likelihood a number is associated with a robo-call on a scale of 0 to 99. Note that an invalid number will return a risk_level of 0. |
ported |
boolean |
If null, status is unknown, true means ported, false means not ported. |
ported_date |
string |
The date the number was ported. |
dialcode_invalid |
boolean |
A number that matches the NANP format, but contains an NPA that does not exist |
dialcode_impossible |
boolean |
A number that does not match the NANP format. |
notes |
string |
Relevant messages sent in response. |
Possible Operating Company Types
Operating Company Types |
Description |
cap |
Competitive Access Provider |
clec |
Competitive Local Exchange Carrier |
ethx |
Ethernet Exchange Provider |
general |
Various miscellaneous cases |
ic |
Interexchange Carrier |
ico |
Independent Company |
ilec |
Incumbent Local Exchange Carrier |
intl |
International |
ipex |
Internet Protocol Enabled Services |
l reseller |
Local Reseller |
p reseller |
Personal Communication Services Reseller |
pcs |
Personal Communications Services |
rboc |
Regional Bell Operating Company |
ulec |
Unbundled Local Exchange Carrier |
unknown |
Unknown entity |
wireless |
Wireless Provider |
w reseller |
Wireless Reseller |
Robocall/SPAM Risk Ratings and Risk Levels
Risk Rating |
Risk Level |
Description |
invalid |
0 |
Not a valid or public phone number. |
highly_unlikely |
1-20 |
Very unlikely to be a robocaller and is likely owned by a retail consumer. |
unlikely |
21-40 |
Unlikely to be a robocaller but little is known. |
possible |
41-60 |
There is no direct evidence this is a robocaller but likely belongs to a commercial entity. |
likely |
61-80 |
This is a suspicious number but not enough solid evidence to indict. |
highly_likely |
81-99 |
This is a number that has been credibly witnessed robocalling or spamming. |
Basic Phone Number Validation
Curl Request
curl --request GET \
--url 'https://scout.p.rapidapi.com/v1/numbers/search?dialcode=+16502530000' \
--header 'x-rapidapi-host: scout.p.rapidapi.com' \
--header 'x-rapidapi-key: {api_key}'
Response Body
{
"original": "+16502530000",
"sanitized": "16502530000",
"e164": "+16502530000",
"national": "6502530000",
"full_national": "(650) 253-0000",
"full_international": "+1 650-253-0000",
"country": "US",
"country_name": "United States",
"country_code_prefix": "1",
"area_code": "650",
"valid_countries": [
"US"
],
"invalid": false,
"impossible": false,
"type": "fixed_or_mobile",
"possible_types": [
"fixed_or_mobile"
]
}
Response Attributes
Response Key |
Type |
Description |
original |
string |
Number as originally received. |
sanitized |
string |
Number after being parsed. |
e164 |
string |
Number in the e164 standard format. |
national |
string |
Number as can be dialed in country. |
full_national |
string |
Number as can be dialed verbosely in country. |
full_international |
string |
Number as can be dialed internationally. |
country |
string |
Abbreviated country name. |
country_name |
string |
Full country name. |
country_code_prefix |
string |
Prefixed used to make international calls to this country. |
area_code |
string |
Area Code of the number. |
valid_countries |
array |
List of possible countries the number could be from. |
invalid |
boolean |
Number has the format to be possible but is not valid. |
impossible |
boolean |
Number does not have the format of a real phone number. |
type |
string |
Likely type of the n.umber |
possible_types |
array |
Possible types of the number. |
Docker Usage
Install Docker
- Install Docker on your computer
Input File
- Create a text file with the phone numbers you’d like to analyze
- One phone number per row
- Each number in e164 format or North American dialing format
Input File Format
Example numbers.csv file
+12125551234
+14043025678
+16023339876
Usage
Run this command to collect the results in output.csv
export SCOUT_DOMAIN=(your-rapidapi-scout-domain)
export RAPIDAPI_KEY=(your-rapidapi-scout-domain)
cat numbers.csv | docker run --env SCOUT_DOMAIN=$SCOUT_DOMAIN --env RAPIDAPI_KEY=$RAPIDAPI_KEY -i -a stdout icehook/scout-util:latest /controller.sh --run-lookups > output.csv
Output
Results in output.csv
original;dialcode_e164;timezone;timezone_short;timezone_utc_offset;region;sub_region;administrative_area_level_3;administrative_area_level_2;administrative_area_level_1;administrative_area_level_1_short;locality;sublocality_level_1;point_of_interest;neighborhood;clli;switch_assignment_date;country;country_short;postal_code;operating_company_name;operating_company_type;lata;ocn;line_type;location_routing_number;ported;risk_rating;risk_level;ported_date;dialcode_invalid;dialcode_impossible
+12125551234;+12125551234;America/New_York;EST;-05:00;Northeast;Middle Atlantic;;New York County;New York;NY;New York;Manhattan;;Midtown;NOCLLIKN;;United States;US;10011;Multiple Ocn Listing;unknown;99999;MULT;fixed_or_mobile;;false;unlikely;22;;false;false
+14043025678;+14043025678;America/New_York;EST;-05:00;South;South Atlantic;;Fulton County;Georgia;GA;Atlanta;;;Downtown;ATLNGACS;;United States;US;30303;AT&T;rboc;438;9417;fixed_or_mobile;;false;unlikely;33;;false;false
+16023339876;+16023339876;America/Phoenix;MST;-07:00;West;Mountain;;Maricopa County;Arizona;AZ;Phoenix;;;;PHNXAZUI;2010-10-06;United States;US;;CenturyLink;ipes;666;508J;fixed_line;+14804287999;true;possible;54;;false;false