API Reference

Changedetection.io API

Drive your changedetection.io from other systems with our RESTful API.

Use the API key that is generated for you found at Settings > API

Example

Request

curl -H "x-api-key: 1a8cbe83a28440010bd7638bea6d307d" http://localhost:4000/api/v1/watch/b955b13a-aaca-4c68-9ccc-3b3552d83f4c

Response

{"body": "", "check_unique_lines": false, "check_count": 11, "consecutive_filter_failures": 0, "extract_text": [], "extract_title_as_title": false, "fetch_backend": "html_requests", "filter_failure_notification_send": true, "has_ldjson_price_data": true, "track_ldjson_price_data": "accepted", "headers": {}, "ignore_text": [], "include_filters": [], "last_checked": 1670588619, "last_error": false, "last_viewed": 1670533199, "method": "GET", "notification_body": "", "notification_format": "System default", "notification_muted": false, "notification_title": "", "notification_screenshot": false, "notification_urls": [], "paused": false, "previous_md5": "4131b6fc7f329879de5f0928846d2570", "proxy": null, "subtractive_selectors": [], "tag": "", "text_should_not_be_present": [], "time_between_check": {"weeks": null, "days": null, "hours": null, "minutes": null, "seconds": null}, "title": "", "trigger_text": [], "url": "https://www.exito.com/consola-playstation-5-ps5-digital-edition-sony-101112640-mp/p", "uuid": "b955b13a-aaca-4c68-9ccc-3b3552d83f4c", "webdriver_delay": null, "webdriver_js_execute_code": "", "ignore_status_codes": false, "browser_steps": [{"operation": null, "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}, {"operation": "Choose one", "selector": "", "optional_value": ""}], "save_button": true, "last_notification_error": false, "last_check_status": 200, "fetch_time": 1.44, "history_n": 2}

Endpoints

http://localhost/api/v1/watch

GET - Get a list of existing watches, append ?recheck_all=1 to force recheck of all

POST - Create a new watch '{"url": "https://my-nice.com", "tag": "optional one, optional two" , "title": "optional title"}'

http://localhost/api/v1/watch/<string:uuid>

GET - Get information about a single watch, excluding the history list (can be large) , append ?recheck=1 to force recheck

DELETE - Delete a single watch by UUID

http://localhost/api/v1/watch/<string:uuid>/history

GET - List all history (timestamps) of watch by UUID

http://localhost/api/v1/watch/<string:uuid>/history/<string:timestamp>

GET - Retrieve a snapshot by timestamp or latest for latest

API Access

A new API key section is added in global config

Always include x-api-key header value if enabled, copy/paste the key from the global settings page