Skip to main content
GET
/
api
/
kits
/
{kit_id}
/
links
/
{link_name}
Get Link
curl --request GET \
  --url https://argus.hoplynk.com/api/kits/{kit_id}/links/{link_name}
import requests

url = "https://argus.hoplynk.com/api/kits/{kit_id}/links/{link_name}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://argus.hoplynk.com/api/kits/{kit_id}/links/{link_name}', 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://argus.hoplynk.com/api/kits/{kit_id}/links/{link_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://argus.hoplynk.com/api/kits/{kit_id}/links/{link_name}"

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://argus.hoplynk.com/api/kits/{kit_id}/links/{link_name}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://argus.hoplynk.com/api/kits/{kit_id}/links/{link_name}")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
kit_id
string
required
UUID of the kit.
Link identifier (case-insensitive). Accepts:
  • Classified type: starlink, cellular, ethernet, wifi
  • Interface name: eth3, eth4

Response

Returns a single link object with the same fields as List Links, including the usage block.

Example

starlink = client.get_link(kit_id, "starlink")
cellular = client.get_link(kit_id, "cellular")

print(f"Starlink: {starlink['status']}  {starlink['latency_ms']}ms")
print(f"Month: {starlink['usage']['month_rx_gb']} GB down / {starlink['usage']['month_tx_gb']} GB up")
const starlink = await client.getLink(kitId, 'starlink')
console.log(starlink.status, `${starlink.latency_ms}ms`)
curl https://argus.hoplynk.com/api/kits/$KIT_ID/links/starlink \
  -H "X-API-Key: hlk_..."

# Or by interface name:
curl https://argus.hoplynk.com/api/kits/$KIT_ID/links/eth3 \
  -H "X-API-Key: hlk_..."
Response
{
  "name": "eth3",
  "type": "starlink",
  "status": "online",
  "isp": "SpaceX Services",
  "ip": "98.97.77.68",
  "rx_bps": 28400000,
  "tx_bps": 6200000,
  "latency_ms": 28,
  "jitter_ms": 1.4,
  "packet_loss_pct": 0.0,
  "availability_pct": 99.8,
  "usage": {
    "today_rx_gb": 4.2,
    "today_tx_gb": 1.1,
    "month_rx_gb": 87.3,
    "month_tx_gb": 22.6
  }
}