Skip to main content
POST
/
oapi
/
tweet_filter
/
add_rule
cURL
curl --request POST \
  --url https://api.twitterapi.io/oapi/tweet_filter/add_rule \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "tag": "<string>",
  "value": "<string>",
  "interval_seconds": 123
}
'
{
  "rule_id": "<string>",
  "status": "success",
  "msg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.twitterapi.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
tag
string
required

Custom tag to identify the rule.Must be set.Max length is 255

​
value
string
required

Rule to filter tweets.eg "from:elonmusk OR from:kaitoeasyapi".Must be set.Max length is 255

​
interval_seconds
number
required

Interval (in seconds) to check tweets. Min 0.05, max 86400 (24h). Default 60 if omitted.

Response

Tweet filter rule add response

​
rule_id
string
required

ID of the added rule

​
status
enum<string>
required

Status of the request.success or error

Available options:
success,
error
​
msg
string
required

Message of the request.error message