X
XScraper

Health Check

GET

Check if the API is running and healthy

GET /api/v1/twitter/health

Authorization

X-API-Key
string
required

Parameters

NameTypeRequiredDescription

Example Request

curl -X GET \
"https://api.xscraper.xyz/api/v1/twitter/health" \
-H "X-API-Key: "

Response

Health Status
application/json
{
  "data": {
    "status": "ok",
    "timestamp": "2025-04-19T15:49:28.824Z"
  },
  "meta": {
    "statusCode": 200,
    "timestamp": "2025-04-19T15:49:28.824Z"
  }
}

Error Responses

401 Unauthorized
{
  "statusCode": 401,
  "timestamp": "2025-04-19T15:49:28.824Z",
  "path": "/api/v1/twitter/health",
  "method": "GET",
  "message": "Invalid or expired API key"
}