Skip to main content
POST
phone.numbers.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
country
string
required

Two-letter country code.

Pattern: ^[A-Z]{2}$
type
enum<string>

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
areaCode
string

Area code, one to four digits. A hard constraint when buying.

Pattern: ^\d{1,4}$
locality
string

City to search.

Required string length: 1 - 200
contains
string

Digits or inventory pattern to match.

Required string length: 1 - 40
sms
boolean
default:false

Search SMS-capable inventory only.

limit
integer
default:20

Number of results, 1 to 100.

Required range: 1 <= x <= 100

Response

The result

results
object[]
required

Exact matching available numbers, not reservations.

country
string
required

Two-letter country code.

Pattern: ^[A-Z]{2}$
type
enum<string>

Kind of phone number.

Available options:
local,
mobile,
national,
toll_free
monthlyPriceUsd
number

What you are charged per month, in US dollars: the current price of a new number of this country and type. It is checked again when you buy.

Required range: x >= 0