/payscale/cost_of_living

POST /api/payscale/cost_of_living

Price: 1 credit

Get the Payscale cost-of-living index for a city, indexed against the national average (100): overall index plus grocery, housing, utilities, transportation, health care and miscellaneous category indexes.

How to use it

Fetch the Payscale cost-of-living index for a city by state and city. Returns one item with city, state, state_abbreviation, city_state, base_line, version and the category indexes overall, grocery, housing, utilities, transportation, health_care and miscellaneous (each relative to the national average of 100).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• state string required — State or region name (examples: "California", "Texas", "New York"; minLength: 1)
• city string required — City name (examples: "San Francisco", "Austin", "New York"; minLength: 1)

Response

• @type string (default: "PayscaleCostOfLiving")
• city string nullable
• state string nullable
• state_abbreviation string nullable
• city_state string nullable
• base_line string nullable
• version string nullable
• overall number nullable
• grocery number nullable
• housing number nullable
• utilities number nullable
• transportation number nullable
• health_care number nullable
• miscellaneous number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — City not found (well-formed but nonexistent city/state combination) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.