freshrss/edge/docs/en/developers
06_GoogleReader_API| modified | Tuesday 15 September 2026 |
|---|
See Mobile access for general aspects of API access.
See also the page about our Fever compatible API for another possibility (less powerful).
There are many RSS clients that support the Fever API, but they might understand the API a bit differently.
If your favourite client doesn’t work properly with this API, please create an issue and we’ll have a look.
But we can only do that for free clients.
Before you can start using this API, you have to enable and setup API access, which is documented here,
and then reset the user’s API password.
Then point your mobile application to the greader.php address (e.g. https://freshrss.example.net/api/greader.php).
https://freshrss.example.net/api/greader.php| App | Platform | License |
|---|---|---|
| News+ with News+ Google Reader extension | Android | Closed Source (Free), partially open source |
| FeedMe 3.5.3+ | Android | Closed Source (Free) |
| Readrops | Android | GPLv3 |
| Fluent Reader Lite | Android, iOS | BSD-3 |
| Read You | Android | GPLv3 |
| FocusReader | Android | Closed Source(Free) |
| Newsflash | Linux | GPLv3 |
| lire | iOS, macOS | Closed Source |
| Newsboat 2.24+ | Linux | MIT |
| Vienna RSS | macOS | Apache-2.0 |
| Reeder Classic | macOS, iOS | Closed Source |
| FreshRSS-Notify | Firefox | Open Source |
ℹ️ See a better table of compatible clients in our main Readme.
Examples of basic queries:
1# Initial login, using API password via POST
2curl -X POST -d 'Email=alice&Passwd=Abcdef123456' 'https://freshrss.example.net/api/greader.php/accounts/ClientLogin'
3SID=alice/8e6845e089457af25303abc6f53356eb60bdb5f8
4Auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8
5
6# Examples of read-only requests
7curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
8 'https://freshrss.example.net/api/greader.php/reader/api/0/subscription/list?output=json'
9
10curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
11 'https://freshrss.example.net/api/greader.php/reader/api/0/unread-count?output=json'
12
13curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
14 'https://freshrss.example.net/api/greader.php/reader/api/0/tag/list?output=json'
15
16# Retrieve a token for requests making modifications
17curl -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
18 'https://freshrss.example.net/api/greader.php/reader/api/0/token'
198e6845e089457af25303abc6f53356eb60bdb5f8ZZZZZZZZZZZZZZZZZ
20
21# Get articles, piped to jq for easier JSON reading
22curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
23 'https://freshrss.example.net/api/greader.php/reader/api/0/stream/contents/reading-list' | jq .
24
25# Unsubscribe from a feed
26curl -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
27 -d 'ac=unsubscribe&s=feed/52' 'https://freshrss.example.net/api/greader.php/reader/api/0/subscription/edit'
ℹ️ If you are maintaining a client or planning to develop a new one, please read carefully the following pieces of advice,
as many clients start by having a very inneficient synchronisation strategy.