Log In Sign Up Free

API Documentation

Integrate MyRSS into your applications and workflows

MyRSS API Reference

Our REST API allows you to programmatically access and manipulate feeds, entries, and analytics data.

API Overview

The MyRSS API is organized around REST principles. All requests should be made to endpoints beginning with https://api.myrss.org/v1/. The API accepts and returns JSON encoded data.

Available Plans

API access is available on Pro and Business plans. Free accounts do not have API access.

  • Pro Plan: 1,000 requests per day
  • Business Plan: 10,000 requests per day

Note: Need higher limits? Contact our sales team for information about enterprise plans with custom rate limits.

Authentication

The MyRSS API uses API keys for authentication. You can obtain your API key from the dashboard under API settings.

Using Your API Key

Include your API key in the request headers using the X-API-Key header:

curl https://api.myrss.org/v1/feeds \ -H "X-API-Key: your_api_key_here"

API Key Security

Keep your API key secure and do not share it. If you believe your API key has been compromised, you can regenerate it from your dashboard.

Important: Never expose your API key in client-side code. API requests should always be made from your server.

Rate Limits

Rate limits vary based on your subscription plan. When you exceed your rate limit, the API will return a 429 Too Many Requests response.

Headers

Each API response includes headers that provide information about your current rate limit status:

  • X-RateLimit-Limit: The maximum number of requests you're permitted to make per day
  • X-RateLimit-Remaining: The number of requests remaining in the current rate limit window
  • X-RateLimit-Reset: The time at which the current rate limit window resets (UTC epoch seconds)

Error Handling

The API uses conventional HTTP response codes to indicate the success or failure of an API request.

HTTP Status Codes

  • 200 OK - The request was successful
  • 201 Created - The resource was successfully created
  • 400 Bad Request - The request was invalid
  • 401 Unauthorized - Authentication failed
  • 403 Forbidden - The request is not allowed
  • 404 Not Found - The resource was not found
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Something went wrong on our end

Error Response Format

When an error occurs, the response body will contain a JSON object with error details:

{ "error": { "code": "invalid_request", "message": "The request was invalid", "details": "The 'title' field is required" } }

List Feeds

Retrieve a list of all feeds associated with your account.

GET
/feeds

Query Parameters

Parameter Type Description
pageoptional integer Page number for pagination. Default is 1.
limitoptional integer Number of items per page. Default is 20, maximum is 100.
sortoptional string Sort field (created_at, updated_at, title). Default is created_at.
orderoptional string Sort order (asc, desc). Default is desc.

Example Request

curl https://api.myrss.org/v1/feeds?limit=10&sort=title&order=asc \ -H "X-API-Key: your_api_key_here"

Example Response

{ "data": [ { "id": "feed_123456", "title": "My Tech Blog", "description": "The latest in technology news and insights", "url": "https://myrss.org/techblog", "item_count": 42, "created_at": "2025-06-01T12:00:00Z", "updated_at": "2025-07-15T08:30:00Z" }, { "id": "feed_789012", "title": "Weekly Podcast", "description": "Weekly discussions on current events", "url": "https://myrss.org/podcast", "item_count": 28, "created_at": "2025-05-15T10:00:00Z", "updated_at": "2025-07-12T14:20:00Z" } ], "meta": { "current_page": 1, "total_pages": 3, "total_count": 23, "per_page": 10 } }

Get Feed

Retrieve details about a specific feed.

GET
/feeds/{feed_id}

Path Parameters

Parameter Type Description
feed_idrequired string Unique identifier of the feed

Example Request

curl https://api.myrss.org/v1/feeds/feed_123456 \ -H "X-API-Key: your_api_key_here"

Example Response

{ "data": { "id": "feed_123456", "title": "My Tech Blog", "description": "The latest in technology news and insights", "url": "https://myrss.org/techblog", "language": "en-us", "custom_domain": null, "image_url": "https://myrss.org/images/feeds/feed_123456.png", "item_count": 42, "subscribers_count": 1245, "author": { "name": "John Smith", "email": "[email protected]" }, "created_at": "2025-06-01T12:00:00Z", "updated_at": "2025-07-15T08:30:00Z", "last_published_at": "2025-07-15T08:30:00Z" } }