Skip to main content

API Documentation

KWatch provides a RESTful API that allows you to programmatically manage your keyword monitoring alerts. This API enables you to create, read, update, and delete keyword monitoring alerts for X (Twitter), LinkedIn, Quora, Facebook, Reddit, Hacker News, and YouTube.

Authentication​

All API requests must be authenticated using an API key. You can generate API keys from your dashboard under the API section.

To authenticate your requests, include your API key in the Authorization header as a bearer token:

Authorization: Bearer your-api-key-here

Base URL​

All API endpoints are relative to the base URL:

https://api.kwatch.io

Response Codes​

The API uses standard HTTP response codes to indicate the success or failure of requests:

  • 200 OK: The request was successful
  • 201 Created: The resource was successfully created
  • 204 No Content: The request was successful and there is no content to return (used for DELETE operations)
  • 400 Bad Request: The request was invalid (e.g., invalid alert ID format, invalid keywords format)
  • 401 Unauthorized: Invalid or missing API key
  • 403 Forbidden:
    • API access not available on your current plan
    • Subscription limit reached for the platform
    • Your role does not allow you to perform this action
  • 404 Not Found: The requested resource doesn't exist
  • 429 Too Many Requests: You've exceeded the rate limit
  • 500 Internal Server Error: Something went wrong on our end

Error responses sometimes include a JSON object with an error message with more details:

{
  "error": "Error message here"
}

Available Endpoints​

The API provides the following endpoints for managing keyword alerts: