Link Checker

×

API Access

Public REST API for running URL checks against school content filters.

Base URL

https://getuwu.christmas/api/v1

Authentication

None. All endpoints are open. CORS is enabled for every origin.

Endpoints

Examples

cURL — check a single filter:

curl "https://getuwu.christmas/api/v1/check?url=hide.me&filter=lightspeed"

cURL — POST a JSON body:

curl -X POST https://getuwu.christmas/api/v1/check \
  -H "Content-Type: application/json" \
  -d '{"url":"reddit.com","filter":"goguardian"}'

JavaScript — check all filters:

const res = await fetch(
  "https://getuwu.christmas/api/v1/check?url=" +
  encodeURIComponent("hide.me")
);
const data = await res.json();
console.log(data.results);

Python — check one filter:

import requests
r = requests.get(
    "https://getuwu.christmas/api/v1/check",
    params={"url": "hide.me", "filter": "lightspeed"}
)
print(r.json())

Screenshot — save to file:

curl -o shot.png \
  "https://getuwu.christmas/api/v1/screenshot?url=example.com"

Response shape

{
  "target": "hide.me",
  "results": [
    {
      "filter": "lightspeed",
      "label": "Lightspeed",
      "ms": 397,
      "category": "Security - Proxy",
      "blocked": true,
      "ok": true
    }
  ]
}

Each result returns blocked: true (filter would block), blocked: false (allowed), or blocked: null (informational only). Errors are reported as { error: "..." } on the result row.