Status Page
API Reference

Request Parameters

Timeseries Request Parameters

Detailed reference for all supported Job Postings US Timeseries API request parameters, including property descriptions, supported operators, data types, and usage guidelines.

PropertyDescription
filter
  • Add filters to your postings query
  • An object or a list of up to 10 objects.
filter.title
  • Filter by job title codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["ET6850661D6AE5FA86"]
filter.active_sources_info
  • Filter postings by active sources information
  • This is an optional attribute.
  • Source information for where the posting can be found online.
filter.active_sources_info_type
  • Choose the source type to filter by
  • This is an optional attribute. Example: "Company"
filter.active_sources_info_source
  • Choose the source to filter by
  • This is an optional attribute. Example: "ABCRecruiting.com"
filter.active_sources_info_url
  • Choose the source url to filter by
  • This is an optional attribute. Example: "ABCRecruiting.com/job/GNkBaDoMWiyQbmlpFHfz"
filter.benefit
  • Filter by benefit ids
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["1001"]
filter.benefit_categories
  • Filter by benefit category ids
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["1"]
filter.benefit_categories_name
  • Filter by benefit category names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Education and Career Development"]
filter.benefit_name
  • Filter by benefit names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Financial Aid/Assistance"]
filter.cip2
  • Filter by 2-digit CIP ids
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["23"]
filter.cip2_name
  • Filter by 2-digit CIP names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["English Language and Literature/Letters"]
filter.cip4
  • Filter by 4-digit CIP ids
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["23.13"]
filter.cip4_name
  • Filter by 4-digit CIP names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Rhetoric and Composition/Writing Studies"]
filter.cip6
  • Filter by 6-digit CIP ids
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["23.1302"]
filter.cip6_name
  • Filter by 6-digit CIP names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Creative Writing"]
filter.city
  • Filter by city ids
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["U2VhdHRsZSwgV0E="]
filter.city_name
  • Filter by city names with state abbreviations
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Seattle, WA"]
filter.company
  • Filter by normalized company codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["NC9d0d7c83-619e-46eb-ae10-7bd2876a6857"]
filter.company_v2
  • Filter by normalized company v2 codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["37389368"]
filter.company_is_staffing
  • Filter to or exclude postings from staffing companies
  • This is an optional attribute.
  • Passing false filters out postings from companies that have been identified as staffing companies or recruiting agencies; true limits results to only those from staffing or recruiting companies. By default both staffing and non-staffing companies are included in the results.
    Example: true
filter.stars_qualified
  • Filter to or exclude postings with STARs qualification
  • This is an optional attribute.
  • STARs-friendly job postings based on requirements from partner Opportunities@Work.
    Example: true
filter.company_name
  • Filter by normalized company names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering (for details see Filtering above).
    Example: ["Microsoft Corporation"]
filter.company_name_v2
  • Filter by normalized company v2 names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["North Shore Medical Center"]
filter.contract_type
  • Filter by normalized contract type codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["2"]
filter.contract_type_name
  • Filter by normalized contract type names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Permanent contract"]
filter.county
  • Filter by Lightcast county (FIPS) codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: [16057]
filter.county_name
  • Filter by Lightcast county (FIPS) names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Latah County, ID"]
filter.edulevels
  • Filter by normalized education level codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: [0]
filter.edulevels_name
  • Filter by normalized education level names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["High school or GED"]
filter.employee_count_range
  • Filter by employee count range
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["1001-5000"]
filter.employment_type
  • Filter by employment type (Full/Part time) codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: [1]
filter.employment_type_name
  • Filter by employment type (Full/Part time) names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Full-time (> 32 hours)"]
filter.fips
  • Filter by Lightcast county (FIPS) codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: [16057]
filter.fips_name
  • Filter by Lightcast county (FIPS) names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Latah County, ID"]
filter.is_fortune100
  • Filter by Fortune 100 job postings
  • This is an optional attribute.
  • Job postings by Fortune 100 companies
    Example: true
filter.is_fortune1000
  • Filter by Fortune 1000 job postings
  • This is an optional attribute.
  • Job postings by Fortune 1000 companies
    Example: true
filter.is_fortune500
  • Filter by Fortune 500 job postings
  • This is an optional attribute.
  • Job postings by Fortune 500 companies
    Example: true
