Skip to main content
GET
/
public
/
user
/
mobile_availability
/
search
Search Mobile Availability
curl --request GET \
  --url https://api.byteful.com/1.0/public/user/mobile_availability/search \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
import requests

url = "https://api.byteful.com/1.0/public/user/mobile_availability/search"

headers = {
"X-API-Private-Key": "<api-key>",
"X-API-Public-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'X-API-Private-Key': '<api-key>', 'X-API-Public-Key': '<api-key>'}
};

fetch('https://api.byteful.com/1.0/public/user/mobile_availability/search', 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.byteful.com/1.0/public/user/mobile_availability/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Private-Key: <api-key>",
"X-API-Public-Key: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.byteful.com/1.0/public/user/mobile_availability/search"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Private-Key", "<api-key>")
req.Header.Add("X-API-Public-Key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.byteful.com/1.0/public/user/mobile_availability/search")
.header("X-API-Private-Key", "<api-key>")
.header("X-API-Public-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.byteful.com/1.0/public/user/mobile_availability/search")

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

request = Net::HTTP::Get.new(url)
request["X-API-Private-Key"] = '<api-key>'
request["X-API-Public-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "data": {
    "mobile_options": [
      {
        "asn_id": 15169,
        "city_name": "San Francisco",
        "country_id": "US",
        "mobile_availability_node_count": 100,
        "subdivision_id": "CA",
        "zip_code_alias": "94107"
      }
    ],
    "total_mobile_availability_node_count": 123
  },
  "message": "Mobile Options search successful"
}

Authorizations

X-API-Private-Key
string
header
required

Private API key for user-level authentication.

X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

country_id
string

Filter by 2-character country code

subdivision_id
string

Filter by state/province identifier

city_name
string

Filter by city name

asn_id
integer

Filter by Autonomous System Number

zip_code_alias
string

Filter by postal/ZIP code

mobile_availability_node_count
integer

Filter by node count

group_by
enum<string>

Group results by specified field(s). Multiple fields separated by commas. When grouping is used, returns aggregated node counts for each group.

Available options:
country,
subdivision,
city,
asn,
zip_code
sort_by
string

Sort results by field. Add '_desc' for descending or '_asc' for ascending. Default is descending order.

Response

200 - application/json

Search mobile node count successful

data
object
message
string
Example:

"Mobile Options search successful"