Sign in

v1

latestOpenAPI 3.1.02026-07-242892032.8 MB
Data

Get estimate

Produces a compensation estimate based on many optional factors.

post/estimate

Request body

titlesstring[] required

One or more codes from the Emsi Title taxonomy.

socsstring[] required

One or codes from the SOC occupation taxonomy.

msainteger

An MSA to produce a regionalized estimate for.

countiesinteger[]

One or more county FIPS codes.

latnumber

A latitude. Note that this must be used with lon.

lonnumber

A longitude. Note that this must be used with lat.

keywordstring

A full-text keyword search, allows fuzzy and boolean text searches (using '+', '-', etc.).

skillsstring[]

Skill names from the Skills taxonomy. Note that the name needs to match exactly against the name defined by the taxonomy.

skills_operator'Or' | 'And'

Choose one of Or, And.

experiencesinteger[]

Years of experience. Limited to a single value for this endpoint.

percentilesnumber[]

What percentile(s) to include in the estimate, defaults to 10, 25, 50, 75, and 90.

industriesstring[]

NAICS industry codes to limit the search scope.

companiesstring[]

Normalized company names to limit the search scope.

modelstring

Advanced feature for changing the weighting model. See the /models endpoint.

Example request

{
  "titles": [
    "ETCC677E49FBA73537"
  ],
  "msa": 42660,
  "keyword": "Hadoop OR Hive"
}

Response

OK

national_employmentinteger required
regional_employmentinteger required