Skip to content

jayantur13/yo-memes-jokes

Repository files navigation

Logo

yo-memes-jokes

Get json data (gifs, images, videos) from subreddit's reddit.

InstallAPI ReferenceUsageNode PackageContributing

Logo by u/RamenFish195

Available as node package,api on RapidAPI

Installation

Install using npm or yarn

  npm install reddit-memes-api

  yarn add reddit-memes-api

API Reference

Type 1 - Get data

  GET /${subreddit}
Parameter Type Description
subreddit string Required. Need valid subreddit name

Type 2 - Get data

  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

  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

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 for ways to get started.

Please adhere to this project's Code Of Conduct.

Issues

Not yet discovered

Support

Need support ? Create a new issue.Support the project, Sponsor!

License

This project is licensed under MIT License