Inoreader Developer Portal

https://www.inoreader.com/developers
Admin
The Inoreader Developer Portal provides access to the Inoreader API, allowing developers to...
Tokens:21,461
Snippets:137
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### oEmbed API Request Examples

Source: https://www.inoreader.com/developers/oembed

Examples of GET requests to the oEmbed API endpoint. The 'url' parameter must be URL-encoded. Optional 'maxwidth' and 'maxheight' parameters can be provided.

```http
https://www.inoreader.com/oembed/api/article?url=http%3A%2F%2Fwww.inoreader.com%2Farticle%2F3a9c6e7f31414b1c-how-to-prevent-spotify-from-wasting-disk-space&format=json
```

```http
https://www.inoreader.com/oembed/api/article?url=http%3A%2F%2Fwww.inoreader.com%2Farticle%2F3a9c6e7f31414b1c-how-to-prevent-spotify-from-wasting-disk-space&format=json&maxwidth=400&maxheight=500
```

--------------------------------

### Sample API Request (User Info)

Source: https://www.inoreader.com/developers/oauth

An example of an authenticated GET request to the user-info endpoint using the Bearer token.

```HTTP
GET /reader/api/0/user-info HTTP/1.1
Host: www.inoreader.com
Content-length: 0
Authorization: Bearer ecd53979fc1917b66b16cd2c65f305943ed386f0
```

--------------------------------

### Example Sort ID String

Source: https://www.inoreader.com/developers/sortids

This is an example of a sort ID string as it appears in the subscription-ordering pair. It needs to be parsed to determine the order of feeds and folders.

```text
0018292200233381002094C100085B3A00007D1E000CAA76000859980000BD680000165D00016D1E001CE9620000BCB30011C20C000154F60001AB4D00127963001F609E0022AA500022C9D000215FEA002267B300064FD7003F4DFC
```

--------------------------------

### Get User Information

Source: https://www.inoreader.com/developers/user-info

This endpoint returns basic information about the logged-in user. No specific setup or imports are required beyond making an HTTP GET request to the specified URL.

```http
GET https://www.inoreader.com/reader/api/0/user-info
```

```json
{
  "userId": "1001921515",
  "userName": "BenderIsGreat",
  "userProfileId": "1001921515",
  "userEmail": "bender@inoreader.com",
  "isBloggerUser": true,
  "signupTimeSec": 1163850013,
  "isMultiLoginEnabled": false,
}
```

--------------------------------

### oEmbed XML Response Example

Source: https://www.inoreader.com/developers/oembed

An example of an oEmbed response in XML format, containing details about the embedded content.

```xml
<oembed>
    <type>rich</type>
    <version>1.0</version>
    <provider_name>Inoreader</provider_name>
    <provider_url>https://www.inoreader.com</provider_url>
    <author_name>Ars Technica</author_name>
    <title>John Wick Ch. 2: The righteous violence we so desperately need right now</title>
    <url>
        https://www.inoreader.com/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now
    </url>
    <width>400</width>
    <height>500</height>
    <html>
        <iframe src="https://www.inoreader.com/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now" scrolling="yes" frameborder="0" allowtransparency="true" style="position:absolute;overflow-x:hidden;border:none;max-width:1000px;max-height:1200px;display:block;width:100%;height:100%;"></iframe>
    </html>
</oembed>
```

--------------------------------

### oEmbed JSON Response Example

Source: https://www.inoreader.com/developers/oembed

An example of an oEmbed response in JSON format, providing embeddable content details.

```json
{
    "type": "rich",
    "version": "1.0",
    "provider_name": "Inoreader",
    "provider_url": "https://www.inoreader.com",
    "author_name": "Ars Technica",
    "title": "John Wick Ch. 2: The righteous violence we so desperately need right now",
    "url": "https://www.inoreader.com/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now",
    "width": "1000",
    "height": "1200",
    "html": "<iframe src=\"https://www.inoreader.com/article/3a9c6e7f3159059e-john-wick-ch-2-the-righteous-violence-we-so-desperately-need-right-now\" scrolling=\"yes\" frameborder=\"0\" allowtransparency=\"true\" style=\"position:absolute;overflow-x:hidden;border:none;max-width:1000px;max-height:1200px;display:block;width:100%;height:100%;\">
</iframe>"
}
```

--------------------------------

### Example JSON Response Structure

Source: https://www.inoreader.com/developers/stream-contents

Illustrates the structure of the JSON response when fetching stream contents. Includes metadata and a list of articles.

