API Documentation

1 Use your Sublime Feed credentials

The API uses HTTP Basic Authentication with your Sublime Feed email and password. No special API tokens needed.

2 Test the connection

Make a GET request to verify your credentials work:

curl -u "[email protected]:password" \
     https://sublimefeed.com/api/v2/authentication.json

A successful response returns HTTP 200 OK with an empty body.

3 Start using the API

Use your Sublime Feed email and password with any FeedBin-compatible client or integration. Set the server URL to https://sublimefeed.com/api/v2.

All API requests require HTTP Basic Authentication using your Sublime Feed credentials:

Authorization: Basic BASE64(email:password)

The API follows RFC 7617. Most HTTP clients handle this automatically.

Verify credentials are valid. Returns HTTP 200 OK on success, 401 Unauthorized on failure.

curl -u "[email protected]:password" \
     https://sublimefeed.com/api/v2/authentication.json

List all your feed subscriptions.

Query Parameters

Response

[
  {
    "id": 123,
    "created_at": "2024-01-15T10:30:00.000Z",
    "feed_id": 456,
    "title": "My Custom Feed Name",
    "feed_url": "https://example.com/feed.xml",
    "site_url": "https://example.com"
  }
]

Get details for a specific subscription.

curl -u "[email protected]:password" \
     https://sublimefeed.com/api/v2/subscriptions/123.json

Subscribe to a new feed. If multiple feeds are detected, returns 300 Multiple Choices with available options.

Request Body

{
  "feed_url": "https://example.com/feed.xml"
}

Response Status Codes

Update a subscription (e.g., rename it).

curl -X PATCH -u "[email protected]:password" \
     -H "Content-Type: application/json" \
     -d '{"title": "New Name"}' \
     https://sublimefeed.com/api/v2/subscriptions/123.json

Unsubscribe from a feed. Returns 204 No Content on success.

curl -X DELETE -u "[email protected]:password" \
     https://sublimefeed.com/api/v2/subscriptions/123.json

Get feed metadata.

Response

{
  "id": 456,
  "title": "Example Blog",
  "feed_url": "https://example.com/feed.xml",
  "site_url": "https://example.com"
}

List all entries (posts) from your subscribed feeds.

Query Parameters

Response

[
  {
    "id": 789,
    "feed_id": 456,
    "title": "Post Title",
    "url": "https://example.com/post",
    "author": "Author Name",
    "content": "
HTML content...
",
    "summary": "Plain text summary...",
    "published": "2024-01-15T10:30:00.000Z",
    "created_at": "2024-01-15T10:30:00.000Z"
  }
]

Get a single entry by ID.

curl -u "[email protected]:password" \
     https://sublimefeed.com/api/v2/entries/789.json

List entries from a specific feed. Same pagination and filter parameters as /api/v2/entries.json.

curl -u "[email protected]:password" \
     "https://sublimefeed.com/api/v2/feeds/456/entries.json?per_page=50&page=2"

Get a list of unread entry IDs.

Response

[789, 790, 791, 792, 793]

Mark entries as unread (remove read status). Returns the IDs that were changed.

Request Body

{
  "unread_entries": [789, 790, 791]
}

Maximum 1,000 IDs per request.

Mark entries as read. Returns the IDs that were marked as read.

Request Body

{
  "unread_entries": [789, 790, 791]
}

Maximum 1,000 IDs per request.

Base URL

Configure your FeedBin-compatible client to use this base URL:

https://sublimefeed.com/api/v2

Authentication

Use your Sublime Feed email address and password for HTTP Basic Authentication. Select "FeedBin" or "Feedbin" as the account type in your client if prompted.