Skip to content

Fixing the list of endpoints table #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: beta
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 21 additions & 63 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1185,67 +1185,25 @@ https://api.pushshift.io/reddit/submission/comment\_ids/6uey5x
List of Endpoints
=================

+---------+---------+----------+
| Endpoin | Descrip | Status |
| t | tion | |
+=========+=========+==========+
| /reddit | Search | Active |
| /search | Reddit | |
| /commen | Comment | |
| t/ | s | |
+---------+---------+----------+
| /reddit | Search | Active |
| /search | Reddit | |
| /submis | Submiss | |
| sion/ | ions | |
+---------+---------+----------+
| /reddit | Retriev | Active |
| /submis | e | |
| sion/co | comment | |
| mment\_ | ids for | |
| ids/{ba | a | |
| se36-su | submiss | |
| bmissio | ion | |
| n-id} | object | |
+---------+---------+----------+
| /reddit | Analyze | In |
| /analyz | a | Developm |
| e/user/ | Reddit | ent |
| {author | user's | |
| -name} | activit | |
| | y | |
+---------+---------+----------+
| /reddit | Analyze | In |
| /term/f | a term | Developm |
| requenc | based | ent |
| y/{term | on | |
| } | activit | |
| | y | |
+---------+---------+----------+
| /reddit | Search | In |
| /search | Both | Developm |
| /all/ | Comment | ent |
| | and | |
| | Submiss | |
| | ions | |
+---------+---------+----------+
| /reddit | Find | In |
| /trendi | out who | Developm |
| ng/peop | is | ent |
| le | trendin | |
| | g | |
| | on | |
| | Reddit | |
+---------+---------+----------+
| /reddit | Find | In |
| /search | releven | Developm |
| /links | t | ent |
| | links | |
| | being | |
| | shared | |
| | on | |
| | Reddit | |
+---------+---------+----------+

To be continued (Currently under active development) ...
+----------------------------------------------------------+-------------------------------------------------+------------------+
| Endpoint | Description | Status |
+==========================================================+=================================================+==================+
| /reddit/search/comment | Search Reddit comments | Active |
+----------------------------------------------------------+-------------------------------------------------+------------------+
| /reddit/search/submission | Search Reddit submissions | Active |
+----------------------------------------------------------+-------------------------------------------------+------------------+
| /reddit/submission/comment\_ids/{base36-submission-id} | Retrieve comment ids for a submission object | Active |
+----------------------------------------------------------+-------------------------------------------------+------------------+
| /reddit/analyze/user/{author-name} | Analyze a Reddit user's activity | In Development |
+----------------------------------------------------------+-------------------------------------------------+------------------+
| /reddit/term/frequency/{term} | Analyze a term based on activity | In Development |
+----------------------------------------------------------+-------------------------------------------------+------------------+
| /reddit/search/all/ | Search both comments and submissions | In Development |
+----------------------------------------------------------+-------------------------------------------------+------------------+
| /reddit/trending/people | Find out who is trending on Reddit | In Development |
+----------------------------------------------------------+-------------------------------------------------+------------------+
| /reddit/links | Find relevant links being shared on Reddit | In Development |
+----------------------------------------------------------+-------------------------------------------------+------------------+

To be continued ...
========================================================