POST
/
api
/
v2
/
phoneNumber
/
search
/
local
/
phrase
curl --request POST \
  --url https://api.vida.dev/api/v2/phoneNumber/search/local/phrase \
  --header 'Content-Type: application/json' \
  --data '{
  "phrase": "*bitcoin*",
  "country": "US",
  "region": "TX",
  "city": "Austin"
}'
{
  "success": true,
  "message": "Success"
}

Authorizations

token
string
query
required

Vida API Token

Body

application/json
phrase
string
required

String to search for. This supports asterisk wildcards *

country
string
required

Country used for the search

region
string

Region for the search. If searching within the U.S., this will be the state

city
string

City you are searching for. If the particular city is unavailable, phone numbers from a 10 mile radius will be returned

Response

200
application/json
Successfully retrieved available numbers
success
boolean
message
string