REST API¶

Programmatically manage your alerts and retrieve event data via our REST API. All endpoints live under https://monids.com/alerts/api/, authenticated by personal token from your Preferences.

Authentication¶

All API requests require authentication using a personal token. Include the token in the request header:

Authorization: Token <YOUR_TOKEN>

You can find your personal token in the Alert Preferences page.

Endpoints¶

List My Alerts¶

curl -H "Authorization: Token <YOUR_TOKEN>" \
  https://monids.com/alerts/api/user-alerts/

Read a Single Alert¶

curl -H "Authorization: Token <YOUR_TOKEN>" \
  https://monids.com/alerts/api/user-alerts/<ALERT_ID>/

Create a New Alert¶

The request body accepts:

keyword (string) – term to monitor.
match_type – "full" or "fuzzy".
additional_keywords (optional) – list of {"value":...,"mode":...}.

curl -X POST \
  -H "Authorization: Token <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"paypal","match_type":"fuzzy",
       "additional_keywords":[
         {"value":"invoice","mode":"include"},
         {"value":"sandbox","mode":"exclude"}
       ]}' \
  https://monids.com/alerts/api/user-alerts/

Update Alert¶

curl -X PUT \
  -H "Authorization: Token <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"match_type":"full"}' \
  https://monids.com/alerts/api/user-alerts/<ALERT_ID>/

Delete Alert¶

curl -X DELETE \
  -H "Authorization: Token <YOUR_TOKEN>" \
  https://monids.com/alerts/api/user-alerts/<ALERT_ID>/

List My Events¶

curl -H "Authorization: Token <YOUR_TOKEN>" \
  https://monids.com/alerts/alert-events/?format=json

Filter Events¶

curl -H "Authorization: Token <YOUR_TOKEN>" \
  'https://monids.com/alerts/alert-events/?alert_id=<ALERT_ID>&format=json'

View Preferences¶

curl -H "Authorization: Token <YOUR_TOKEN>" \
  https://monids.com/alerts/api/preferences/

Update Preferences¶

curl -X PUT \
  -H "Authorization: Token <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"want_email":true,
       "destination_email":"me@example.com",
       "want_slack":true,
       "slack_webhook_url":"https://hooks.slack.com/services/ABC/DEF/GHI"}' \
  https://monids.com/alerts/api/preferences/

Response Format¶

All API responses are returned in JSON format. Use the ?format=json query parameter where needed to ensure JSON responses.

Rate Limiting¶

API requests are subject to rate limiting to ensure service stability. Contact support if you need higher rate limits for your use case.

REST API - Monids Documentation