Search available numbers to buy
Search live carrier inventory for purchasable phone numbers, filtered by country, line type, capabilities, area code, locality, US rate center, US LATA, Twilio-style geo proximity (near_lat_lng / near_postal_code + distance), and price. Returns paginated candidates — each with its E.164 number, capabilities, monthly + one-time setup price, two-way-SMS flag, and (when resolved) rate center / state / LATA / distance-in-miles — plus a per-country compliance preflight (required / eligible) so a buyer knows up front whether documents are needed. When every carrier is unavailable or unconfigured the response carries setup_required / inventory_limited hints instead of a hard error. Pass a chosen number to POST /numbers/purchase. Read-only discovery; scoped on the numbers resource (numbers:read or numbers:write).
Authorizations
Dashboard JWT token from Clerk
Headers
Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Query Parameters
ISO 3166-1 alpha-2 country code to search (defaults to US).
Line type — one of local | mobile | toll_free.
Comma-separated required capabilities — any of sms | mms | voice | fax (e.g. sms,voice).
Digit/vanity pattern the number must contain (matched per pattern_type).
How contains matches — contains (default) | starts_with | ends_with.
NPA / national destination code to restrict to (2–5 digits).
City / locality name to restrict to (free text).
US rate center (exchange/wire-center) name to restrict to, e.g. SAN FRANCISCO (Bandwidth/Telnyx local-number-selection parity). US/CA only.
US LATA code (Local Access and Transport Area), 3-5 digits, e.g. 132 for New York Metro. Resolved from each candidate's NANP area code. US only.
Twilio-parity geo proximity — restrict to numbers whose NPA centroid is within distance miles of this point. Format <lat>,<lng>, e.g. 37.7749,-122.4194. US/CA only.
Twilio-parity geo proximity via US ZIP code — resolved to its 3-digit prefix centroid. When both near_lat_lng and near_postal_code are supplied, near_lat_lng wins.
Search radius in miles for near_lat_lng / near_postal_code (default 25, clamped to 1-500).
true to return only numbers that can both send AND receive SMS.
1-based page number (default 1).
Results per page (default 20).