```JSON
{
   "direction":"ltr",
   "id":"user\/-\/state\/com.google\/annotated",
   "title":"Annotated",
   "description":"",
   "self":{
      "href":"https:\/\/www.inoreader.com\/reader\/api\/0\/stream\/contents\/"
   },
   "updated":1618212570,
   "updatedUsec":"1618212570146918",
   "items":[
      {
         "crawlTimeMsec":"1618211779000",
         "timestampUsec":"1618211779000000",
         "id":"tag:google.com,2005:reader\/item\/0000000693c3bc0c",
         "categories":[
            "user\/1005921515\/state\/com.google\/reading-list",
            "user\/1005921515\/state\/com.google\/read",
            "user\/1005921515\/label\/Tech"
         ],
         "title":"Windows and Linux devices are under attack by a new cryptomining worm",
         "published":1617969599,
         "updated":1617990787,
         "canonical":[
            {
               "href":"https:\/\/arstechnica.com\/?p=1755573"
            }
         ],
         "alternate":[
            {
               "href":"https:\/\/arstechnica.com\/?p=1755573",
               "type":"text\/html"
            }
         ],
         "summary":{
            "direction":"ltr",

```

--------------------------------

### Mark Articles as Read

Source: https://www.inoreader.com/developers/edit-tag

Use this example to mark multiple articles as read simultaneously. Ensure the article IDs are correctly formatted.

```HTTP
https://www.inoreader.com/reader/api/0/edit-tag?a=user/-/state/com.google/read&i=12345678&i=12345679
```

--------------------------------

### Fetch Folders and Tags List

Source: https://www.inoreader.com/developers/tag-list

Use this endpoint to get a list of all folders and tags for the authenticated user. Optional parameters can be used to include item types and unread counts.

```json
{
  "tags": [
    {
      "id": "user/1005921515/state/com.google/starred",
      "sortid": "FFFFFFFF"
    },
    {
      "id": "user/1005921515/state/com.google/broadcast",
      "sortid": "FFFFFFFE"
    },
    {
      "id": "user/1005921515/state/com.google/blogger-following",
      "sortid": "FFFFFFFD"
    },
    {
      "id": "user/1005921515/label/Google",
      "sortid": "BEBC2063",
      "type": "tag",
      "unread_count": 0,
      "unseen_count": 0
    },
    {
      "id": "user/1005921515/label/DIY",
      "sortid": "BECC0BE1",
      "type": "folder"
    },
    {
      "id": "user/1005921515/label/Feedly active search",
      "sortid": "BECC502C",
      "type": "active_search",
      "unread_count": 0,
      "unseen_count": 0
    },
    {
      "id": "user/1001637110/label/org-1000053521f-test",
      "sortid": "BF8E576A",
      "type": "folder",
      "organization_id": "1000053521f"
    }
  ]
}
```

--------------------------------

### Retrieve Stream Preferences

Source: https://www.inoreader.com/developers/preference-list

Use this endpoint to get a list of folders and the root subscription folder. The response includes preference settings like subscription ordering.

```json
{
  "streamprefs": {
    "user/1005921515/state/com.google/root": [{
      "id": "subscription-ordering",
      "value": "BEC24025BEBD5A25BEBC2063001C459B0018F45DBEBC6F05BEBD8D55BEBE3252001490BF00152A6A000B633F000004F4000004F5000005ED00002F2C0000A08400003530000004F7000004F8000004F9000005F1000004FC000004FD00001A880026A51D00273E9C00246F840026A4EC0027C05A00275F3D0026BC73BEC008A0BEC06A88BEC1E2F4004244DC00367C4E005AFDFA00611F4800350BD4004DCBB0002F10310041A5B60050E0A80068AADF00367ED200654CCC0051B8B7005149A5005B5EE40036142500573E6400576D67002ADA36002D269F00350B7F0037857E0038FA10003F07F30060D189005A9DF00063C962005D8E67006A1A93006B28B4006C2A24006DD240006DCF44006DCF41006DE4520073868000717B7D007179F00072425300717AB400710C5F00717C37006F3C1C0073885400738859BEC2D61900713B5D00738858006E50B400714BED0073893400717ABB007388570073892700711266"
        }],
    "user/1005921515/label/MIT": [{
      "id": "is-expanded",
      "value": "true"
        }, {
      "id": "subscription-ordering",
      "value": "00005C9F0000425D00005CA100005CA000005CA300005C9E"
        }],
    "user/1005921515/label/Testing": [{
      "id": "is-expanded",
      "value": "true"
        }, {
      "id": "subscription-ordering",
      "value": "0018292200233381002094C100085B3A00007D1E000CAA76000859980000BD680000165D00016D1E001CE9620000BCB30011C20C000154F60001AB4D00127963001F609E0022AA500022C9D000215FEA002267B300064FD7003F4DFC"
        }]
  }
}
```

--------------------------------

### Get Stream Preference List

