SocialScrape
Get early access
Docs menu

Get started

Guides

API reference

Resources

List monitors

Beta GET /v1/monitors

GET /v1/monitors

List monitors.

  • Cost: Free
  • Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
  • Cache: Not cached.

Parameters#

This endpoint takes no parameters of its own.

Every request also accepts:

  • cursor: the cursor from the previous page (Pagination).

Example request#

Set your key in the environment first (see Authentication).

curl
curl "https://api.socialscrape.io/v1/monitors" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY"
Python
import os
import requests

res = requests.get(
    "https://api.socialscrape.io/v1/monitors",
    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
)
body = res.json()

if body["ok"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
TypeScript
const res = await fetch("https://api.socialscrape.io/v1/monitors", {
  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();

if (body.ok) {
  console.log(body.data);
} else {
  console.error(body.error.code, body.error.message);
}
n8n
{
  "nodes": [
    {
      "name": "SocialScrape List monitors",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        0,
        0
      ],
      "parameters": {
        "method": "GET",
        "url": "https://api.socialscrape.io/v1/monitors",
        "sendQuery": false,
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "x-api-key",
              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
            }
          ]
        }
      }
    }
  ],
  "connections": {}
}

Example response#

This is a sample with illustrative values. Status 200.

{
  "ok": true,
  "credits_charged": 0,
  "credits_remaining": 5000,
  "cached": false,
  "cached_at": null,
  "request_id": "req_e5c19e68e5a39343e18fba64",
  "data": {
    "object": "list",
    "items": [
      {
        "object": "monitor",
        "id": "mon_0123456789abcdef",
        "endpoint": "/v1/github/user/repositories",
        "params": {
          "handle": "torvalds"
        },
        "interval_minutes": 60,
        "webhook_url": "https://example.com/hook",
        "active": true,
        "created_at": "2026-10-29T14:00:00Z",
        "webhook_secret": null,
        "last_run_at": "2026-10-29T15:00:00Z",
        "next_run_at": "2026-10-29T16:00:00Z",
        "last_error": null
      }
    ],
    "cursor": null,
    "has_more": false
  },
  "cursor": null,
  "has_more": false
}

Response#

A list of Monitor objects in data.items, with data.cursor and data.has_more.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning

Every request can also fail with the account and platform errors listed on the Errors page.