Skip to main content
POST
/
api
/
payscale
/
cost_of_living
/payscale/cost_of_living
curl --request POST \
  --url https://api.anysite.io/api/payscale/cost_of_living \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "state": "<string>",
  "city": "<string>",
  "timeout": 300
}
'
[
  {
    "@type": "@payscale_cost_of_living",
    "city": "<string>",
    "state": "<string>",
    "state_abbreviation": "<string>",
    "city_state": "<string>",
    "base_line": "<string>",
    "version": "<string>",
    "overall": 123,
    "grocery": 123,
    "housing": 123,
    "utilities": 123,
    "transportation": 123,
    "health_care": 123,
    "miscellaneous": 123
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
state
string
required

State or region name

Minimum string length: 1
Examples:

"California"

"Texas"

"New York"

city
string
required

City name

Minimum string length: 1
Examples:

"San Francisco"

"Austin"

"New York"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

@type
string
default:@payscale_cost_of_living
city
string | null
state
string | null
state_abbreviation
string | null
city_state
string | null
base_line
string | null
version
string | null
overall
number | null
grocery
number | null
housing
number | null
utilities
number | null
transportation
number | null
health_care
number | null
miscellaneous
number | null