Source: https://www.inoreader.com/developers/preference-list

Fetches a list of all stream preferences for the authenticated user, including folders and the root subscription tree.

```APIDOC
## GET /reader/api/0/preference/stream/list

### Description
Retrieves a list of folders and the system `user/-/state/com.google/root` folder, which represents the root level of the subscriptions tree. This call also returns preference settings for each stream, such as subscription ordering and expansion state.

### Method
GET

### Endpoint
https://www.inoreader.com/reader/api/0/preference/stream/list

### Response
#### Success Response (200)
- **streamprefs** (object) - An object containing stream preferences, where keys are stream IDs (e.g., folder IDs, root folder) and values are arrays of preference objects.
  - **id** (string) - The identifier for the preference (e.g., "subscription-ordering", "is-expanded").
  - **value** (string) - The value of the preference.

### Response Example
{
  "streamprefs": {
    "user/1005921515/state/com.google/root": [
      {
        "id": "subscription-ordering",
        "value": "BEC24025BEBD5A25BEBC2063001C459B0018F45DBEBC6F05BEBD8D55BEBE3252001490BF00152A6A000B633F000004F4000004F5000005ED00002F2C0000A08400003530000004F7000004F8000004F9000005F1000004FC000004FD00001A880026A51D00273E9C00246F840026A4EC0027C05A00275F3D0026BC73BEC008A0BEC06A88BEC1E2F4004244DC00367C4E005AFDFA00611F4800350BD4004DCBB0002F10310041A5B60050E0A80068AADF00367ED200654CCC0051B8B7005149A5005B5EE40036142500573E6400576D67002ADA36002D269F00350B7F0037857E0038FA10003F07F30060D189005A9DF00063C962005D8E67006A1A93006B28B4006C2A24006DD240006DCF44006DCF41006DE4520073868000717B7D007179F00072425300717AB400710C5F00717C37006F3C1C0073885400738859BEC2D61900713B5D00738858006E50B400714BED0073893400717ABB007388570073892700711266"
      }
    ],
    "user/1005921515/label/MIT": [
      {
        "id": "is-expanded",
        "value": "true"
      },
      {
        "id": "subscription-ordering",
        "value": "00005C9F0000425D00005CA100005CA000005CA300005C9E"
      }
    ],
    "user/1005921515/label/Testing": [
      {
        "id": "is-expanded",
        "value": "true"
      },
      {
        "id": "subscription-ordering",
        "value": "0018292200233381002094C100085B3A00007D1E000CAA76000859980000BD680000165D00016D1E001CE9620000BCB30011C20C000154F60001AB4D00127963001F609E0022AA500022C9D000215FEA002267B300064FD7003F4DFC"
      }
    ]
  }
}
```

--------------------------------

### Authentication via Request Parameters

Source: https://www.inoreader.com/developers/app-auth

If you cannot control request headers, you can pass App ID and App Key as request parameters in GET or POST requests.

```APIDOC
## GET /reader/api/0/user-info?AppId=1000001414&AppKey=kk18irxGeoXA5wyFg9U1PpTuabDu2WWG

### Description
This example shows how to include App ID and App Key as query parameters for API authentication.

### Method
GET

### Endpoint
/reader/api/0/user-info

### Query Parameters
- **AppId** (string) - Required - Your application's unique ID.
- **AppKey** (string) - Required - Your application's secret key.
```

--------------------------------

### Get User Info

Source: https://www.inoreader.com/developers/user-info

This method returns basic information about the logged in user.

```APIDOC
## GET /user-info

### Description
This method returns basic information about the logged in user.

### Endpoint
`https://www.inoreader.com/reader/api/0/user-info`

### Response
#### Success Response (200)
- **userId** (string) - The unique identifier for the user.
- **userName** (string) - The username of the logged-in user.
- **userProfileId** (string) - The user's profile ID.
- **userEmail** (string) - The email address associated with the user account.
- **isBloggerUser** (boolean) - Indicates if the user is a blogger.
- **signupTimeSec** (integer) - The time of signup in seconds since the epoch.
- **isMultiLoginEnabled** (boolean) - Indicates if multi-login is enabled for the user.

