REST API

API Reference

All endpoints return JSON. Free endpoints (sources, alerts, digests) require an API key via X-API-Key header. Pro endpoints require a Pro subscription. Upgrade to Pro →

Base URLhttps://api.pulseaggregator.com

Authentication methods

JWT Bearer

Authorization: Bearer eyJ...

From /auth/login — valid 72h. Used for account actions.

X-API-Key

X-API-Key: pa_xxxxxxxxxxxx

Required for ALL API access — free & Pro endpoints.

Endpoints marked PRO require an active Pro subscription. Upgrade for $14.99/month →

Rate limits: 10 req/min on auth · 120 req/min on articles · 15-min lockout after 10 failed logins · Body capped at 64 KB

Authentication

POST/auth/register

▼

Create a new account. Returns a JWT token valid for 72 hours.

POST/auth/login

▼

Authenticate and receive a JWT token valid for 72 hours.

GET/auth/me

JWT

▼

Returns the current authenticated user, their language preference, API keys, and subscription status.

PATCH/auth/me

JWT

▼

Update user preferences including language for alerts and digests.

POST/auth/subscribe

JWT

▼

Create a NOWPayments invoice for a Pro subscription ($14.99/month). Returns a payment_url to redirect the user to.

GET/auth/subscription

JWT

▼

Check the current subscription status and expiry date for the authenticated user.

POST/auth/contact

JWT

▼

Send a support message. Returns a confirmation.

POST/auth/forgot-password

▼

Request a password reset email.

POST/auth/reset-password

▼

Reset password using the token from email.

POST/auth/api-keys

JWTPRO

▼

Generate a new API key. Requires an active Pro subscription. The raw key is shown once — store it immediately.

DELETE/auth/api-keys/{id}

JWT

▼

Revoke an API key immediately. Any requests using this key will return 401.

Articles

Search, filter, and retrieve articles from 1000+ sources. All article endpoints require an API key. Export endpoints require Pro.

GET/articles/

API KeyPRO

▼

List and search articles. Requires a Pro API key via X-API-Key header.

GET/articles/{id}

API KeyPRO

▼

Retrieve a single article by its ID. Requires Pro API key via X-API-Key header.

GET/articles/export

API KeyPRO

▼

Download matching articles as a CSV file (up to 1,000 rows). Requires a Pro API key.

GET/articles/export/json

API KeyPRO

▼

Download matching articles as a JSON file (up to 1,000 rows). Requires a Pro API key.

Sources

Inspect the 1000+ news sources PulseAggregator monitors. Requires API key.

GET/sources/

API Key

▼

List all active sources with article counts and last scraped timestamps. Requires API key.

GET/sources/runs

API Key

▼

Returns up to 500 spider run records — status, articles added, and errors. Requires API key.

Alerts & Digests

Manage keyword alerts that trigger email notifications. Free tier — requires API key for access.

POST/digests/alerts

API Key

▼

Register a keyword alert. An email is sent when matching articles are scraped. Supports language translation. Requires API key.

GET/digests/alerts

API Key

▼

List all active alerts, optionally filtered by email. Requires API key.

DELETE/digests/alerts/{id}

API Key

▼

Remove a keyword alert by its ID. Requires API key.

GET/digests/alerts/count

API Key

▼

Get the total count of alerts for a given email. Requires API key.

POST/digests/preview

API Key

▼

Generate an on-demand digest without sending an email. Defaults to last 7 days. Requires API key.

POST/digests/preview-translate

API Key

▼

Generate an on-demand digest with translated articles. Requires API key.

Payments

Check the status of a payment or view payment history. Requires a logged-in session (JWT).

GET/payments/order/{order_id}

JWT

▼

Poll the status of a NOWPayments order. Only the order owner can view it.

GET/payments/history

JWT

▼

Return all payment records for the authenticated user.

Admin

Administrative endpoints. Requires X-Admin-Secret header.

POST/admin/run-spiders

▼

Manually trigger a full spider run.

POST/admin/users

▼

Create a user account (admin only).

PATCH/admin/users/plan

▼

Update a user's plan (admin only).

GET/admin/users

▼

List all users (admin only).

Pro

Pro-only endpoints for advanced users: saved rules, smart alerts, signals, teams, webhooks, analytics, and beta features. Requires active Pro subscription.

GET/pro/saved-rules

API KeyPRO

▼

List saved rules for the current user.

POST/pro/saved-rules

API KeyPRO

▼

Create a saved rule.

DELETE/pro/saved-rules/{id}

API KeyPRO

▼

Delete a saved rule.

GET/pro/alert-rules

API KeyPRO

▼

List smart alert rules.

POST/pro/alert-rules

API KeyPRO

▼

Create a smart alert rule with AND/OR/NOT logic.

GET/pro/signals/{signal}

API KeyPRO

▼

Get articles tagged with a semantic signal.

GET/pro/webhooks

API KeyPRO

▼

List webhook configs.

POST/pro/webhooks

API KeyPRO

▼

Create a webhook for alerts.

GET/pro/teams

API KeyPRO

▼

List teams (as owner or member).

POST/pro/teams

API KeyPRO

▼

Create a new team.

GET/pro/analytics

API KeyPRO

▼

Get analytics dashboard.

GET/pro/export/with-range

API KeyPRO

▼

Export with time range filter (1-168 hours).

GET/pro/beta/explore

API KeyPRO

▼

Beta: Explore clustered articles.

Something not working? Open a support ticket →