filter.is_hwol
  • Filter by HWOL Internal Only
  • This is an optional attribute.
  • Job postings that are described as Help Wanted OnLine postions. Example: true
filter.is_internship
  • Filter by internship job postings
  • This is an optional attribute.
  • Job postings that are described as internship positions. Example: true
filter.isced
  • Filter by ISCED education level codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: [6]
filter.isced_max
  • Filter by maximum ISCED education level codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: [7]
filter.isced_max_name
  • Filter by maximum ISCED education level names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Master's or equivalent level"]
filter.isced_min
  • Filter by minimum ISCED education level codes
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: [5]
filter.isced_min_name
  • Filter by minimum ISCED education level names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Short-cycle tertiary education"]
filter.isced_name
  • Filter by ISCED education level names
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Bachelor's or equivalent level"]
filter.is_supervisor
  • Filter by supervisory positions Internal Only
  • This is an optional attribute.
  • Job postings that are described as supervisor postions. Example: true
filter.job_seniority
  • Filter by job seniority
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["2"]
filter.job_seniority_name
  • Filter by job seniority name
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering. Example: ["Senior"]
filter.keywords
  • Filter postings by keyword
  • This is an optional attribute.
filter.keywords_type
  • Type of keyword search to run
  • This is an optional attribute.
  • How the keyword(s) are matched in a job posting.
    • or - Match postings with any of the keywords.
    • and - Match postings with all the keywords.
    • phrase - Match postings with the keywords as a phrase.
    • expression - Match postings using a complex boolean expression; e.g. "(uav OR drone) AND agriculture NOT surveillance".
  • Alternatively, you can prefix a word with - to exclude it; e.g. "games Android -iOS" would match postings that mention 'games' and 'Android' but exclude those that mention 'iOS'.
    Must be one of these values: "or", "and", "phrase", "expression"
    Default: "or"
filter.keywords_query
  • Keyword(s) by which to filter postings.
  • Keyword(s) to match in the original title and body of the job postings.
    Example: "work/life balance"
filter.lightcast_sectorsBeta (may change without warning)
  • Filter by Lightcast Sectors.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["2"]
filter.lightcast_sectors_nameBeta (may change without warning)
  • Filter by Lightcast Sectors names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Professionals"]
filter.lot_career_area
  • Filter by career area ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["27"]
filter.lot_career_area_name
  • Filter by career area names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Marketing and Public Relations"]
filter.lot_occupation
  • Filter by occupation ids.
  • This is an optional attributes.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["271210"]
filter.lot_occupation_group
  • Filter by occupation group ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["2712"]
filter.lot_occupation_group_name
  • Filter by occupation group names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Marketing Specialists"]
filter.lot_occupation_name
  • Filter by occupation names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["E-Commerce Analyst"]
filter.lot_specialized_occupation
  • Filter by specialized occupation ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["27121011"]
filter.lot_specialized_occupation_name
  • Filter by specialized occupation names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["E-Commerce Assistant"]
filter.max_edulevels
  • Filter by maximum education level ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["3"]
filter.max_edulevels_name
  • Filter by maximum education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Master's degree"]
filter.max_salary
  • Filter by maximum advertised annual salary.
  • This is an optional attribute.
  • This filter operates on the maximum advertised annual salary found in a job posting. Not all postings advertise salaries, when using this filter only postings with advertised salaries will be included in your results.
filter.max_salary._lower_bound
  • Lower bound for maximum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 55000
    Minimum: 0
filter.max_salary._upper_bound
  • Upper bound for maximum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 80000
    Minimum: 0
filter.max_years_experience
  • Filter on the maximum years of experience requested in a posting.
  • This is an optional attribute.
  • This filter operates on the advertised maximum years of experience found in a job posting. Not all postings advertise maximum years of experience, when using this filter only postings with a maximum years of experience will be included in your results.
filter.max_years_experience._lower_bound
  • Lower bound for maximum years of experience.
  • This is an optional attribute.
  • Lower bound for the maximum years of experience required by a job posting (years are inclusive).
    Example: 4
    Minimum: 0
filter.max_years_experience._upper_bound
  • Upper bound for maximum years of experience.
  • This is an optional attribute.
  • Upper bound for the maximum years of experience required by a job posting (years are inclusive).
    Example: 6
    Minimum: 0