#### Response Example
```json
{
  "userId": "1001921515",
  "userName": "BenderIsGreat",
  "userProfileId": "1001921515",
  "userEmail": "bender@inoreader.com",
  "isBloggerUser": true,
  "signupTimeSec": 1163850013,
  "isMultiLoginEnabled": false
}
```
```

--------------------------------

### Parsed Sort IDs

Source: https://www.inoreader.com/developers/sortids

The example sort ID string broken down into individual 8-character sort IDs, representing the desired order of feeds or folders.

```text
00182922
00233381
002094C1
00085B3A
00007D1E
000CAA76
00085998
0000BD68
0000165D
00016D1E
001CE962
0000BCB3
0011C20C
000154F6
0001AB4D
00127963
001F609E
0022AA50
0022C9D0
00215FEA
002267B3
00064FD7
003F4DFC
```

--------------------------------

### ClientLogin Authentication Request

Source: https://www.inoreader.com/developers/auth

This is an example of a POST request to the ClientLogin endpoint for user authentication. It requires Email and Passwd parameters. Note that this method is deprecated for new integrations.

```http
> POST /accounts/ClientLogin HTTP/1.1
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.14.0.0 zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: www.inoreader.com
> Accept: */*
> Content-Length: 27
> Content-Type: application/x-www-form-urlencoded
>
```

--------------------------------

### Authenticate with Request Parameters

Source: https://www.inoreader.com/developers/app-auth

Include your App ID and App Key as 'AppId' and 'AppKey' parameters in your GET or POST requests. Use this method if you cannot control request headers, such as in browser extensions.

```url
https://www.inoreader.com/reader/api/0/user-info?AppId=1000001414&AppKey=kk18irxGeoXA5wyFg9U1PpTuabDu2WWG
```

--------------------------------

### ClientLogin Service Unavailable Response

Source: https://www.inoreader.com/developers/auth

An example of a 503 Service Temporarily Unavailable response from the ClientLogin endpoint, indicating the backend is unreachable. This response contains no content.

```http
> POST /accounts/ClientLogin HTTP/1.1
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.14.0.0 zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: www.inoreader.com
> Accept: */*
> Content-Length: 27
> Content-Type: application/x-www-form-urlencoded
>
< HTTP/1.1 503 Service Temporarily Unavailable
< Date: Wed, 03 Jul 2013 11:01:32 GMT
< Server: Apache
< X-Powered-By: PHP/5.4.16
< Vary: Accept-Encoding,User-Agent
< Content-Length: 0
< Connection: close
< Content-Type: text/html; charset=UTF-8
```

--------------------------------

### Get Folders and Tags List

Source: https://www.inoreader.com/developers/tag-list

Retrieves a list of all folders and tags associated with the user's account. This method can also fetch item types and unread counts.

```APIDOC
## GET /reader/api/0/tag/list

### Description
Fetches the current folders and tags for the user. This method can optionally include item types and unread counts.

### Method
GET

### Endpoint
https://www.inoreader.com/reader/api/0/tag/list

### Parameters
#### Query Parameters
- **types** (string) - Optional - Set to `1` to get the item type. Possible values: `tag`, `folder`, or `active_search`.
- **counts** (string) - Optional - Set to `1` to get unread counts for tags and active searches.
- **team_assets** (string) - Optional - Set to `1` to get team folders and tags.

### Response
#### Success Response (200)
- **tags** (array) - An array of tag and folder objects.
  - **id** (string) - The unique item ID.
  - **sortid** (string) - A sort ID.
  - **type** (string) - The type of the item (e.g., `tag`, `folder`, `active_search`). Only applicable to tags and active searches.
  - **unread_count** (integer) - The number of unread items. Only applicable to tags and active searches.
  - **unseen_count** (integer) - The number of unseen items (new since last visit). Only applicable to tags and active searches.
  - **organization_id** (string) - Present if the folder/tag is a team asset.

