Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jayantur13/yo-memes-jokes
Get json data (image, gif, video) from Reddit (r/)
https://github.com/jayantur13/yo-memes-jokes
memes memes-api reddit reddit-api reddit-crawler reddit-scraper
Last synced: 4 days ago
JSON representation
Get json data (image, gif, video) from Reddit (r/)
- Host: GitHub
- URL: https://github.com/jayantur13/yo-memes-jokes
- Owner: jayantur13
- License: mit
- Created: 2022-12-18T03:23:07.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T11:31:25.000Z (27 days ago)
- Last Synced: 2024-11-08T00:52:03.391Z (8 days ago)
- Topics: memes, memes-api, reddit, reddit-api, reddit-crawler, reddit-scraper
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/reddit-memes-api
- Size: 244 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
yo-memes-jokes
Get json data (gifs, images, videos) from subreddit's reddit.
Install • API Reference • Usage • Node Package • Contributing
> Logo by u/RamenFish195
>
> > Available as [node package](https://www.npmjs.com/package/reddit-memes-api),api on [RapidAPI](https://rapidapi.com/jayantur13/api/memes-from-reddit)
## Installation
Install using npm or yarn
```bash
npm install reddit-memes-api
yarn add reddit-memes-api
```
## API Reference
#### Type 1 - Get data
```http
GET /${subreddit}
```
| Parameter | Type | Description |
| :---------- | :------- | :-------------------------------------- |
| `subreddit` | `string` | **Required**. Need valid subreddit name |
#### Type 2 - Get data
```http
GET /${subreddit}/${memesare}?limit=${limit}
```
| Parameter | Type | Description |
| :---------- | :------- | :----------------------------------------- |
| `subreddit` | `string` | **Required**. Need valid subreddit name |
| `memesare` | `string` | **Required**. Need valid memesare type |
| `limit` | `int` | **Optional**. Number of results to display |
#### Type 3 - Get data
```http
GET /${subreddit}/${memesare}/${freq}?limit=${limit}
```
| Parameter | Type | Description |
| :---------- | :------- | :----------------------------------------- |
| `subreddit` | `string` | **Required**. Need valid subreddit name |
| `memesare` | `string` | **Required**. Need valid memesare type |
| `freq` | `string` | **Required**. Need valid frequency |
| `limit` | `int` | **Optional**. Number of results to display |
#### Paramaters information
| Parameter | Type | Valid Paramaters |
| :---------- | :------- | :------------------------------------------------------- |
| `subreddit` | `string` | meme, memes, joke, jokes |
| `memesare` | `string` | hot, new, top, rising |
| `freq` | `string` | now, hour, day, week, month, year, all |
| `limit` | `int` | provide according to no. of contents exists in subreddit |
## Usage/Examples
```http
https://....../memes
https://....../memes/hot
https://....../memes/hot?limit=100
https://....../memes/top/all
https://....../memes/top/all?limit=100
```
Remove .... with actual url
## Methods for node package
```
f1(subreddit)
f2(subreddit,memesare,limit)
f3(subreddit,memesare,freq,limit)
```
## Contributing
Contributions are always welcome!
See [Contributing.md](https://github.com/jayantur13/yo-memes-jokes/blob/master/CONTRIBUTING.md) for ways to get started.
Please adhere to this project's [Code Of Conduct](https://github.com/jayantur13/yo-memes-jokes/blob/master/CODE_OF_CONDUCT.md).
## Issues
Not yet discovered
## Support
Need support ? Create a new issue.Support the project, Sponsor!
## License
This project is licensed under [MIT License](https://github.com/jayantur13/yo-memes-jokes/blob/master/LICENSE)