List hotspots

curl --request GET \
  --url https://linkrmap.com/api/v1/hotspots \
  --header 'x-api-key: <api-key>'

import requests

url = "https://linkrmap.com/api/v1/hotspots"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://linkrmap.com/api/v1/hotspots', 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://linkrmap.com/api/v1/hotspots",
  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-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://linkrmap.com/api/v1/hotspots"

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

	req.Header.Add("x-api-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://linkrmap.com/api/v1/hotspots")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://linkrmap.com/api/v1/hotspots")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 1,
      "name": "Tony's Deli & Grocery",
      "lat": 40.7189,
      "lng": -73.9847,
      "mbps": 85,
      "risk": "Low",
      "owner": "@tony_deli",
      "note": "Password on the counter next to the register.",
      "signal": "Good",
      "network": "WiFi 5",
      "security": "WPA2",
      "uptime": "96.8%",
      "rating": "4.3/5",
      "avatar": "#FF6B6B",
      "lastUsed": "12 minutes ago",
      "locationImage": "https://images.unsplash.com/photo-1555396273-367ea4eb4db5?w=800&q=80"
    }
  ],
  "meta": {
    "total": 78,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key. Include x-api-key header with a valid key (linkr_test_* or linkr_live_*)."
}

GET

api

hotspots

List hotspots

curl --request GET \
  --url https://linkrmap.com/api/v1/hotspots \
  --header 'x-api-key: <api-key>'

import requests

url = "https://linkrmap.com/api/v1/hotspots"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://linkrmap.com/api/v1/hotspots', 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://linkrmap.com/api/v1/hotspots",
  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-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://linkrmap.com/api/v1/hotspots"

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

	req.Header.Add("x-api-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://linkrmap.com/api/v1/hotspots")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://linkrmap.com/api/v1/hotspots")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 1,
      "name": "Tony's Deli & Grocery",
      "lat": 40.7189,
      "lng": -73.9847,
      "mbps": 85,
      "risk": "Low",
      "owner": "@tony_deli",
      "note": "Password on the counter next to the register.",
      "signal": "Good",
      "network": "WiFi 5",
      "security": "WPA2",
      "uptime": "96.8%",
      "rating": "4.3/5",
      "avatar": "#FF6B6B",
      "lastUsed": "12 minutes ago",
      "locationImage": "https://images.unsplash.com/photo-1555396273-367ea4eb4db5?w=800&q=80"
    }
  ],
  "meta": {
    "total": 78,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  }
}

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key. Include x-api-key header with a valid key (linkr_test_* or linkr_live_*)."
}

Returns a paginated list of hotspots from the New York City preview dataset.

curl -H "x-api-key: linkr_test_demo01" \
  "https://linkrmap.com/api/v1/hotspots?network=WiFi%206&risk=Low&limit=5"

Query parameters

Parameter	Type	Default	Behavior
`limit`	integer	`20`	Results per page. Clamped to 1..100.
`offset`	integer	`0`	Results to skip. Minimum 0.
`risk`	string	—	Case-insensitive exact match: `Low`, `Medium`, or `High`.
`network`	string	—	Case-insensitive exact match: `WiFi 5`, `WiFi 6`, or `WiFi 6E`.
`search`	string	—	Case-insensitive substring match across `name`, `owner`, and `note`.

Only risk and network filter the list. security is returned on every record but is not filterable, and search does not cover it.

network values contain a space. URL-encode it: use ?network=WiFi%206, not ?network=WiFi 6.

Response

{
  "data": [
    {
      "id": 2,
      "name": "Apt 3R - 247 E 10th St",
      "lat": 40.7272,
      "lng": -73.9832,
      "mbps": 120,
      "risk": "Low",
      "owner": "@maria_r88",
      "note": "Strong signal from the back room. Don't hog bandwidth pls.",
      "signal": "Strong",
      "network": "WiFi 6",
      "security": "WPA3",
      "uptime": "98.1%",
      "rating": "4.6/5",
      "avatar": "#4ECDC4",
      "lastUsed": "5 minutes ago",
      "locationImage": "https://images.unsplash.com/photo-1545324418-cc1a3fa10c00?w=800&q=80"
    }
  ],
  "meta": { "total": 29, "limit": 5, "offset": 0, "hasMore": true }
}

The meta object reports the filtered total, the limit and offset in effect, and hasMore (whether offset + limit is below total).

Hotspot schema

Field	Type	Notes
`id`	number	Unique id, 1–78
`name`	string	Display name
`lat`	number	Latitude
`lng`	number	Longitude
`mbps`	number	Advertised speed
`risk`	string	`Low` · `Medium` · `High`
`owner`	string	Contributor handle, e.g. `@maria_r88`
`note`	string	Free-text note
`signal`	string	`Weak` · `Moderate` · `Good` · `Strong` · `Very Strong` · `Excellent`
`network`	string	`WiFi 5` · `WiFi 6` · `WiFi 6E`
`security`	string	`WPA2` · `WPA3` · `Open` · `WPA3-Enterprise`
`uptime`	string	String, e.g. `"96.8%"` — not a number
`rating`	string	String, e.g. `"4.3/5"` — not a number
`avatar`	string?	Optional accent color
`lastUsed`	string?	Optional relative timestamp
`locationImage`	string?	Optional image URL

uptime and rating are strings, not numbers. Parse accordingly.

Authorizations

x-api-key

string

header

required

Value must match linkr_(test|live)_[a-zA-Z0-9]{6,}. This is a shape check, not an issued credential.

Query Parameters

limit

integer

default:20

Number of results per page. Clamped to 1..100.

Required range: 1 <= x <= 100

offset

integer

default:0

Number of results to skip. Minimum 0.

Required range: x >= 0

risk

enum<string>

Filter by risk level (case-insensitive exact match).

Available options:

Low,

Medium,

High

network

enum<string>

Filter by network type (case-insensitive exact match). Values contain a space — URL-encode it, e.g. WiFi%206.

Available options:

WiFi 5,

WiFi 6,

WiFi 6E

string

Case-insensitive substring match across name, owner, and note only.

Response

A page of hotspots.

data

object[]

Show child attributes

INTRODUCTION

HOW LINKR WORKS

GETTING STARTED

MOBILE APP

SHARING A HOTSPOT

THE LINKR MAP

API REFERENCE

FOR ORGANIZATIONS

NETWORK PHILOSOPHY

FAQ

List hotspots

Query parameters

Response

Hotspot schema

Authorizations

Query Parameters

Response

​Query parameters

​Response

​Hotspot schema

Authorizations

Query Parameters

Response

Query parameters

Response

Hotspot schema