### Response Example
```json
{
  "tags": [
    {
      "id": "user/1005921515/state/com.google/starred",
      "sortid": "FFFFFFFF"
    },
    {
      "id": "user/1005921515/label/Google",
      "sortid": "BEBC2063",
      "type": "tag",
      "unread_count": 0,
      "unseen_count": 0
    },
    {
      "id": "user/1005921515/label/DIY",
      "sortid": "BECC0BE1",
      "type": "folder"
    },
    {
      "id": "user/1001637110/label/org-1000053521f-test",
      "sortid": "BF8E576A",
      "type": "folder",
      "organization_id": "1000053521f"
    }
  ]
}
```
```

--------------------------------

### Get Oldest Articles from Google Folder

Source: https://www.inoreader.com/developers/stream-contents

Retrieves the oldest articles from a specified folder. The `r=o` parameter sorts the results by oldest first.

```HTTP
https://www.inoreader.com/reader/api/0/stream/contents/user%2F-%2Flabel%2FGoogle?r=o
```

--------------------------------

### Example Active Search POST Payload

Source: https://www.inoreader.com/developers/active-search-create

This JSON object defines the parameters for creating an active search. Mandatory fields include 'term', 'filter_type', and 'filter_id' (if applicable).

```json
{
    "term": "amazing",
    "filter_type": "subscription",
    "filter_id": "feed/http://dnes.dir.bg/support/cat_rss.php?section=glavnite",
    "article_ids": [12363668564,12361058806,12329220375,12314369383],
    "search_filters": "all",
    "search_match": "all_words"
}
```

--------------------------------

### Mark Articles Unread and Add Custom Tag

Source: https://www.inoreader.com/developers/edit-tag

This example demonstrates how to simultaneously unmark articles as read and apply a custom tag. It utilizes both 'remove' and 'add' parameters for different tags.

```HTTP
https://www.inoreader.com/reader/api/0/edit-tag?r=user/-/state/com.google/read&a=user/-/label/com.google/test&i=12345678&i=12345679
```

--------------------------------

### Get Item IDs from Stream

Source: https://www.inoreader.com/developers/item-ids

Use this endpoint to fetch only the IDs of articles within a specified stream. This is efficient for checking article existence or matching queries without downloading full content. Parameters like `n` for count, `r` for order, `ot` for time, `xt` for exclusion, `it` for inclusion, `c` for continuation, `output` for format, `s` for stream ID, and `includeAllDirectStreamIds` for filtering stream IDs are available.

```json
{
  "items": [],
  "itemRefs": [
    {
      "id": "3614359203",
      "directStreamIds": [
"user/1005921515/label/MTB"
],
      "timestampUsec": "1416313130505268"
},
    {
      "id": "3614347074",
      "directStreamIds": [
"user/1005921515/label/MUST READ"
],
      "timestampUsec": "1416313031906359"
},
    {
      "id": "3614347075",
      "directStreamIds": [
"user/1005921515/label/MUST READ"
],
      "timestampUsec": "1416313031906358"
}
],
  "continuation": "aDRTXr1ek6qT"
}
```

--------------------------------

### Add Feed Subscription

Source: https://www.inoreader.com/developers/add-subscription

Use this POST method to follow feeds. The `quickadd` parameter specifies the feed ID to follow.

```json
{
  "query": "feed/http://feeds.arstechnica.com/arstechnica/science",
  "numResults": 1,
  "streamId": "feed/http://arstechnica.com/",
  "streamName": "Ars Technica » Scientific Method"
}
```

--------------------------------

### Google OAuth 2.0 Playground Configuration

Source: https://www.inoreader.com/developers/oauth

Instructions on how to configure the Google OAuth 2.0 Playground to interact with Inoreader's API.

```APIDOC
### Google OAuth 2.0 Playground Configuration

To test Inoreader's API using the Google OAuth 2.0 Playground:

1.  Open the gear menu and configure the following:
    *   `OAuth flow`: Server-side
    *   `OAuth endpoints`: Custom
    *   `Authorization endpoint`: `https://www.inoreader.com/oauth2/auth?state=test`
    *   `Token endpoint`: `https://www.inoreader.com/oauth2/token`
    *   `Access token location`: Authorization header w/ Bearer prefix
    *   `OAuth Client ID`: Your client ID
    *   `OAuth Client Secret`: Your client secret

2.  In Step 1, enter the desired scope (e.g., `read` or `read write`). **Do not select predefined scopes.**

3.  Click `Authorize APIs`. You will be redirected to the Inoreader consent page. Authorize your app.

4.  In Step 2, click `Exchange authorization code for tokens` without modifying the authorization code.

5.  You can now test API endpoints using the obtained access token. For example, use `https://www.inoreader.com/reader/api/0/user-info` as the Request URI.
```

--------------------------------

### Authentication via HTTP Headers

Source: https://www.inoreader.com/developers/app-auth

This is the preferred method for authenticating your application. Send your App ID in the `AppId` header and your App Key in the `AppKey` header.

```APIDOC
## POST /reader/api/0/subscription/list HTTP/1.1

### Description
This example demonstrates how to include App ID and App Key as HTTP headers for API authentication.

### Method
POST

### Endpoint
/reader/api/0/subscription/list

### Headers
- **User-Agent**: my-awesome-app
- **Host**: www.inoreader.com
- **Authorization**: GoogleLogin auth=G2UlCa...Fx
- **AppId**: 1000001414
- **AppKey**: kk18irxGeoXA5wyFg9U1PpTuabDu2WWG
```

--------------------------------

### Get Stream Contents

Source: https://www.inoreader.com/developers/stream-contents

Retrieves articles from a specified stream (collection) in JSON format. Supports filtering by read status, ordering, and pagination.

```APIDOC
## GET /reader/api/0/stream/contents/[streamId]

### Description
Retrieves a list of articles from a specified stream (e.g., a tag, a folder, or a feed). The `streamId` must be URL encoded.

### Method
GET

### Endpoint
`https://www.inoreader.com/reader/api/0/stream/contents/[streamId]`

