ScrapeBadger\RedditApi

All URIs are relative to https://scrapebadger.com, except if the operation defines another base path.

Method	HTTP request	Description
redditGetCrossPosts()	GET /v1/reddit/posts/{post_id}/duplicates	Get cross-posts
redditGetPostComments()	GET /v1/reddit/posts/{post_id}/comments	Get post comments
redditGetPostDetail()	GET /v1/reddit/posts/{post_id}	Get post detail
redditGetPostsByDomain()	GET /v1/reddit/domains/{domain}/posts	Get posts by domain
redditGetSubredditInfo()	GET /v1/reddit/subreddits/{subreddit}	Get subreddit info
redditGetSubredditPosts()	GET /v1/reddit/subreddits/{subreddit}/posts	Get subreddit posts
redditGetSubredditRules()	GET /v1/reddit/subreddits/{subreddit}/rules	Get subreddit rules
redditGetTrendingPosts()	GET /v1/reddit/posts/trending	Get trending posts
redditGetUserProfile()	GET /v1/reddit/users/{username}	Get user profile
redditGetUserSComments()	GET /v1/reddit/users/{username}/comments	Get user's comments
redditGetUserSModeratedSubreddits()	GET /v1/reddit/users/{username}/moderated	Get user's moderated subreddits
redditGetUserSPosts()	GET /v1/reddit/users/{username}/posts	Get user's posts
redditGetUserSTrophies()	GET /v1/reddit/users/{username}/trophies	Get user's trophies
redditGetWikiPageContent()	GET /v1/reddit/subreddits/{subreddit}/wiki/{page}	Get wiki page content
redditListWikiPages()	GET /v1/reddit/subreddits/{subreddit}/wiki	List wiki pages
redditNewSubreddits()	GET /v1/reddit/subreddits/new	New subreddits
redditPopularSubreddits()	GET /v1/reddit/subreddits/popular	Popular subreddits
redditRedditScraperHealthCheck()	GET /v1/reddit/health	Reddit scraper health check
redditRedditScraperHealthCheckHead()	HEAD /v1/reddit/health	Reddit scraper health check
redditSearchRedditPosts()	GET /v1/reddit/search/posts	Search Reddit posts
redditSearchSubreddits()	GET /v1/reddit/search/subreddits	Search subreddits
redditSearchUsers()	GET /v1/reddit/search/users	Search users

`redditGetCrossPosts()`

redditGetCrossPosts($post_id, $limit, $after): mixed

Get cross-posts

