APIVerve.API.TextReadabilityScore 1.0.5

Text Readability Score API

Readability Score is a simple tool for calculating the readability score of text. It returns the readability score based on various readability formulas.

This is a .NET Wrapper for the Text Readability Score API

Installation

Using the .NET CLI:

dotnet add package APIVerve.API.TextReadabilityScore

Using the Package Manager:

nuget install APIVerve.API.TextReadabilityScore

Using the Package Manager Console:

Install-Package APIVerve.API.TextReadabilityScore

From within Visual Studio:

1. Open the Solution Explorer.
2. Right-click on a project within your solution.
3. Click on Manage NuGet Packages...
4. Click on the Browse tab and search for "APIVerve.API.TextReadabilityScore".
5. Click on the APIVerve.API.TextReadabilityScore package, select the appropriate version in the right-tab and click Install.

Configuration

Before using the readabilityscore 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 Text Readability Score API documentation is found here: https://docs.apiverve.com/api/readabilityscore.
You can find parameters, example responses, and status codes documented here.

Setup

Authentication

Text Readability Score API uses API Key-based authentication. When you create an instance of the API client, you can pass your API Key as a parameter.

// Create an instance of the API client
var apiClient = new TextReadabilityScoreAPIClient("[YOUR_API_KEY]", true);

Perform Request

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

Define Query

var queryOptions = new readabilityscoreQueryOptions{
  "text": "Western astrology is founded on the movements and relative positions of celestial bodies such as the Sun, Moon and planets, which are analysed by their movement through signs of the zodiac (twelve spatial divisions of the ecliptic) and by their aspects (based on geometric angles) relative to one another."
};

Simple Request

var response = apiClient.Execute(queryOptions);
if(response.error != null) {
	Console.WriteLine(response.error);
} else {
    var jsonResponse = JsonConvert.SerializeObject(response.data, Newtonsoft.Json.Formatting.Indented);
    Console.WriteLine(jsonResponse);
}

Example Response

{
  "status": "ok",
  "error": null,
  "data": {
    "textCounts": {
      "syllableCount": 82,
      "lexiconCount": 49,
      "sentenceCount": 1
    },
    "readability": {
      "fleschReadingEase": 13.28,
      "fleschKincaidGrade": 23.6,
      "gunningFog": 26.95,
      "colemanLiauIndex": 13.19,
      "smogIndex": 0,
      "automatedReadabilityIndex": 27.8,
      "daleChallReadabilityScore": 10.9
    },
    "readabilityText": {
      "fleschReadingEase": "very confusing",
      "daleChallReadabilityScore": "average 13th to 15th-grade (college) student"
    }
  }
}

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 mailboxlayer 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.