๐Ÿš€ Free API Documentation

RESTful API for checking website status and uptime. Free, no authentication required.

Quick Start

Try your first API call right now:

curl "https://www.site-down.com/api?action=check&domain=github.com"

๐Ÿ“ Base URL

https://www.site-down.com/api

โšก Rate Limits

Free Tier: 100 requests per hour per IP address

Rate limit information is included in every response under meta.rate_limit

๐Ÿ“ก Endpoints

GET Check Domain Status

Check if a website is up or down right now.

https://www.site-down.com/api?action=check&domain=example.com

Parameters

Parameter Type Required Description
action string Yes Must be "check"
domain string Yes Domain to check (e.g., "netflix.com")

Example Response

{ "success": true, "data": { "domain": "github.com", "status": "up", "http_code": 200, "response_time": 0.234, "checked_at": "2024-01-15 10:30:45", "url": "https://site-down.com/down/github.com" }, "meta": { "timestamp": 1705318245, "rate_limit": { "limit": 100, "remaining": 95, "reset": 1705321845 } } }

GET Get Trending Outages

Get list of websites currently experiencing issues.

https://www.site-down.com/api?action=trending

Parameters

Parameter Type Required Description
action string Yes Must be "trending"

Example Response

{ "success": true, "data": { "down_now": [ { "domain": "example.com", "last_status": "down", "last_code": 503, "down_count": 5 } ], "most_reported_24h": [...], "updated_at": "2024-01-15 10:30:45" } }

GET Get Historical Data

Get historical uptime data for a domain.

https://www.site-down.com/api?action=history&domain=github.com&days=7

Parameters

Parameter Type Required Description
action string Yes Must be "history"
domain string Yes Domain to get history for
days integer No Number of days (1-30, default: 7)

GET Get Uptime Statistics

Get uptime percentage and statistics for a domain.

https://www.site-down.com/api?action=stats&domain=github.com

Parameters

Parameter Type Required Description
action string Yes Must be "stats"
domain string Yes Domain to get statistics for

Example Response

{ "success": true, "data": { "domain": "github.com", "last_24_hours": { "uptime_percent": 99.8, "total_checks": 48, "outages": 0, "avg_response_time": 0.245 }, "last_7_days": {...}, "last_30_days": {...} } }

๐Ÿงช Try It Live

Test the API directly from your browser:

๐Ÿ’ป Code Examples

JavaScript / Fetch

fetch('https://www.site-down.com/api?action=check&domain=github.com') .then(response => response.json()) .then(data => { console.log(data.data.status); // "up" or "down" console.log(data.data.http_code); // HTTP status code });

Python / Requests

import requests response = requests.get( 'https://www.site-down.com/api', params={'action': 'check', 'domain': 'github.com'} ) data = response.json() print(f"Status: {data['data']['status']}") print(f"HTTP Code: {data['data']['http_code']}")

PHP / cURL

$url = 'https://www.site-down.com/api?action=check&domain=github.com'; $response = file_get_contents($url); $data = json_decode($response, true); echo "Status: " . $data['data']['status']; echo "HTTP Code: " . $data['data']['http_code'];

cURL / Command Line

curl "https://www.site-down.com/api?action=check&domain=github.com"

โš ๏ธ Error Handling

All errors return a JSON response with success: false

{ "success": false, "error": "Parameter 'domain' is required", "documentation": "https://site-down.com/api-docs" }

๐Ÿ’ก Use Cases

Need Help?

Questions about the API? Found a bug?

Email us at: api@site-down.com