### Parameters
#### Path Parameters
- **streamId** (string) - Required - The unique identifier for the stream, which must be URL encoded.

#### Query Parameters
- **n** (integer) - Optional - The number of items to return. Defaults to 20, maximum is 100.
- **r** (string) - Optional - The order of items. Defaults to newest first. Use `o` for oldest first.
- **ot** (integer) - Optional - A Unix timestamp to fetch items newer than this point. If `r=o` and `ot` is more than a month in the past, it defaults to one month ago.
- **xt** (string) - Optional - Exclude Target. Use `user/-/state/com.google/read` to exclude read articles.
- **it** (string) - Optional - Include Target. Accepted values: `user/-/state/com.google/starred`, `user/-/state/com.google/like`.
- **c** (string) - Optional - Continuation token for paginating through results. Obtained from the `continuation` field in the previous response.
- **output** (string) - Optional - Specifies the output format. Use `json` for JSON output.
- **includeAllDirectStreamIds** (boolean) - Optional - If set to `false`, only manually added tags are included in the `categories` list. Defaults to `true`.
- **annotations** (boolean) - Optional - If set to `true`, includes annotations for each article.
- **summaries** (boolean) - Optional - If set to `true`, includes Inoreader Intelligence summaries for each article.

### Request Example
```
https://www.inoreader.com/reader/api/0/stream/contents/feed%2Fhttp%3A%2F%2Ffeeds.arstechnica.com%2Farstechnica%2Fscience1&xt=user/-/state/com.google/read
```

### Response
#### Success Response (200)
- **direction** (string) - The text direction of the response.
- **id** (string) - The ID of the stream.
- **title** (string) - The title of the stream.
- **description** (string) - A description of the stream.
- **self** (object) - Contains the URL for the stream.
- **updated** (integer) - The last updated timestamp of the stream.
- **updatedUsec** (string) - The last updated timestamp in microseconds.
- **continuation** (string) - A token for fetching the next set of items.
- **items** (array) - An array of article objects.
  - **crawlTimeMsec** (string) - Crawl time in milliseconds.
  - **timestampUsec** (string) - Timestamp in microseconds.
  - **id** (string) - Unique ID of the article.
  - **categories** (array) - List of categories the article belongs to.
  - **title** (string) - Title of the article.
  - **published** (integer) - Publication timestamp.
  - **updated** (integer) - Update timestamp.
  - **canonical** (array) - Array of canonical links.
  - **alternate** (array) - Array of alternate links.
  - **summary** (object) - Summary of the article content.

#### Response Example
```json
{
   "direction":"ltr",
   "id":"user\/-\/state\/com.google\/annotated",
   "title":"Annotated",
   "description":"",
   "self":{
      "href":"https:\/\/www.inoreader.com\/reader\/api\/0\/stream\/contents\/"
   },
   "updated":1618212570,
   "updatedUsec":"1618212570146918",
   "items":[
      {
         "crawlTimeMsec":"1618211779000",
         "timestampUsec":"1618211779000000",
         "id":"tag:google.com,2005:reader\/item\/0000000693c3bc0c",
         "categories":[
            "user\/1005921515\/state\/com.google\/reading-list",
            "user\/1005921515\/state\/com.google\/read",
            "user\/1005921515\/label\/Tech"
         ],
         "title":"Windows and Linux devices are under attack by a new cryptomining worm",
         "published":1617969599,
         "updated":1617990787,
         "canonical":[
            {
               "href":"https:\/\/arstechnica.com\/?p=1755573"
            }
         ],
         "alternate":[
            {
               "href":"https:\/\/arstechnica.com\/?p=1755573",
               "type":"text\/html"
            }
         ],
         "summary":{
            "direction":"ltr",

```

--------------------------------

### Authenticate with HTTP Headers

Source: https://www.inoreader.com/developers/app-auth

Pass your App ID and App Key in the 'AppId' and 'AppKey' headers respectively. This is the recommended method for app authentication.

```http
POST /reader/api/0/subscription/list HTTP/1.1
User-Agent: my-awesome-app
Host: www.inoreader.com
Authorization: GoogleLogin auth=G2UlCa...Fx
AppId: 1000001414
AppKey: kk18irxGeoXA5wyFg9U1PpTuabDu2WWG


```

--------------------------------

### ClientLogin Authentication

Source: https://www.inoreader.com/developers/auth

This section describes how to authenticate using the legacy ClientLogin method. It is important to note that this method is not available for new integrations and OAuth 2.0 should be used instead. The API mimics Google ClientLogin for backward compatibility.

```APIDOC
## POST /accounts/ClientLogin

### Description
Authenticates a user using their email and password via the ClientLogin method. This is a legacy method and not recommended for new integrations.

### Method
POST

### Endpoint
`https://www.inoreader.com/accounts/ClientLogin`

