reddit-json-api

reddit-json-api copied to clipboard

Reddit JSON API is a PHP wrapper for handling JSON information from public subreddits.

🚀 Installation

You can install the package via composer:

composer require rennokki/reddit-json-api

🙌 Usage

use Rennokki\RedditApi\Reddit;

$app = Reddit::app(
    'renoki-co/reddit-json-api',
    '2.0',
    'web',
    'someusername'
);

$subreddit = Reddit::subreddit(
    'funny', // subreddit name
    $app
);

$posts = $subreddit->get();

foreach ($posts as $post) {
    $id = $post['id'];
}

When retrieving posts, the results are wrapped in a Rennokki\RedditApi\RedditList class. This class is based on Laravel Collection and you can pipeline actions on it more easily. Please see Laravel Collections documentantion.

Pagination

For pagination purposes, you shall call nextPage() from the previous $posts:

$subreddit = Reddit::subreddit('funny', $app);

$posts = $subreddit->get();

$nextPageOfPosts = $posts->nextPage();

Sorting

Reddit allows sorting by posts type. The currently used ones are:

public static $sorts = [
    'hot', 'new', 'controversial', 'top', 'rising',
];

To apply the sorting, you should call sort():

$subreddit = Reddit::subreddit('funny', $app);

$subreddit->sort('top');

Time Filtering

Same as sorting, time filters are only a few:

public static $times = [
    'hour', 'day', 'week', 'month', 'year', 'all',
];

$subreddit = Reddit::subreddit('funny', $app);

// Top, all time sorting.
$subreddit
    ->sort('top')
    ->time('all');

Limit

By default, each call gives you 20 posts.

$subreddit = Reddit::subreddit('funny', $app);

$subreddit->setLimit(100);

Debugging

If you wish to inspect the URL that is being called, you ca do so:

$subreddit = Reddit::subreddit('funny', $app);

$subreddit
    ->setLimit(30)
    ->sort('top')
    ->time('week');

$url = $subreddit->getCallableUrl();

🐛 Testing

vendor/bin/phpunit

🤝 Contributing

Please see CONTRIBUTING for details.

🔒 Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

🎉 Credits

• Alex Renoki
• All Contributors