Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sametcn99/reddit-rss-api
This project appears to be a Deno-based server application that serves as an API for fetching Reddit posts from rss feed. It provides several endpoints to fetch posts from one or more subreddits.
https://github.com/sametcn99/reddit-rss-api
api deno reddit reddit-api reddit-rss rss rss-feed
Last synced: 2 days ago
JSON representation
This project appears to be a Deno-based server application that serves as an API for fetching Reddit posts from rss feed. It provides several endpoints to fetch posts from one or more subreddits.
- Host: GitHub
- URL: https://github.com/sametcn99/reddit-rss-api
- Owner: sametcn99
- Created: 2024-05-16T19:41:15.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-10T13:32:56.000Z (5 months ago)
- Last Synced: 2024-12-22T08:07:02.891Z (2 days ago)
- Topics: api, deno, reddit, reddit-api, reddit-rss, rss, rss-feed
- Language: TypeScript
- Homepage: https://reddit-rss-api.deno.dev
- Size: 70.3 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
[](https://github.com/sametcn99/reddit-rss-api/actions/workflows/deno.yml)
This project is a Deno-based server application serving as an API for fetching Reddit posts from RSS feeds. It offers multiple endpoints to retrieve posts from one or more subreddits.
## Merging Subreddits
The merge option enables you to gather data from multiple RSS feeds and consolidate them into a single response. By default, Reddit's RSS feed can return data from multiple subreddits in one request, but it has limitations on the amount of data. Setting the merge option to true prompts our API to send separate requests for each specified subreddit and then merge the results. This method yields more items compared to Reddit's default multiple subreddit RSS feed.
## Getting Started
- Initiate API usage by sending requests to [https://reddit-rss-api.deno.dev/r/{subreddits}](https://reddit-rss-api.deno.dev/r/{subreddits}).
- You can specify multiple subreddit names by separating them with a `+`.
### Combining Query Parameters
When using the API, you can combine different query parameters to tailor your request according to your needs.
## Query Parameters
- **option**: Set this query parameter to `random` to fetch a random post from the specified subreddit(s).
- **sort**: Set this query parameter to `mixed`, `asc`, or `desc` to sort the posts.
- **filter**: Set this query parameter to `image`, `video` or `video+image` to retrieve only filtered posts from the feeds.
- **merge**: Set this query parameter to `true` or `false` to merge items from multiple subreddits, useful for obtaining more posts from the feeds.
- **count**: Set this query parameter for limit items. (count={number})
## Response Types
``` typescript
type ResponseData = {
feed?: Feed;
title: string;
lastBuildDate: Date;
link: string;
feedUrl: string;
itemsLength?: number;
items: ExtractedItem[];
};
type ExtractedItem = {
title: string;
link: string;
author: string;
isoDate: Date;
feedURL: string;
id: string;
message?: string;
links?: string[];
images?: string[];
videos?: string[];
};
type Feed = {
title: string;
lastBuildDate: Date;
link: string;
feedUrl: string;
items: FeedItem[];
};
type FeedItem = {
id: string;
title: string;
link: string;
pubDate: Date;
author: string;
content: string;
contentSnippet: string;
isoDate: Date;
};
```
[ Check out example endpoints on Postman Docs.](https://documenter.getpostman.com/view/30816351/2sA3Qs8WVo)
[ Source Code](https://github.com/sametcn99/reddit-rss-api)