Skip to main content
POST
/
api
/
v2
/
phoneNumber
/
search
/
local
/
phrase
Search for local numbers by phrase
curl --request POST \
  --url 'https://api.vida.dev/api/v2/phoneNumber/search/local/phrase?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phrase": "*bitcoin*",
  "country": "US",
  "region": "TX",
  "city": "Austin"
}
'
import requests

url = "https://api.vida.dev/api/v2/phoneNumber/search/local/phrase?token="

payload = {
    "phrase": "*bitcoin*",
    "country": "US",
    "region": "TX",
    "city": "Austin"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({phrase: '*bitcoin*', country: 'US', region: 'TX', city: 'Austin'})
};

fetch('https://api.vida.dev/api/v2/phoneNumber/search/local/phrase?token=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vida.dev/api/v2/phoneNumber/search/local/phrase?token=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phrase' => '*bitcoin*',
    'country' => 'US',
    'region' => 'TX',
    'city' => 'Austin'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vida.dev/api/v2/phoneNumber/search/local/phrase?token="

	payload := strings.NewReader("{\n  \"phrase\": \"*bitcoin*\",\n  \"country\": \"US\",\n  \"region\": \"TX\",\n  \"city\": \"Austin\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vida.dev/api/v2/phoneNumber/search/local/phrase?token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"phrase\": \"*bitcoin*\",\n  \"country\": \"US\",\n  \"region\": \"TX\",\n  \"city\": \"Austin\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.vida.dev/api/v2/phoneNumber/search/local/phrase?token=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phrase\": \"*bitcoin*\",\n  \"country\": \"US\",\n  \"region\": \"TX\",\n  \"city\": \"Austin\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "message": "Success"
}
{
  "success": false,
  "message": "A descriptive error message"
}

Authorizations

token
string
query
required

Vida API Token

Body

application/json
phrase
string
required

String to search for. This supports asterisk wildcards *

Example:

"*bitcoin*"

country
string
required

Country used for the search

Example:

"US"

region
string

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

Example:

"TX"

city
string

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

Example:

"Austin"

Response

Successfully retrieved available numbers

success
boolean
Example:

true

message
string
Example:

"Success"