Welcome to ReaderMode documentation page

Here you can find out how easy is to use readermode API.

How to use ReaderMode API?

All you need to to is pass Query Param url (in Request query parameters) - that is url of a article you wish to get readermode response.

Example 1 (curl request):

curl --request GET \
  --url 'https://readermode1.p.rapidapi.com/readermode?url=url-to-article' \
  --header 'X-RapidAPI-Host: readermode1.p.rapidapi.com' \
  --header 'X-RapidAPI-Key: your-api-key'

Example 2 (C# / HttpClient)

var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://readermode1.p.rapidapi.com/readermode?url=url-to-article"),
    Headers =
    {
        { "X-RapidAPI-Key", "your-api-key" },
        { "X-RapidAPI-Host", "readermode1.p.rapidapi.com" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Response Statuses

200

Response Status 200

All good, readermode is available and response body (returned json) will be in form of json object:

{
"url" : "url",
"title" : "website-title",
"author" : "article-author",
"content" : "article-content-html",
"plainContent" : "article-content-plainText",
"contentLength" : number-of-characters (integer),
"mainImage" : "url-of-article-main-image",
"language" : "article-language",
"publishedDate" : article-published-date (yyy-MM-ddT00:00:00),
"readingTime" : "estimated-reading-time (hh:mm:ss)",
"images" : "list-of-images-in-article"
}

If any of the properties cannot be read, it will be null.

422

Response Status 422 (Unprocessable Content)

readermode not available for provided url.

Response body will be (raw): "Article with provided url is unreadable"