Skip to main content
POST
/
keywords
curl -X POST https://scrape.st/keywords \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keywords": ["pepe", "airdrop"]
  }'
{
  "data": ["pepe", "airdrop"],
  "message": "Keywords added successfully"
}
Adds keywords to the calling API key. Once at least one keyword is registered, only events whose text contains a keyword (case-insensitive) are delivered to this key; each delivered event gains a keyword_matches array listing the keywords that hit. An API key with no keywords receives everything, unfiltered. Keywords are normalized: trimmed, lowercased, deduplicated. Limits: 100 keywords per API key, 100 characters per keyword.

Request

keywords
string[]
required
Keywords to add. Matching is a case-insensitive substring match against the event text (post text, message content, OCR-extracted image text).

Response

data
string[]
The full keyword list after the addition.
message
string
Status message describing the result
curl -X POST https://scrape.st/keywords \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "keywords": ["pepe", "airdrop"]
  }'
{
  "data": ["pepe", "airdrop"],
  "message": "Keywords added successfully"
}