filter.min_edulevels
  • Filter by minimum education level ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering (for details see Filtering above).
    Example: ["2"]
filter.min_edulevels_name
  • Filter by minimum education level names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering (for details see Filtering above).
    Example: ["Bachelor's degree"]
filter.min_salary
  • Filter by minimum advertised annual salary.
  • This is an optional attribute.
  • This filter operates on the minimum advertised annual salary found in a job posting. Not all postings advertise salaries, when using this filter only postings with advertised salaries will be included in your results.
filter.min_salary._lower_bound
  • Lower bound for minimum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 55000
    Minimum: 0
filter.min_salary._upper_bound
  • Upper bound for minimum advertised salary (inclusive).
  • This is an optional attribute.
    Example: 80000
    Minimum: 0
filter.min_years_experience
  • Filter on the minimum years of experience requested in a posting.
  • This is an optional attribute.
  • This filter operates on the advertised minimum years of experience found in a job posting. Not all postings advertise minimum years of experience, when using this filter only postings with a minimum years of experience will be included in your results.
filter.min_years_experience._lower_bound
  • Lower bound for minimum years of experience.
  • This is an optional attribute.
  • Lower bound for the minimum years of experience required by a job posting (years are inclusive).
    Example: 1
    Minimum: 0
filter.min_years_experience._upper_bound
  • Upper bound for minimum years of experience.
  • This is an optional attribute.
  • Upper bound for the minimum years of experience required by a job posting (years are inclusive).
    Example: 3
    Minimum: 0
filter.msa
  • Filter by Lightcast MSA codes (metro or micro).
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: [10180]
filter.msa_name
  • Filter by Lightcast MSA names (metro or micro).
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Abilene, TX"]
filter.naics2
  • Filter by normalized 2-digit company NAICS 2017 codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["31"]
filter.naics2_name
  • Filter by normalized 2-digit company NAICS 2017 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Manufacturing"]
filter.naics3
  • Filter by normalized 3-digit company NAICS 2017 codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["334"]
filter.naics3_name
  • Filter by normalized 3-digit company NAICS 2017 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Computer and Electronic Product Manufacturing"]
filter.naics4
  • Filter by normalized 4-digit company NAICS 2017 codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["3341"]
filter.naics4_name
  • Filter by normalized 4-digit company NAICS 2017 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Computer and Peripheral Equipment Manufacturing"]
filter.naics5
  • Filter by normalized 5-digit company NAICS 2017 codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["33411"]
filter.naics5_name
  • Filter by normalized 5-digit company NAICS 2017 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Computer and Peripheral Equipment Manufacturing"]
filter.naics6
  • Filter by normalized 6-digit company NAICS 2017 codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["334111"]
filter.naics6_name
  • Filter by normalized 6-digit company NAICS 2017 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Electronic Computer Manufacturing"]
filter.onet
  • Filter by Lightcast O*NET codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["29-1141.00"]
filter.onet_name
  • Filter by Lightcast O*NET names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering .
    Example: ["Registered Nurses"]
filter.posting_duration
  • Filter postings by how long they were active.
  • This is an optional attribute.
  • This filter operates on the number of days a posting has been active. This filter differs from the 'posting_duration' metric in that it will take into account currently active posting durations, where the metric only calculates duration of expired postings.
filter.posting_duration._lower_bound
  • Lower bound for posting duration.
  • This is an optional attribute.
  • Lower bound for the number of days a posting has been active for (days are inclusive).
    Example: 0
    Minimum: 0
filter.posting_duration._upper_bound
  • Upper bound for posting duration.
  • This is an optional attribute.
  • Upper bound for the number of days a posting has been active for (days are inclusive).
    Example: 30
    Minimum: 0
filter.remote_type
  • Filter by remote type ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["1"]
filter.remote_type_name
  • Filter by remote type names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Remote"]
filter.revenue_bucket
  • Filter by revenue bucket.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["5,000,000 - 9,999,000"]
filter.laa_country
  • Filter by LAA country.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["US"]
filter.laa_country_name
  • Filter by LAA country names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["United States"]
filter.laa_admin_area_1
  • Filter by LAA administrative area 1.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["US06"]
filter.laa_admin_area_1_name
  • Filter by LAA administrative area 1 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["California"]
