BMI Calculator is a simple tool for calculating body mass index. It returns the calculated BMI based on the weight and height provided. To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.
Important: Ensure that this API is enabled from within your dashboard to use it in your application. If not, you may receive a 403
error
Calculate body mass index based on weight and height
This is a required header
on every request. Your API Key is found from within your dashboard
This is an optional header
. Set the value to application/json
, application/xml
, or application/yaml
double
(required)The weight of the person in either kg or lb
heightdouble
(required)The height of the person in cm or ft
unitstring
(required)The unit of measurement for weight and height (metric or imperial)
Sample Request
import requests
url = "https://api.apiverve.com/v1/bmicalculator"
querystring = {'weight': '70', 'height': '170', 'unit': 'metric'}
headers = {
"x-api-key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://api.apiverve.com/v1/bmicalculator?weight=70&height=170&unit=metric"),
Headers =
{
{ "x-api-key", "YOUR_API_KEY" }
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', 'https://api.apiverve.com/v1/bmicalculator?weight=70&height=170&unit=metric');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');
xhr.send(data);
const request = require('request');
const options = {
method: 'GET',
url: 'https://api.apiverve.com/v1/bmicalculator?weight=70&height=170&unit=metric',
headers: {
'x-api-key': 'YOUR_API_KEY'
}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.apiverve.com/v1/bmicalculator?weight=70&height=170&unit=metric"))
.header("x-api-key", "YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
import Foundation
let headers = [
"x-api-key": "YOUR_API_KEY"
]
let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/bmicalculator?weight=70&height=170&unit=metric")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
curl --request GET \
--url 'https://api.apiverve.com/v1/bmicalculator?weight=70&height=170&unit=metric' \
--header 'x-api-key: YOUR_API_KEY'
Sample Response
{
"status": "ok",
"error": null,
"data": {
"height": "170 cm",
"weight": "70 kg",
"bmi": 24.221453287197235,
"risk": "Low risk",
"summary": "This weight is normal and you are healthy.",
"recommendation": "A BMI between 18.5 and 24.9 falls within the 'normal' weight range according to the World Health Organization. This range is associated with the lowest health risk for conditions such as heart disease, diabetes, and certain cancers. However, it's important to note that BMI is not a perfect measure as it does not account for muscle mass, bone density, overall body composition, and racial and sex differences. Therefore, while it's a useful starting point, it should not be the only measure of one's health."
},
"code": 200
}
<Root>
<status>ok</status>
<error />
<data>
<height>170 cm</height>
<weight>70 kg</weight>
<bmi>24.221453287197235</bmi>
<risk>Low risk</risk>
<summary>This weight is normal and you are healthy.</summary>
<recommendation>A BMI between 18.5 and 24.9 falls within the 'normal' weight range according to the World Health Organization. This range is associated with the lowest health risk for conditions such as heart disease, diabetes, and certain cancers. However, it's important to note that BMI is not a perfect measure as it does not account for muscle mass, bone density, overall body composition, and racial and sex differences. Therefore, while it's a useful starting point, it should not be the only measure of one's health.</recommendation>
</data>
<code>200</code>
</Root>
status: ok
error:
data:
height: 170 cm
weight: 70 kg
bmi: 24.2214532871972
risk: Low risk
summary: This weight is normal and you are healthy.
recommendation: A BMI between 18.5 and 24.9 falls within the 'normal' weight range according to the World Health Organization. This range is associated with the lowest health risk for conditions such as heart disease, diabetes, and certain cancers. However, it's important to note that BMI is not a perfect measure as it does not account for muscle mass, bone density, overall body composition, and racial and sex differences. Therefore, while it's a useful starting point, it should not be the only measure of one's health.
code: 200
The BMI Calculator API supports the following response content types:
application/json
, application/xml
, application/yaml
You can specify the response content type by setting the Accept
header in your request. If you don't specify a content type, the API will default to application/json
.
The BMI Calculator API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.
Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.
To use any API, you must have it enabled from within your dashboard. Disabled APIs will fail to respond to your requests.
All requests made to the API must contain the header x-api-key
in each of your requests. API requests without authentication will fail.
All API requests must also be made over secure HTTPS
. Requests made over plain HTTP
will fail.
Error Code | Meaning |
---|---|
401 | Your request was made with invalid credentials. This error also appears when you don't pass the x-api-key header in your request.
|
403 | Typically, this occurs when you are trying to access an API that you have not enabled. |
{
"status": "error",
"data": null,
"error": "tokens have been depleted",
"code": 429
}
Each subscription has its own monthly token limit. Your token count is based on your subscription plan. If you reach your limits, don't worry. You can always upgrade or downgrade at any time.
When you reach your limit, the service will stop responding and typically return an HTTP 429
response status code. The error will also contain a detailed JSON.
The BMI Calculator API uses the following error code:
Error Code | Meaning |
---|---|
429 | You have exceeded your rate limit and further requests will be denied until the next cycle. |
For reference, the BMI Calculator API uses the following error codes:
Error Code | Meaning |
---|---|
Code | Message |
200 | The request was successful. The response will include the requested data. |
400 | The request was invalid. The response will include a message that explains the error. |
401 | The request was not authorized. Usually, this means that the API key is missing or invalid. |
403 | This means that the request was trying to access a resource that it does not have permission to access. |
404 | This means that the resource you are trying to access does not exist. |
429 | This means that you have reached the rate limit. The response will include a Retry-After header that indicates how many seconds you need to wait before making a new request. |
500 | This means that there was an error on the server side. We are alerted when this happens and we will work to fix it as soon as possible. |