List Stream Monitors

List all stream monitors for the authenticated API key. Supports pagination and optional filtering by status.

GET /v1/twitter/stream/monitors

List stream monitors

cURL

curl --request GET \
  --url https://scrapebadger.com/v1/twitter/stream/monitors \
  --header 'x-api-key: <api-key>'

import requests

url = "https://scrapebadger.com/v1/twitter/stream/monitors"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://scrapebadger.com/v1/twitter/stream/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://scrapebadger.com/v1/twitter/stream/monitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://scrapebadger.com/v1/twitter/stream/monitors"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://scrapebadger.com/v1/twitter/stream/monitors")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scrapebadger.com/v1/twitter/stream/monitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "monitors": [
    {
      "id": "<string>",
      "name": "Tech Leaders Monitor",
      "usernames": [
        "elonmusk",
        "sama"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status_reason": "<string>",
      "webhook_url": "<string>",
      "webhook_secret_set": true,
      "filter_types": [],
      "credits_per_account_per_day": 123,
      "estimated_credits_per_day": 123,
      "pricing_tier": "Standard"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123
}

{
  "error": "Invalid or missing API key"
}

{
  "error": "Insufficient credits"
}

{
  "error": "Rate limit exceeded. Please retry after a short delay."
}

Authorizations

x-api-key · string · header · required

Your ScrapeBadger API key. You can find this in your dashboard at https://scrapebadger.com/dashboard/api-keys.

Query Parameters

page · integer · default: 1

Page number for pagination.

Required range: x >= 1

page_size · integer · default: 20

Number of monitors per page.

Required range: 1 <= x <= 100

status · enum<string>

Filter monitors by status.

Available options: active, paused

Response

200

application/json

Successfully retrieved stream monitors.

monitors · object[]

Show child attributes

total · integer

Total number of monitors.

page · integer

Current page number.

page_size · integer

Number of items per page.