### Parameters
#### Request Body
- **Email** (string) - Required - The username or email of the user.
- **Passwd** (string) - Required - The password of the user.

### Response
#### Success Response (200)
- **SID** (string) - Session ID (may be null).
- **LSID** (string) - Login Session ID (may be null).
- **Auth** (string) - Authentication token to be used in subsequent requests.

#### Response Example
```
SID=null
LSID=null
Auth=G2UlCa...Fx
```

#### Error Response (401)
- Returns a 401 status code with an error message if the username or password are incorrect.

#### Error Response (503)
- Returns a 503 status code if the backend is unreachable.

### Usage
Store the `Auth` token from a successful response and include it in the `Authorization` header for subsequent API requests: `Authorization: GoogleLogin auth=G2UlCa...Fx`
```

--------------------------------

### Get Unread Articles from Ars Technica Science Feed

Source: https://www.inoreader.com/developers/stream-contents

Fetches unread articles from a specific feed. The `xt` parameter is used to filter out read items.

```HTTP
https://www.inoreader.com/reader/api/0/stream/contents/feed%2Fhttp%3A%2F%2Ffeeds.arstechnica.com%2Farstechnica%2Fscience1&xt=user/-/state/com.google/read
```

--------------------------------

### Redirect to Inoreader Consent Page

Source: https://www.inoreader.com/developers/oauth

Initiate the OAuth flow by redirecting the user to this URL. Ensure all parameters are correctly replaced with your application's credentials and desired scopes. The redirect_uri must be URL encoded.

```URL
https://www.inoreader.com/oauth2/auth?client_id=[CLIENT_ID]&redirect_uri=[REDIRECT_URI]&response_type=code&scope=[OPTIONAL_SCOPES]&state=[CSRF_PROTECTION_STRING]
```

--------------------------------

### Client Registration

Source: https://www.inoreader.com/developers/registration

Register a new client with Inoreader using their email and password. Social network registrations are handled separately via the Authentication method.

```APIDOC
## POST /accounts/ClientRegister

### Description
Registers a new client with Inoreader using email and password.

### Method
POST

### Endpoint
https://www.inoreader.com/accounts/ClientRegister

### Parameters
#### Request Body
- **Email** (string) - Required - The Email of the user. It is validated server-side.
- **Passwd** (string) - Required - The desired password for the user. Minimum 6 characters.
- **Name** (string) - Required - The real name of the user.

### Response
#### Success Response (200)
- **OK** - Indicates successful user creation.

#### Error Response
- **Error=X** - Indicates an error occurred, where X is the error message.
```

--------------------------------

### Initiate OAuth Flow - Consent Page Redirection

Source: https://www.inoreader.com/developers/oauth

Redirect users to this URL to initiate the OAuth 2.0 authorization flow. The user will be prompted to grant your application access to their Inoreader data.

```APIDOC
## Consent Page Redirection

### Description
Redirect the user to the Inoreader consent page to authorize your application.

### Endpoint
```
https://www.inoreader.com/oauth2/auth?client_id=[CLIENT_ID]&redirect_uri=[REDIRECT_URI]&response_type=code&scope=[OPTIONAL_SCOPES]&state=[CSRF_PROTECTION_STRING]
```

### Parameters
#### Query Parameters
- **client_id** (string) - Required - The Client ID obtained during app registration.
- **redirect_uri** (string) - Required - The URL to redirect to after authorization. Must be URL encoded and match registration settings.
- **response_type** (string) - Required - Must be set to `code`.
- **scope** (string) - Optional - URL encoded scopes, e.g., `read` or `read write`. Defaults to app registration settings if omitted.
- **state** (string) - Optional - A CSRF protection string. Arbitrary data passed back to your redirect URI.
```

--------------------------------

### Get Unread Counts

Source: https://www.inoreader.com/developers/unread-counts

This method is used to fetch the unread counters for folders, tags and feeds. The response includes the maximum counter value and a list of unread counts for various streams.

```APIDOC
## GET /reader/api/0/unread-count

### Description
Fetches the unread counters for folders, tags, and feeds.

### Method
GET

### Endpoint
https://www.inoreader.com/reader/api/0/unread-count

### Response
#### Success Response (200)
- **max** (string) - The maximum counter value for the current user. Append '+' if count equals max.
- **unreadcounts** (array) - A list of unread counts for different streams.
  - **id** (string) - The stream ID (feed or folder). `user/-/state/com.google/reading-list` represents the total unread articles for the logged user.
  - **count** (integer) - The number of unread items.
  - **newestItemTimestampUsec** (string) - The timestamp (in microseconds) of the latest article in this section.

