@apiverve/readingtime
v1.1.12
Published
Reading Time Calculator estimates how long it will take to read a given text. It calculates reading time based on word count and customizable reading speed (WPM).
Downloads
100
Readme
Reading Time Calculator API
Reading Time Calculator estimates how long it will take to read a given text. It calculates reading time based on word count and customizable reading speed (WPM).
This is a Javascript Wrapper for the Reading Time Calculator API
Installation
Using npm:
npm install @apiverve/readingtimeUsing yarn:
yarn add @apiverve/readingtimeConfiguration
Before using the Reading Time Calculator API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com
Quick Start
Get started with the Quick Start Guide
The Reading Time Calculator API documentation is found here: https://docs.apiverve.com/ref/readingtime. You can find parameters, example responses, and status codes documented here.
Setup
const readingtimeAPI = require('@apiverve/readingtime');
const api = new readingtimeAPI({
api_key: '[YOUR_API_KEY]'
});Usage
Perform Request
Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
var query = {
"text": "This is a sample article with multiple paragraphs. Reading time will be calculated based on word count. The average reading speed is 250 words per minute, which can be customized. This helps content creators provide accurate time estimates to their readers.",
"wpm": 250
};
api.execute(query, function (error, data) {
if (error) {
return console.error(error);
} else {
console.log(data);
}
});Using Promises
You can also use promises to make requests. The API returns a promise that you can use to handle the response.
var query = {
"text": "This is a sample article with multiple paragraphs. Reading time will be calculated based on word count. The average reading speed is 250 words per minute, which can be customized. This helps content creators provide accurate time estimates to their readers.",
"wpm": 250
};
api.execute(query)
.then(data => {
console.log(data);
})
.catch(error => {
console.error(error);
});Using Async/Await
You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
async function makeRequest() {
var query = {
"text": "This is a sample article with multiple paragraphs. Reading time will be calculated based on word count. The average reading speed is 250 words per minute, which can be customized. This helps content creators provide accurate time estimates to their readers.",
"wpm": 250
};
try {
const data = await api.execute(query);
console.log(data);
} catch (error) {
console.error(error);
}
}Example Response
{
"status": "ok",
"error": null,
"data": {
"text_length": 257,
"word_count": 41,
"reading_time_minutes": 1,
"reading_time_seconds": 10,
"reading_time_text": "1 min read",
"words_per_minute": 250
}
}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 (©) 2025 APIVerve, and EvlarSoft 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.