filter.laa_admin_area_2
  • Filter by LAA administrative area 2.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["US06A"]
filter.laa_admin_area_2_name
  • Filter by LAA administrative area 2 names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Los Angeles County"]
filter.laa_metro
  • Filter by LAA metro.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["US06AM"]
filter.laa_metro_name
  • Filter by LAA metro names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Los Angeles-Long Beach-Anaheim, CA Metro Area"]
filter.salary
  • Filter by average advertised annual salary.
  • This is an optional attribute.
  • This filter operates on the average advertised annual salary found in a job posting. Not all postings advertise salaries, when using this filter only postings with advertised salaries will be included in your results.
filter.salary._lower_bound
  • Lower bound for average advertised salary (inclusive).
  • This is an optional attribute.
    Example: 60000
    Minimum: 0
filter.salary._upper_bound
  • Upper bound for average advertised salary (inclusive).
  • This is an optional attribute.
    Example: 70000
    Minimum: 0
filter.skill_categories
  • Filter by skill category ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["1"]
filter.skill_categories_name
  • Filter by skill category names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Administration"]
filter.skill_subcategories
  • Filter by skill subcategory ids.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["103"]
filter.skill_subcategories_name
  • Filter by skill subcategory names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["General Administrative and Clerical Tasks"]
filter.skills
  • Filter by skill codes (any skill type).
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["KS440W865GC4VRBW6LJP"]
filter.skills_name
  • Filter by skill names (any skill type).
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["SQL (Programming Language)"]
filter.soc2
  • Filter by Lightcast level 2 SOC codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["11-0000"]
filter.soc2_name
  • Filter by Lightcast level 2 SOC names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Management Occupations"]
filter.soc3
  • Filter by Lightcast level 3 SOC codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["11-1000"]
filter.soc3_name
  • Filter by Lightcast level 3 SOC names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Top Executives"]
filter.soc4
  • Filter by Lightcast level 4 SOC codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["11-1010"]
filter.soc4_name
  • Filter by Lightcast level 4 SOC names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Chief Executives"]
filter.soc5
  • Filter by Lightcast level 5 SOC codes.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["11-1011"]
filter.soc5_name
  • Filter by Lightcast level 5 SOC names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Chief Executives"]
filter.source_types
  • Filter by job posting source types.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Job Board"]
filter.sources
  • Filter by job posting source websites.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["monster.com"]
filter.state
  • Filter by state 2-digit FIPS.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: [36]
filter.state_name
  • Filter by state names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["New York"]
filter.title_name
  • Filter by job title names.
  • This is an optional attribute.
  • This value may be an array of values to filter by (inclusively) or an object describing more nuanced filtering.
    Example: ["Software Engineers"]
filter.when
  • Filter postings by time.
  • Job posting timeframe filter, can be the string active (except for the timeseries endpoints) to match all currently active postings, or a more granular timeframe when object detailed below.
filter.when._type
  • Choose which date on a posting to filter by.
  • This is an optional attribute.
  • Determines how posting dates are evaluated.
    • posted - Match postings that were posted in your date range.
    • active - Match postings that were active within your date range.
    • expired - Match postings that expired in your date range.`
    Must be one of these values: "posted", "active", "expired"
    Default: "active"
filter.when._end
  • Filter to postings before this date (inclusive).
  • The end of a date range, an ISO-8061 year-month or year-month-day date format.
    Example: "2019-06"
filter.when._start
  • Filter to postings after this date (inclusive)
  • The start of a date range, an ISO-8061 year-month or year-month-day date format.
    Example: "2018-06"
metrics
  • Metrics to include in the summary.
  • This is an optional attribute.
  • The `median_posting_duration` metric only applies to closed job postings.
    Some metrics may be approximations for performance reasons.
  • The `median_years_of_experience_required` metric is the median experience required, based on job postings that include both a minimum and maximum requirement. Default: ["unique_postings"]
    Array Items:
    This is an optional attribute.
    Must be one of these values: "unique_postings", "duplicate_postings", "total_postings", "posting_intensity", "unique_companies", "median_posting_duration", "min_salary", "median_salary", "max_salary", "median_max_salary", "average_salary", "median_years_of_experience_required"

Updated about 2 hours ago

Did this page help you?

Updated about 2 hours ago

Did this page help you?