1.0.1 • Published 1 year ago

reddit-memes-api v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

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}
ParameterTypeDescription
subredditstringRequired. Need valid subreddit name

Type 2 - Get data

  GET /${subreddit}/${memesare}?limit=${limit}
ParameterTypeDescription
subredditstringRequired. Need valid subreddit name
memesarestringRequired. Need valid memesare type
limitintOptional. Number of results to display

Type 3 - Get data

  GET /${subreddit}/${memesare}/${freq}?limit=${limit}
ParameterTypeDescription
subredditstringRequired. Need valid subreddit name
memesarestringRequired. Need valid memesare type
freqstringRequired. Need valid frequency
limitintOptional. Number of results to display

Paramaters information

ParameterTypeValid Paramaters
subredditstringmeme, memes, joke, jokes
memesarestringhot, new, top, rising
freqstringnow, hour, day, week, month, year, all
limitintprovide 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