Skip to main content
GET
/
v1
/
twitter
/
stream
/
filter-rules
List filter rules
curl --request GET \
  --url https://scrapebadger.com/v1/twitter/stream/filter-rules \
  --header 'x-api-key: <api-key>'
{
  "rules": [
    {
      "id": "<string>",
      "tag": "AI news tracker",
      "query": "(\"artificial intelligence\" OR \"machine learning\") min_faves:100 lang:en",
      "interval_seconds": 60,
      "max_results_per_poll": 20,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status_reason": "<string>",
      "webhook_url": "<string>",
      "webhook_secret_set": true,
      "credits_per_rule_per_day": 123,
      "pricing_tier": "1-minute"
    }
  ],
  "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 rules per page.

Required range: 1 <= x <= 100
​
status
enum<string>

Filter rules by status.

Available options:
active,
paused

Response

Successfully retrieved filter rules.

​
rules
object[]
​
total
integer

Total number of filter rules.

​
page
integer

Current page number.

​
page_size
integer

Number of items per page.