Docs/Sources/Cost of Living

Cost of Living

Compare Cost of Living by US Region

OperationalCredits 2 per callp50 467msFinance

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 Source →

Formula

One function covers the whole catalog: the first argument names the source, the rest are its inputs, and the "field" pair says which single value lands in the cell. Formulas covers the grammar that applies to all of them.

=VERVE("costliving", A2, "field", "searchedLocation")

A2 holds the location you are looking up. Drag the formula down and each row resolves on its own.

With literal values

Nothing has to come from a cell — typed values work the same way.

=VERVE("costliving", "California", "field", "searchedLocation")

Inputs

Required inputs are positional, in the order below. Everything else is passed as a "name", value pair after them — the same shape as SUMIFS. Premium inputs are accepted on every plan but only take effect on plans that include them.

InputTypeWhere it goesDescription
locationRequiredstringargument 2 (A2)State name, state code (e.g., CA, NY), or major city name.

What lands in your sheet

The "field" pair is what makes the formula resolve to one cell. Its value is a dot-path from the table below, so swapping it is how you pull a different value — one formula per column.

Seeing everything at once

Drop the "field" pair and the formula returns the whole response instead: two columns, field name on the left and value on the right, spilling from the cell you typed in.

=VERVE("costliving", A2)
Good for exploring, not for filling down

The second row's table would land on top of the first's, and every cell after the first reads #REF! (#SPILL! in Excel). Keep one per sheet, or name a field, and leave the cells below and to the right empty.

Response fields

Paths are relative to data. Each one is exactly what the "field" pair accepts, so swapping it is how you pull a different value into a cell. On a plan without a Premium field the cell reads #PREMIUM(field) rather than a value, so a locked field never looks like a real answer.

Use as "field"TypeExample cell valueDescription
searchedLocationstringCaliforniaThe queried location name or code provided
regionPremiumstringwest-largeRegion identifier (e.g., west-large, south-large)
regionNamePremiumstringWest Large Metros (LA, SF, Seattle, Phoenix, Denver area)Full region name with major cities included
costIndexnumber107Cost of living index (100 is national average)
descriptionstring7% above averagePlain-language summary of how the location compares to the US average
cpinumber356.993Consumer price index for the location
usAverageCPInumber334.98Consumer price index for the US as a whole, for comparison
periodstring2026-08Month the index values are for, as YYYY-MM
notestringCost 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

Filling a whole column

Both platforms make one batched call for a column rather than one request per cell, and both cost the same — 2 credits per row looked up. How you write it differs, because the two runtimes batch at different points.

Rows 2–100 in one call
=VERVE("costliving", A2:A100, "field", "searchedLocation")

In Google Sheets, give the arguments ranges and the answers spill down from the cell you typed in. Custom functions there run synchronously and in isolation, so dragged cells cannot be coalesced — the range form is how a column becomes one call. The "field" pair is required here: a per-row two-column table has nowhere to spill. Use a full column per input (A2:A100, not A2) — a single-cell reference is read as row 1 only and the rest of the column comes back blank.

In Excel, type the formula once and fill down — no range form and none needed, because its runtime is asynchronous and the add-in coalesces the calls a fill produces into a single batched request. Do not hand VERVE.CALL a range: Excel flattens it into positional arguments, so A2:A100 arrives as a hundred separate arguments and the cell reads #ERR rather than filling.

Either way, column A holds your location values and the answers land beside them, one row each, blank rows skipped.

When a cell doesn't fill

A failed lookup returns readable text starting with #ERR rather than a spreadsheet error, because Excel cannot show a custom message on a real error — you would get a bare #VALUE! with no reason. The trade-off is that IFERROR() will not catch it; test with LEFT(cell, 4) = "#ERR" instead. Error handling covers the rest.

Cell readsWhat happened
#ERR Not connectedNo API key saved. Open the side panel and connect your account.
#ERR Replace <name> with a cell or valueA preview formula was copied as-is. Swap the placeholder for a cell reference.
#ERR No "x" in costlivingAn option name this source does not take. The message lists the ones it does.
#ERR No data point "…"The "field" path is not in the response. Check it against the table above.
#PREMIUM(field)The field exists but your plan does not include it.
#ERR Out of creditsThe cycle's credits are spent. Usage resets on your billing date.

Before the formula works

The add-in reads the API key you saved once in the side panel — the key never goes in the formula, so a shared sheet does not leak it and a collaborator without access simply sees the last calculated values.

  1. Install the add-in for Google Sheets or Excel.
  2. Open the side panel and sign in, or paste a key from your dashboard.
  3. Type the formula above into any cell.

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 VerveSheets, or reach the same source a different way. Your VerveSheets account and credits work on all of them — one key, one balance.

Call it as a REST APIOne HTTPS endpoint and an x-api-key header, with SDKs for Node, Python and .NET.APIVerve →Reference →
Give it to an AI agentConnect over MCP and your agent calls it as a native tool — Claude, Cursor, ChatGPT.VerveKit →Reference →
Ground an agent on itA cited, machine-checkable fact your model can't produce on its own.VerveContext →Reference →

More in Finance:

Was this page helpful?