Control

The control endpoint manages the status of our scraper. On this page, we’ll dive into the different control endpoints you can use to manage the scraper status programmatically.

GET/v1/control/status/

Get scraper status

This endpoint allows you to get the current status of the scraper.

Request

GET
/v1/control/status/
curl -G https://watchdog-api.zeroruka.moe/v1/control/status/ \
  -H "Authorization: Bearer {token}" \

Response

{
  "message": "Scraper is not running",
  "value": false
}

POST/v1/control/start

Start scraper

This endpoint allows you to start the scraper. User must be authenticated through a Bearer token.

Request

POST
/v1/control/start/
curl -X PUT https://watchdog-api.zeroruka.moe/v1/control/start/ \
  -H "Authorization: Bearer {token}"

Response

{
  "message": "Starting scraper for user test1"
}

POST/v1/control/stop

Stop scraper

This endpoint allows you to stop the scraper. User must be authenticated through a Bearer token.

Request

POST
/v1/control/stop/
curl -X PUT https://watchdog-api.zeroruka.moe/v1/control/stop/ \
  -H "Authorization: Bearer {token}"

Response

{
  "message": "Stopping scraper"
}

Was this page helpful?