Overview
Cost of Living uses regional Consumer Price Index data from the Bureau of Labor Statistics to calculate relative cost indices. The national average is set to 100, so an index of 120 means 20% more expensive than average. Data is aggregated by Census region (Northeast, Midwest, South, West) for large metro areas.
Live Test Cost of Living API →
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/costliving?location=California" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/costliving?location=California', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/costliving?location=California",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/costliving?location=California", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
locationRequired | string | State name, state code (e.g., CA, NY), or major city name. |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"searchedLocation": "California",
"region": "west-large",
"regionName": "West Large Metros (LA, SF, Seattle, Phoenix, Denver area)",
"costIndex": 107,
"description": "7% above average",
"cpi": 356.993,
"usAverageCPI": 334.98,
"period": "2026-08",
"note": "Cost index is relative to US average (100). Values above 100 indicate higher than average cost of living."
}
}
Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
searchedLocation | string | "California" | The queried location name or code provided |
regionPremium | string | "west-large" | Region identifier (e.g., west-large, south-large) |
regionNamePremium | string | "West Large Metros (LA, SF, Seattle, Phoenix, Denver area)" | Full region name with major cities included |
costIndex | number | 107 | Cost of living index (100 is national average) |
description | string | "7% above average" | Plain-language summary of how the location compares to the US average |
cpi | number | 356.993 | Consumer price index for the location |
usAverageCPI | number | 334.98 | Consumer price index for the US as a whole, for comparison |
period | string | "2026-08" | Month the index values are for, as YYYY-MM |
note | string | "Cost index is relative to US average (100). Values above 100 indicate higher than average cost of living." | How to read the index: 100 is the US average, above 100 is more expensive |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Relocation Planning
- Compare cost of living when considering job offers in different states or cities
- Salary Negotiations
- Calculate salary equivalents across different regions
- Business Location
- Factor cost of living into business location and expansion decisions
- HR Planning
- Set location-adjusted compensation for remote or distributed teams
Other ways to use Cost of Living
Set up Cost of Living on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Finance: