Skip to content

Latest commit

 

History

History
860 lines (617 loc) · 27.6 KB

File metadata and controls

860 lines (617 loc) · 27.6 KB

unifapi.RedditApi

All URIs are relative to https://api.unifapi.com

Method HTTP request Description
reddit_feed_home_get GET /reddit/feed/home Browse Reddit's anonymous home feed
reddit_feed_news_get GET /reddit/feed/news Browse Reddit's news feed
reddit_feed_popular_get GET /reddit/feed/popular Browse Reddit's popular feed
reddit_posts_id_comments_get GET /reddit/posts/{id}/comments List Reddit comments on a post
reddit_posts_id_get GET /reddit/posts/{id} Get a Reddit post by id
reddit_subreddits_name_get GET /reddit/subreddits/{name} Get a Reddit subreddit by name
reddit_trending_searches_get GET /reddit/trending-searches List Reddit's current trending search queries
reddit_users_username_comments_get GET /reddit/users/{username}/comments List Reddit comments authored by a user
reddit_users_username_get GET /reddit/users/{username} Get a Reddit user profile by username
reddit_users_username_posts_get GET /reddit/users/{username}/posts List Reddit posts authored by a user

reddit_feed_home_get

RedditFeedHomeGet200Response reddit_feed_home_get(cursor=cursor)

Browse Reddit's anonymous home feed

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_feed_home_get200_response import RedditFeedHomeGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    cursor = 'cursor_example' # str |  (optional)

    try:
        # Browse Reddit's anonymous home feed
        api_response = api_instance.reddit_feed_home_get(cursor=cursor)
        print("The response of RedditApi->reddit_feed_home_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_feed_home_get: %s\n" % e)

Parameters

Name Type Description Notes
cursor str [optional]

Return type

RedditFeedHomeGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_feed_news_get

RedditFeedHomeGet200Response reddit_feed_news_get(cursor=cursor)

Browse Reddit's news feed

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_feed_home_get200_response import RedditFeedHomeGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    cursor = 'cursor_example' # str |  (optional)

    try:
        # Browse Reddit's news feed
        api_response = api_instance.reddit_feed_news_get(cursor=cursor)
        print("The response of RedditApi->reddit_feed_news_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_feed_news_get: %s\n" % e)

Parameters

Name Type Description Notes
cursor str [optional]

Return type

RedditFeedHomeGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_feed_popular_get

RedditFeedHomeGet200Response reddit_feed_popular_get(cursor=cursor)

Browse Reddit's popular feed

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_feed_home_get200_response import RedditFeedHomeGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    cursor = 'cursor_example' # str |  (optional)

    try:
        # Browse Reddit's popular feed
        api_response = api_instance.reddit_feed_popular_get(cursor=cursor)
        print("The response of RedditApi->reddit_feed_popular_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_feed_popular_get: %s\n" % e)

Parameters

Name Type Description Notes
cursor str [optional]

Return type

RedditFeedHomeGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_posts_id_comments_get

RedditPostsIdCommentsGet200Response reddit_posts_id_comments_get(id, cursor=cursor)

List Reddit comments on a post

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_posts_id_comments_get200_response import RedditPostsIdCommentsGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    id = 'id_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List Reddit comments on a post
        api_response = api_instance.reddit_posts_id_comments_get(id, cursor=cursor)
        print("The response of RedditApi->reddit_posts_id_comments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_posts_id_comments_get: %s\n" % e)

Parameters

Name Type Description Notes
id str
cursor str [optional]

Return type

RedditPostsIdCommentsGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_posts_id_get

RedditPostsIdGet200Response reddit_posts_id_get(id)

Get a Reddit post by id

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_posts_id_get200_response import RedditPostsIdGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    id = 'id_example' # str | Reddit post fullname, e.g. `t3_1thjm1o`.

    try:
        # Get a Reddit post by id
        api_response = api_instance.reddit_posts_id_get(id)
        print("The response of RedditApi->reddit_posts_id_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_posts_id_get: %s\n" % e)

Parameters

Name Type Description Notes
id str Reddit post fullname, e.g. `t3_1thjm1o`.

Return type

RedditPostsIdGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_subreddits_name_get

RedditSubredditsNameGet200Response reddit_subreddits_name_get(name)

Get a Reddit subreddit by name

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_subreddits_name_get200_response import RedditSubredditsNameGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    name = 'name_example' # str | Subreddit slug without `r/`, e.g. `pics`.

    try:
        # Get a Reddit subreddit by name
        api_response = api_instance.reddit_subreddits_name_get(name)
        print("The response of RedditApi->reddit_subreddits_name_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_subreddits_name_get: %s\n" % e)

Parameters

Name Type Description Notes
name str Subreddit slug without `r/`, e.g. `pics`.

Return type

RedditSubredditsNameGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_trending_searches_get

RedditTrendingSearchesGet200Response reddit_trending_searches_get()

List Reddit's current trending search queries

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_trending_searches_get200_response import RedditTrendingSearchesGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)

    try:
        # List Reddit's current trending search queries
        api_response = api_instance.reddit_trending_searches_get()
        print("The response of RedditApi->reddit_trending_searches_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_trending_searches_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

RedditTrendingSearchesGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_users_username_comments_get

RedditPostsIdCommentsGet200Response reddit_users_username_comments_get(username, cursor=cursor)

List Reddit comments authored by a user

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_posts_id_comments_get200_response import RedditPostsIdCommentsGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List Reddit comments authored by a user
        api_response = api_instance.reddit_users_username_comments_get(username, cursor=cursor)
        print("The response of RedditApi->reddit_users_username_comments_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_users_username_comments_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

RedditPostsIdCommentsGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_users_username_get

RedditUsersUsernameGet200Response reddit_users_username_get(username)

Get a Reddit user profile by username

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_users_username_get200_response import RedditUsersUsernameGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    username = 'username_example' # str | 

    try:
        # Get a Reddit user profile by username
        api_response = api_instance.reddit_users_username_get(username)
        print("The response of RedditApi->reddit_users_username_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_users_username_get: %s\n" % e)

Parameters

Name Type Description Notes
username str

Return type

RedditUsersUsernameGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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

reddit_users_username_posts_get

RedditFeedHomeGet200Response reddit_users_username_posts_get(username, cursor=cursor)

List Reddit posts authored by a user

Example

  • Bearer Authentication (bearerAuth):
import unifapi
from unifapi.models.reddit_feed_home_get200_response import RedditFeedHomeGet200Response
from unifapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.unifapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = unifapi.Configuration(
    host = "https://api.unifapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = unifapi.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with unifapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = unifapi.RedditApi(api_client)
    username = 'username_example' # str | 
    cursor = 'cursor_example' # str |  (optional)

    try:
        # List Reddit posts authored by a user
        api_response = api_instance.reddit_users_username_posts_get(username, cursor=cursor)
        print("The response of RedditApi->reddit_users_username_posts_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RedditApi->reddit_users_username_posts_get: %s\n" % e)

Parameters

Name Type Description Notes
username str
cursor str [optional]

Return type

RedditFeedHomeGet200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Validation or invalid-id error -
401 Missing, invalid, disabled, revoked, or expired UnifAPI API key -
402 Insufficient workspace credits -
404 Resource not found -
429 Rate limited -
500 Internal error -
502 Source error -
503 Source unavailable -

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