Website Readability API

Website Readability is a simple tool for analyzing the readability of a website. It returns the readability score of the website provided.

This is a Javascript Wrapper for the Website Readability API

Installation

npm install @apiverve/websitereadability --save

Configuration

Before using the websitereadability API client, you have to setup your account and obtain your API Key.
You can get it by signing up at https://apiverve.com

Usage

The Website Readability API documentation is found here: https://docs.apiverve.com/api/websitereadability.
You can find parameters, example responses, and status codes documented here.

Setup

var websitereadabilityAPI = require('@apiverve/websitereadability');
var api = new websitereadabilityAPI({
    api_key: [YOUR_API_KEY],
    secure: true //(Optional, defaults to true)
});

Perform Request

Using the API client, you can perform requests to the API.

Define Query

var query = {
  "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts"
};

Simple Request (using Callback)

api.execute(query, function (error, data) {
    if (error) {
        return console.error(error);
    } else {
        console.log(data);
    }
});

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "fleschReadingEase": 24.55,
    "fleschReadingEaseText": "Very Confusing",
    "fleschKincaidGrade": 19.3,
    "gunningFog": 19.56,
    "colemanLiauIndex": 13.18,
    "smogIndex": 18.7,
    "automatedReadabilityIndex": 22.5,
    "daleChallReadabilityScore": 9.16,
    "daleChallReadabilityScoreText": "average 13th to 15th-grade (college) student",
    "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts"
  },
  "code": 200
}

Customer Support

Need any assistance? Get in touch with Customer Support.

Updates

Stay up to date by following @apiverveHQ on Twitter.

Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.

License

Licensed under the The MIT License (MIT)

Copyright (©) 2024 APIVerve, and Evlar LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.