Skip to main content
GET
/
v1
/
twitter
/
stream
/
monitors
List stream monitors
curl --request GET \
  --url https://scrapebadger.com/v1/twitter/stream/monitors \
  --header 'x-api-key: <api-key>'
{
  "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
}

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

Successfully retrieved stream monitors.

​
monitors
object[]
​
total
integer

Total number of monitors.

​
page
integer

Current page number.

​
page_size
integer

Number of items per page.