Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Clarifications for exploring the API #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Clarifications for exploring the API #1

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15add7c
Add a note to allow exploring APIs
th0rgall Dec 10, 2021
a8e67d1
Update
th0rgall Dec 10, 2021
5536855
Update
th0rgall Dec 10, 2021
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
9 changes: 9 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
Readup doesn't have a public API yet but you can still poke around programmatically if you're so inclined. Readup captures a lot of interesting data and we're eager to build a proper public API for our users but in the mean time you can still make use of our private API using an HTTP client and the examples below.

**Please keep in mind these APIs absolutely WILL change in the future!** Also feel free to submit a pull request with any additional examples or corrections. Thanks!

## Exploring the available API endpoints

Since September 2021, Readup is not packaged directly as a web app anymore but as a mobile/desktop app.

It can be cumbersome to explore and inspect the network requests of a mobile/desktop app. For development purposes, you can still access a part of the Readup app in your browser by navigating to [https://readup.com/?clientType=App](https://readup.com/?clientType=App). By logging in and clicking around this SPA you will then be able to openly inspect the Readup API network requests that happen in your browser. You can visit most pages, including your own profile and My Reads, and perform actions like commenting on read articles.

Caveat: several important Readup features will not work since the expected native platform APIs are missing (for example, saving/reading/sharing articles).

## Accessing Your Readup Reading History
1. First you need to obtain an authentication cookie from Readup. Replace `EMAIL_ADDRESS` and `PASSWORD` with your Readup credentials:

Expand Down