The API provides four core operations:
- View Keywords: Retrieve the current list of keywords associated with your token.
- Results are paginated, with up to 100 entries per page.
- Ensures visibility into all active monitored terms.
- View keywords by domain: Retrieve the current list of keywords associated with your token and a certain domain (one or multiple).
- Add Keywords: Submit one or more keywords or phrases for monitoring.
- Supports up to 100 new keywords per user per day.
- Accepts single words (e.g., 'cyber') or multi-word phrases (e.g., 'cyber threats').
- Smart deduplication logic ensures that duplicate requests do not create redundant entries.
- Delete Keywords - Remove one or more keywords from monitoring.
Key Benefits
- Self-service management: Users can independently update monitoring coverage.
- Consistency & scalability: All keywords are synced across supported social media sources in our Dark Web data feeds.
Authentication
- All endpoints require a valid authentication token.
- Tokens are tied to a specific user and active Lunar / Cyber API plan.
Error Handling
| Status | Error | Description |
|---|---|---|
| 400 | Invalid input format | Request body or query is malformed |
| 401 | Access restricted | Missing required role for the token |
| 404 | Access restricted | Invalid token |
| 429 | Too many requests | Request rate exceeded |
| 429 | Daily keyword limit (100) exceeded | Add Keyword quota exceeded |