API
Search the same 1.3 billion records from your own code, with premium limits: up to 100 records a search, and no waiting in line.
Get a key on TelegramYour key
Keys are paid. To get one, write to @phoneunmask on Telegram. Send it with every request, and keep it secret: whoever holds it searches on your credits.
Authorization: Bearer pum_your_key
Search
POST https://phoneunmask.com/v1/search
number |
The phone number with its country code. Put * for each digit you don't know:
+44 7700 900 1**. Spaces, dashes and brackets are ignored.
|
|---|---|
text |
Free text, matched across every field: a name, an email, a city. Up to 200 characters. |
Send a number, some text, or both.
curl https://phoneunmask.com/v1/search \
-H "Authorization: Bearer pum_your_key" \
-H "Content-Type: application/json" \
-d '{"number": "+44 7700 900 1**", "text": "smith"}'
Fastest when the first three digits are known, country code included: well under a second. With fewer known up front, a search reads through every number and can take 10 to 20 seconds.
Response
{
"records": 1,
"credits": 999,
"results": [
{
"source": "facebook_leak_all",
"fields": {
"phone": "+447700900123",
"first_name": "Jane",
"last_name": "Smith",
"city": "London"
}
}
]
}
records |
How many records came back. |
|---|---|
credits |
Credits left on your key, or null when it's unlimited. |
source |
The dataset the record comes from. |
fields |
The record. Its fields depend on the dataset: phone, names, email, city, birth date and more. |
Every record that matches comes back, up to 100. A search that matches more is refused with too_many_results
rather than cut short: add digits or text and send it again. When you give a number, only records whose phone fits it come
back.
A search uses a credit only when it finds something.
Errors
{
"error": "too_many_results",
"message": "More than 100 records match. Add digits or text to narrow it down."
}
bad_request400 |
The body isn't valid. message says why. |
|---|---|
unauthorized401 |
The key is missing, wrong or revoked. |
no_credits402 |
The key has no credits left. |
too_many_results422 |
More than 100 records match. Narrow the search. |
rate_limited429 |
More than 20 searches a minute, or 2 at once. Wait the Retry-After seconds. |
busy503 |
Search is busy. Wait the Retry-After seconds. |
timeout504 |
The search took too long. Narrow it. |
upstream_error502 |
Something failed on our side. Try again. |
Refused and failed searches never use a credit.
Limits
| Records | Up to 100 a search |
|---|---|
| Rate | 20 searches a minute, 2 at once, per key |
| Queue | None: searches start right away |
| Cost | 1 credit for each search that finds something |