REST API

API Reference

All endpoints return JSON. Free endpoints (sources, alerts, digests) require an API key via X-API-Key header. Pro endpoints require a Pro subscription. Upgrade to Pro →

Base URLhttps://api.pulseaggregator.com

Authentication methods

JWT Bearer

Authorization: Bearer eyJ...

From /auth/login — valid 72h. Used for account actions.

X-API-Key

X-API-Key: pa_xxxxxxxxxxxx

Required for ALL API access — free & Pro endpoints.

Endpoints marked PRO require an active Pro subscription. Upgrade for $14.99/month →

Rate limits: 10 req/min on auth · 120 req/min on articles · 15-min lockout after 10 failed logins · Body capped at 64 KB

Authentication

POST/auth/register

▼

Create a new account. Returns a JWT token valid for 72 hours.

POST/auth/login

▼

Authenticate and receive a JWT token valid for 72 hours.

GET/auth/me

JWT

▼

Returns the current authenticated user, their language preference, API keys, and subscription status.

PATCH/auth/me

JWT

▼

Update user preferences including language for alerts and digests.

POST/auth/subscribe

JWT

▼

Create a NOWPayments invoice for a Pro subscription ($14.99/month). Returns a payment_url to redirect the user to.

GET/auth/subscription

JWT

▼

Check the current subscription status and expiry date for the authenticated user.

POST/auth/contact

JWT

▼

Send a support message. Returns a confirmation.

POST/auth/forgot-password

▼

Request a password reset email.

POST/auth/reset-password

▼

Reset password using the token from email.

POST/auth/api-keys

JWTPRO

▼

Generate a new API key. Requires an active Pro subscription. The raw key is shown once — store it immediately.

DELETE/auth/api-keys/{id}

JWT

▼

Revoke an API key immediately. Any requests using this key will return 401.

Articles

Search, filter, and retrieve articles from 1000+ sources. All article endpoints require an API key. Export endpoints require Pro.

GET/articles/

API KeyPRO

▼

List and search articles. Requires a Pro API key via X-API-Key header.

GET/articles/{id}

API KeyPRO

▼

Retrieve a single article by its ID. Requires Pro API key via X-API-Key header.

GET/articles/export

API KeyPRO

▼

Download matching articles as a CSV file (up to 1,000 rows). Requires a Pro API key.

GET/articles/export/json

API KeyPRO

▼

Download matching articles as a JSON file (up to 1,000 rows). Requires a Pro API key.

Sources

Inspect the 1000+ news sources PulseAggregator monitors. Requires API key.

GET/sources/

API Key

▼

List all active sources with article counts and last scraped timestamps. Requires API key.

GET/sources/runs

API Key

▼

Returns up to 500 spider run records — status, articles added, and errors. Requires API key.

Alerts & Digests

Manage keyword alerts that trigger email notifications. Free tier — requires API key for access.

POST/digests/alerts

API Key

▼

Register a keyword alert. An email is sent when matching articles are scraped. Supports language translation. Requires API key.

GET/digests/alerts

API Key

▼

List all active alerts, optionally filtered by email. Requires API key.

DELETE/digests/alerts/{id}

API Key

▼

Remove a keyword alert by its ID. Requires API key.

GET/digests/alerts/count

API Key

▼

Get the total count of alerts for a given email. Requires API key.

POST/digests/preview

API Key

▼

Generate an on-demand digest without sending an email. Defaults to last 7 days. Requires API key.

POST/digests/preview-translate

API Key

▼

Generate an on-demand digest with translated articles. Requires API key.

Payments

Check the status of a payment or view payment history. Requires a logged-in session (JWT).

GET/payments/order/{order_id}

JWT

▼

Poll the status of a NOWPayments order. Only the order owner can view it.

GET/payments/history

JWT

▼

Return all payment records for the authenticated user.

Admin

Administrative endpoints. Requires X-Admin-Secret header.

POST/admin/run-spiders

▼

Manually trigger a full spider run.

POST/admin/users

▼

Create a user account (admin only).

PATCH/admin/users/plan

▼

Update a user's plan (admin only).

GET/admin/users

▼

List all users (admin only).

Pro

Pro-only endpoints for advanced users: saved rules, smart alerts, signals, teams, webhooks, analytics, and beta features. Requires active Pro subscription.

GET/pro/saved-rules

API KeyPRO

▼

List saved rules for the current user.

POST/pro/saved-rules

API KeyPRO

▼

Create a saved rule.

DELETE/pro/saved-rules/{id}

API KeyPRO

▼

Delete a saved rule.

GET/pro/alert-rules

API KeyPRO

▼

List smart alert rules.

POST/pro/alert-rules

API KeyPRO

▼

Create a smart alert rule with AND/OR/NOT logic.

GET/pro/signals/{signal}

API KeyPRO

▼

Get articles tagged with a semantic signal.

GET/pro/webhooks

API KeyPRO

▼

List webhook configs.

POST/pro/webhooks

API KeyPRO

▼

Create a webhook for alerts.

GET/pro/teams

API KeyPRO

▼

List teams (as owner or member).

POST/pro/teams

API KeyPRO

▼

Create a new team.

GET/pro/analytics

API KeyPRO

▼

Get analytics dashboard.

GET/pro/export/with-range

API KeyPRO

▼

Export with time range filter (1-168 hours).

GET/pro/beta/explore

API KeyPRO

▼

Beta: Explore clustered articles.

Something not working? Open a support ticket →