API Reference Overview

Fresh

The RSS.app API is a RESTful HTTP API. All requests are sent to the base URL below and must use HTTPS.

Base URL

https://api.rss.app

All endpoint paths are prefixed with the API version. The current version is v1:

https://api.rss.app/v1/feeds
https://api.rss.app/v1/bundles

Authentication

All requests require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY:YOUR_API_SECRET

Your API Key and API Secret are available in the RSS.app account settings under the API section. See the Authentication SOP for setup instructions.

Request Format

All request bodies must be JSON. Set the Content-Type header accordingly:

Content-Type: application/json

GET requests do not require a Content-Type header.

Response Format

All responses are JSON. Successful responses return the requested resource or collection directly — there is no top-level data wrapper.

A single resource response:

{
  "id": "feed_abc123",
  "title": "Example Feed",
  "source_url": "https://example.com",
  ...
}

A collection response is a JSON array:

[
  { "id": "feed_abc123", ... },
  { "id": "feed_def456", ... }
]

Error Format

Errors follow a consistent structure:

{
  "message": "Human-readable error message",
  "statusCode": 400,
  "errors": [
    {
      "title": "Specific error title",
      "code": "machine_readable_code"
    }
  ]
}

See the Error Codes reference for a full list of HTTP status codes and their meanings.

Pagination

List endpoints (GET /v1/feeds, GET /v1/bundles) support offset-based pagination:

Parameter	Default	Max	Description
limit	10	100	Results per page
offset	0	—	Results to skip

GET /v1/feeds?limit=25&offset=50

When the response array length is less than limit, you have reached the last page.

Resource Overview

Resource	Description
Feeds	Individual RSS feeds created from URLs, keywords, or RSS sources
Bundles	Named groups of feeds that expose a combined RSS URL
Webhooks	Real-time event notifications for feed updates

Versioning

The current API version is v1. The version is included in every endpoint path. RSS.app does not perform automatic version negotiation — your requests must include the version prefix explicitly.