Get cross-posts and duplicates of a Reddit post.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$post_id = 'post_id_example'; // string
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditGetCrossPosts($post_id, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetCrossPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
post_id	string
limit	int	[optional] [default to 25]
after	string	[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetPostComments()`

redditGetPostComments($post_id, $sort, $limit, $depth): mixed

Get post comments

Get comment tree for a Reddit post.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$post_id = 'post_id_example'; // string
$sort = 'confidence'; // string | Sort: confidence, top, new, controversial, old, qa
$limit = 25; // int
$depth = 56; // int

try {
    $result = $apiInstance->redditGetPostComments($post_id, $sort, $limit, $depth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetPostComments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
post_id	string
sort	string	Sort: confidence, top, new, controversial, old, qa	[optional] [default to 'confidence']
limit	int		[optional] [default to 25]
depth	int		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetPostDetail()`

redditGetPostDetail($post_id): mixed

Get post detail

Get detailed information about a Reddit post.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$post_id = 'post_id_example'; // string

try {
    $result = $apiInstance->redditGetPostDetail($post_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetPostDetail: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
post_id	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetPostsByDomain()`

redditGetPostsByDomain($domain, $sort, $t, $limit, $after): mixed

Get posts by domain

Get Reddit posts linking to a specific domain.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$domain = 'domain_example'; // string
$sort = 'hot'; // string
$t = 'all'; // string
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditGetPostsByDomain($domain, $sort, $t, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetPostsByDomain: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
domain	string
sort	string	[optional] [default to 'hot']
t	string	[optional] [default to 'all']
limit	int	[optional] [default to 25]
after	string	[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetSubredditInfo()`

redditGetSubredditInfo($subreddit): mixed

Get subreddit info

Get detailed information about a subreddit.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subreddit = 'subreddit_example'; // string

try {
    $result = $apiInstance->redditGetSubredditInfo($subreddit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetSubredditInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subreddit	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetSubredditPosts()`

redditGetSubredditPosts($subreddit, $sort, $t, $limit, $after): mixed

Get subreddit posts

Get posts from a subreddit with sorting options.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subreddit = 'subreddit_example'; // string
$sort = 'hot'; // string | Sort: hot, new, top, rising, controversial
$t = 'all'; // string | Time filter
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditGetSubredditPosts($subreddit, $sort, $t, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetSubredditPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subreddit	string
sort	string	Sort: hot, new, top, rising, controversial	[optional] [default to 'hot']
t	string	Time filter	[optional] [default to 'all']
limit	int		[optional] [default to 25]
after	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetSubredditRules()`

redditGetSubredditRules($subreddit): mixed

Get subreddit rules

Get the rules of a subreddit.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subreddit = 'subreddit_example'; // string

try {
    $result = $apiInstance->redditGetSubredditRules($subreddit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetSubredditRules: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subreddit	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetTrendingPosts()`

redditGetTrendingPosts($sort, $t, $limit, $after): mixed

Get trending posts

Get trending posts from Reddit's front page.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sort = 'hot'; // string | Sort: hot, new, top, rising, controversial, best
$t = 'day'; // string | Time filter
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditGetTrendingPosts($sort, $t, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetTrendingPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sort	string	Sort: hot, new, top, rising, controversial, best	[optional] [default to 'hot']
t	string	Time filter	[optional] [default to 'day']
limit	int		[optional] [default to 25]
after	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetUserProfile()`

redditGetUserProfile($username): mixed

Get user profile

Get a Reddit user's profile.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string

try {
    $result = $apiInstance->redditGetUserProfile($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetUserProfile: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetUserSComments()`

redditGetUserSComments($username, $sort, $t, $limit, $after): mixed

Get user's comments

Get comments by a Reddit user.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string
$sort = 'new'; // string
$t = 'all'; // string
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditGetUserSComments($username, $sort, $t, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetUserSComments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
username	string
sort	string	[optional] [default to 'new']
t	string	[optional] [default to 'all']
limit	int	[optional] [default to 25]
after	string	[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetUserSModeratedSubreddits()`

redditGetUserSModeratedSubreddits($username): mixed

Get user's moderated subreddits

Get subreddits moderated by a user.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string

try {
    $result = $apiInstance->redditGetUserSModeratedSubreddits($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetUserSModeratedSubreddits: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetUserSPosts()`

redditGetUserSPosts($username, $sort, $t, $limit, $after): mixed

Get user's posts

Get posts submitted by a Reddit user.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string
$sort = 'new'; // string
$t = 'all'; // string
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditGetUserSPosts($username, $sort, $t, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetUserSPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
username	string
sort	string	[optional] [default to 'new']
t	string	[optional] [default to 'all']
limit	int	[optional] [default to 25]
after	string	[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetUserSTrophies()`

redditGetUserSTrophies($username): mixed

Get user's trophies

Get a user's trophy case.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$username = 'username_example'; // string

try {
    $result = $apiInstance->redditGetUserSTrophies($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetUserSTrophies: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
username	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditGetWikiPageContent()`

redditGetWikiPageContent($subreddit, $page): mixed

Get wiki page content

Get the content of a specific wiki page.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subreddit = 'subreddit_example'; // string
$page = 'page_example'; // string

try {
    $result = $apiInstance->redditGetWikiPageContent($subreddit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditGetWikiPageContent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subreddit	string
page	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditListWikiPages()`

redditListWikiPages($subreddit): mixed

List wiki pages

List all wiki pages in a subreddit.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$subreddit = 'subreddit_example'; // string

try {
    $result = $apiInstance->redditListWikiPages($subreddit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditListWikiPages: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
subreddit	string

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditNewSubreddits()`

redditNewSubreddits($limit, $after): mixed

New subreddits

Get recently created subreddits.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditNewSubreddits($limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditNewSubreddits: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
limit	int		[optional] [default to 25]
after	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditPopularSubreddits()`

redditPopularSubreddits($limit, $after): mixed

Popular subreddits

Get popular subreddits by subscriber count.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditPopularSubreddits($limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditPopularSubreddits: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
limit	int		[optional] [default to 25]
after	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditRedditScraperHealthCheck()`

redditRedditScraperHealthCheck(): mixed

Reddit scraper health check

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->redditRedditScraperHealthCheck();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditRedditScraperHealthCheck: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditRedditScraperHealthCheckHead()`

redditRedditScraperHealthCheckHead(): mixed

Reddit scraper health check

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->redditRedditScraperHealthCheckHead();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditRedditScraperHealthCheckHead: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditSearchRedditPosts()`

redditSearchRedditPosts($q, $subreddit, $sort, $t, $limit, $after): mixed

Search Reddit posts

Search Reddit posts globally or within a subreddit.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$q = 'q_example'; // string | Search query
$subreddit = 'subreddit_example'; // string | Restrict to subreddit
$sort = 'relevance'; // string | Sort: relevance, hot, top, new, comments
$t = 'all'; // string | Time: hour, day, week, month, year, all
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditSearchRedditPosts($q, $subreddit, $sort, $t, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditSearchRedditPosts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
q	string	Search query
subreddit	string	Restrict to subreddit	[optional]
sort	string	Sort: relevance, hot, top, new, comments	[optional] [default to 'relevance']
t	string	Time: hour, day, week, month, year, all	[optional] [default to 'all']
limit	int		[optional] [default to 25]
after	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditSearchSubreddits()`

redditSearchSubreddits($q, $limit, $after): mixed

Search subreddits

Search for subreddits by keyword.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$q = 'q_example'; // string | Search query
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditSearchSubreddits($q, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditSearchSubreddits: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
q	string	Search query
limit	int		[optional] [default to 25]
after	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redditSearchUsers()`

redditSearchUsers($q, $limit, $after): mixed

Search users

Search for Reddit users.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKeyAuth
$config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ScrapeBadger\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new ScrapeBadger\Api\RedditApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$q = 'q_example'; // string | Search query
$limit = 25; // int
$after = 'after_example'; // string

try {
    $result = $apiInstance->redditSearchUsers($q, $limit, $after);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedditApi->redditSearchUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
q	string	Search query
limit	int		[optional] [default to 25]
after	string		[optional]

Return type

mixed

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Uh oh!

FilesExpand file tree

RedditApi.md

Latest commit

History

RedditApi.md

File metadata and controls

ScrapeBadger\RedditApi

redditGetCrossPosts()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetPostComments()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetPostDetail()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetPostsByDomain()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetSubredditInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetSubredditPosts()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetSubredditRules()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetTrendingPosts()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetUserProfile()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetUserSComments()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetUserSModeratedSubreddits()

Example

Parameters

Return type

Authorization

HTTP request headers

redditGetUserSPosts()

Example

Parameters

Return type

Authorization

HTTP request headers

`redditGetCrossPosts()`

`redditGetPostComments()`

`redditGetPostDetail()`

`redditGetPostsByDomain()`

`redditGetSubredditInfo()`

`redditGetSubredditPosts()`

`redditGetSubredditRules()`

`redditGetTrendingPosts()`

`redditGetUserProfile()`

`redditGetUserSComments()`

`redditGetUserSModeratedSubreddits()`

`redditGetUserSPosts()`

`redditGetUserSTrophies()`

`redditGetWikiPageContent()`

`redditListWikiPages()`

`redditNewSubreddits()`

`redditPopularSubreddits()`

`redditRedditScraperHealthCheck()`

`redditRedditScraperHealthCheckHead()`

`redditSearchRedditPosts()`

`redditSearchSubreddits()`

`redditSearchUsers()`