Text Readability ScoreText Readability Score API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 609ms|p50: 569ms|p75: 636ms|p90: 716ms|p99: 877ms

Overview

To use Text Readability Score, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

URL
https://api.apiverve.com/v1/readabilityscore

Example

How to call the Text Readability Score API in different programming languages.

cURL Request
curl -X POST \
  "https://api.apiverve.com/v1/readabilityscore" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "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."
}'
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/readabilityscore', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "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."
})
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

payload = {
    "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."
}

response = requests.post('https://api.apiverve.com/v1/readabilityscore', headers=headers, json=payload)

data = response.json()
print(data)
Go (net/http)
package main

import (
    "fmt"
    "io"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    payload := map[string]interface{}{
        "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."
    }

    jsonPayload, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/readabilityscore", bytes.NewBuffer(jsonPayload))

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
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": 22.08,
      "automatedReadabilityIndex": 27.8,
      "daleChallReadabilityScore": 17
    },
    "readabilityText": {
      "fleschReadingEase": "very confusing",
      "daleChallReadabilityScore": "average 13th to 15th-grade (college) student"
    },
    "averageGradeLevel": 22.7,
    "targetAudience": "post-graduate"
  }
}

Authentication

The Text Readability Score API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Text Readability Score API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Text Readability Score API:

Calculate Readability Score

ParameterTypeRequiredDescriptionDefaultExample
textstringrequired
The text to calculate the readability score of
-The quick brown fox jumps over the lazy dog. This sentence contains every letter of the alphabet.

Response

The Text Readability Score API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <textCounts>
      <syllableCount>82</syllableCount>
      <lexiconCount>49</lexiconCount>
      <sentenceCount>1</sentenceCount>
    </textCounts>
    <readability>
      <fleschReadingEase>13.28</fleschReadingEase>
      <fleschKincaidGrade>23.6</fleschKincaidGrade>
      <gunningFog>26.95</gunningFog>
      <colemanLiauIndex>13.19</colemanLiauIndex>
      <smogIndex>22.08</smogIndex>
      <automatedReadabilityIndex>27.8</automatedReadabilityIndex>
      <daleChallReadabilityScore>17</daleChallReadabilityScore>
    </readability>
    <readabilityText>
      <fleschReadingEase>very confusing</fleschReadingEase>
      <daleChallReadabilityScore>average 13th to 15th-grade (college) student</daleChallReadabilityScore>
    </readabilityText>
    <averageGradeLevel>22.7</averageGradeLevel>
    <targetAudience>post-graduate</targetAudience>
  </data>
</response>
YAML Response
200 OK
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: 22.08
    automatedReadabilityIndex: 27.8
    daleChallReadabilityScore: 17
  readabilityText:
    fleschReadingEase: very confusing
    daleChallReadabilityScore: average 13th to 15th-grade (college) student
  averageGradeLevel: 22.7
  targetAudience: post-graduate
CSV Response
200 OK
keyvalue
textCounts{syllableCount:82,lexiconCount:49,sentenceCount:1}
readability{fleschReadingEase:13.28,fleschKincaidGrade:23.6,gunningFog:26.95,colemanLiauIndex:13.19,smogIndex:22.08,automatedReadabilityIndex:27.8,daleChallReadabilityScore:17}
readabilityText{fleschReadingEase:very confusing,daleChallReadabilityScore:average 13th to 15th-grade (college) student}
averageGradeLevel22.7
targetAudiencepost-graduate

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample ValueDescription
textCountsobject{...}
-
â”” syllableCountnumber82
-
â”” lexiconCountnumber49
-
â”” sentenceCountnumber1
-
readabilityobject{...}
-
â”” fleschReadingEasenumber13.28
-
â”” fleschKincaidGradenumber23.6
-
â”” gunningFognumber26.95
-
â”” colemanLiauIndexnumber13.19
-
â”” smogIndexnumber22.08
-
â”” automatedReadabilityIndexnumber27.8
-
â”” daleChallReadabilityScorenumber17
-
readabilityTextobject{...}
-
â”” fleschReadingEasestring"very confusing"
-
â”” daleChallReadabilityScorestring"average 13th to 15th-grade (college) student"
-
averageGradeLevelnumber22.7
Average grade level from all metrics
targetAudiencestring"post-graduate"
Suggested target audience based on readability

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Text Readability Score through GraphQL to combine it with other API calls in a single request. Query only the text readability score data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Text Readability Score in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  readabilityscore(
    input: {
      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."
    }
  ) {
    textCounts {
      syllableCount
      lexiconCount
      sentenceCount
    }
    readability {
      fleschReadingEase
      fleschKincaidGrade
      gunningFog
      colemanLiauIndex
      smogIndex
      automatedReadabilityIndex
      daleChallReadabilityScore
    }
    readabilityText {
      fleschReadingEase
      daleChallReadabilityScore
    }
    averageGradeLevel
    targetAudience
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Text Readability Score API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Text Readability Score requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Text Readability Score API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Text Readability Score

Official Text Readability Score packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

No-Code Integrations

Text Readability Score works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Frequently Asked Questions

How do I get an API key for Text Readability Score?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Text Readability Score and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Text Readability Score cost?

Each successful Text Readability Score API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful text readability score lookups.

Can I use Text Readability Score in production?

The free plan is for testing and development only. For production use of Text Readability Score, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Text Readability Score from a browser?
Yes! The Text Readability Score API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Text Readability Score credit limit?

When you reach your monthly credit limit, Text Readability Score API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?