### Response Example
```json
{
  "max": "1000",
  "unreadcounts": [
    {
      "id": "user/1005921515/state/com.google/reading-list",
      "count": 4,
      "newestItemTimestampUsec": "1415620910006331"
    },
    {
      "id": "user/1005921515/state/com.google/starred",
      "count": 5,
      "newestItemTimestampUsec": "1415620910006331"
    },
    {
      "id": "user/1005921515/label/Animation",
      "count": 0,
      "newestItemTimestampUsec": "1415620910006331"
    },
    {
      "id": "user/1005921515/label/CAN READ",
      "count": 0,
      "newestItemTimestampUsec": "1415620910006331"
    }
  ]
}
```
```

--------------------------------

### Create Active Search POST Request

Source: https://www.inoreader.com/developers/active-search-create

Use this endpoint to create a new active search for the current user. Ensure your account adheres to active search limitations.

```http
POST https://www.inoreader.com/reader/api/0/active_search/create
```

--------------------------------

### Replace User ID with Hyphen in API Calls

Source: https://www.inoreader.com/developers/user-ids

When passing user IDs back to the API, replace the specific user ID with a hyphen ('-'). This applies to system tags and similar constructs. For example, 'user/1005921515/label/Testing' becomes 'user/-/label/Testing'.

```text
user/1005921515/label/Testing
```

```text
user/-/label/Testing
```

--------------------------------

### Get Item IDs

Source: https://www.inoreader.com/developers/item-ids

This method returns only the article IDs for a given stream. It is useful for checking if certain articles match a given query without retrieving the full content, which is a lighter alternative for backend processing and data transfer.

```APIDOC
## GET /reader/api/0/stream/items/ids

### Description
Retrieves a list of article IDs for a specified stream. This is an efficient way to check for articles without downloading their full content.

### Method
GET

### Endpoint
https://www.inoreader.com/reader/api/0/stream/items/ids

### Parameters
#### Query Parameters
- **n** (integer) - Optional - Number of items to return (default `20`, max `1000`).
- **r** (string) - Optional - Order of items. Default is newest first. Use `o` for oldest first.
- **ot** (integer) - Optional - Start time (unix timestamp) from which to retrieve items. If `r=o` and the time is older than one month ago, one month ago will be used instead.
- **xt** (string) - Optional - Exclude Target. Use `user/-/state/com.google/read` to query for items not flagged as read.
- **it** (string) - Optional - Include Target. Accepted values: `user/-/state/com.google/read`, `user/-/state/com.google/starred`, `user/-/state/com.google/like`.
- **c** (string) - Optional - Continuation token for paginating through results.
- **output** (string) - Optional - Desired output format. Use `json` for a JSON object.
- **s** (string) - Required - Stream ID. See Stream IDs documentation for details.
- **includeAllDirectStreamIds** (boolean) - Optional - Set to `false` (not `0`) to exclude folder tags for articles.

### Response
#### Success Response (200)
- **items** (array) - An empty array, as this endpoint only returns IDs.
- **itemRefs** (array) - An array of objects, each containing `id`, `directStreamIds`, and `timestampUsec` for an item.
- **continuation** (string) - A token for fetching the next set of items.

#### Response Example
```json
{
  "items": [],
  "itemRefs": [
    {
      "id": "3614359203",
      "directStreamIds": [
        "user/1005921515/label/MTB"
      ],
      "timestampUsec": "1416313130505268"
    },
    {
      "id": "3614347074",
      "directStreamIds": [
        "user/1005921515/label/MUST READ"
      ],
      "timestampUsec": "1416313031906359"
    }
  ],
  "continuation": "aDRTXr1ek6qT"
}
```
```

--------------------------------

### Fetch Unread Counts

Source: https://www.inoreader.com/developers/unread-counts

Use this endpoint to get the unread counts for folders, tags, and feeds. The 'max' value indicates the maximum counter displayable, and if 'count' equals 'max', append a '+' sign. The 'id' represents the stream ID, and 'newestItemTimestampUsec' is the timestamp of the latest article.

```json
{
  "max": "1000",
  "unreadcounts": [
    {
      "id": "user/1005921515/state/com.google/reading-list",
      "count": 4,
      "newestItemTimestampUsec": "1415620910006331"
    }, {
      "id": "user/1005921515/state/com.google/starred",
      "count": 5,
      "newestItemTimestampUsec": "1415620910006331"
    }, {
      "id": "user/1005921515/label/Animation",
      "count": 0,
      "newestItemTimestampUsec": "1415620910006331"
    }, {
      "id": "user/1005921515/label/CAN READ",
      "count": 0,
      "newestItemTimestampUsec": "1415620910006331"
    }
  ]
}
```
Tokens:
Raw