Banner: Web API: List jobs

Web API: List jobs

List jobs

'List Jobs V2' is an API that enables developers to retrieve job postings for a specific keyword or an occupation title or code. The returned list object contains the job postings available in the area, from the National Labor Exchange. The API provides search results based on keyword and location entered. The search recognizes the O*NET taxonomy created by the Department of Labor for cross-agency use by federal, state and local government entities.

About this data

'List Jobs V2' API is used in the CareerOneStop Job Finder Tool. For more information about the data, read the Job Finder Help Page. Submit a data request through NLX (The National Labor Exchange) to access the CareerOneStop Jobs API for posting jobs. You can also check out the NASWA Research Hub for information on using the Jobs data for analytical or research purposes. Click here for more information about recent updates.

Resource URL

https://api.careeronestop.org/v2/jobsearch/{userId}/{keyword}/{location}/{radius}/{sortColumns}/{sortOrder}/{startRecord}/{pageSize}/{days}?showFilters={showFilters}&enableJobDescriptionSnippet={enableJobDescriptionSnippet}&enableMetaData={enableMetaData}

Try this Web API

Example Code

using System;

using System.Net.Http;

using System.Net.Http.Headers;

using System.Threading.Tasks;

using System.Collections.Specialized;

using System.Linq;

namespace CareerOneStopAPISample

{

    class Program

    {

        static void Main(string[] args)

        {

            CreateRequest().Wait();

        }

        private static async Task CreateRequest()

        {

            var qs = new NameValueCollection();

            qs["companyName"] = "value";                       

           

            var uri = new UriBuilder(Uri.UriSchemeHttps, "api.careeronestop.org")

            {

                Path = "/v2/jobsearch/{userId}/{keyword}/{location}/{radius}/{sortColumns}/{sortOrder}/{startRecord}/{pageSize}/{days}?showFilters={showFilters}&enableJobDescriptionSnippet={enableJobDescriptionSnippet}&enableMetaData={enableMetaData}",

                Query = string.Join("&", qs.AllKeys.Select(key => key + "=" + Uri.EscapeUriString(qs[key])))

            };

           

            using (var http = new HttpClient())

            {

                http.DefaultRequestHeaders.Accept.Clear();

                http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "Your API Token");

                http.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                var response = await http.GetAsync(uri.Uri).ConfigureAwait(false);

                if (response.IsSuccessStatusCode)

                {

                    var result = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

                }

            }

        }

    }

}
import java.io.IOException;

import java.net.URI;

import java.net.URISyntaxException;

import org.apache.http.HttpEntity;

import org.apache.http.client.methods.CloseableHttpResponse;

import org.apache.http.client.methods.HttpGet;

import org.apache.http.client.utils.URIBuilder;

import org.apache.http.impl.client.CloseableHttpClient;

import org.apache.http.impl.client.HttpClients;

import org.apache.http.util.EntityUtils;

public class CareerOneStopAPISample {

    public static void main(String[] args) throws IOException, URISyntaxException {

    URI uri = new URIBuilder()

        .setScheme("https")

        .setHost("api.careeronestop.org")

        .setPath("/v2/jobsearch/{userId}/{keyword}/{location}/{radius}/{sortColumns}/{sortOrder}/{startRecord}/{pageSize}/{days}?showFilters={showFilters}&enableJobDescriptionSnippet={enableJobDescriptionSnippet}&enableMetaData={enableMetaData}")

                .setParameter("companyName", "value")

        .build();

    CloseableHttpResponse response = null;

    HttpGet httpGet = null;

    try {

        CloseableHttpClient httpClient = HttpClients.createDefault();

        httpGet = new HttpGet(uri);

        httpGet.setHeader("Content-Type","application/json");

        httpGet.setHeader("Authorization", "Bearer Your API Token");

        response = httpClient.execute(httpGet);

        HttpEntity entity = response.getEntity();

        System.out.println(EntityUtils.toString(entity));

    } finally {

        if(httpGet != null) httpGet.releaseConnection();

        if(response != null) response.close();

    }

   }

}

Request Parameters

Refer to the following table for a list of the required and optional request parameters. All parameter names and values are case sensitive. Important: You must provide all required parameters. Submitting an empty request does not return all possible results, an empty request returns an error.

Parameter Name Value Required? Description
API Token
String
Required
This value is the unique API Token provided during the CareerOneStop Web API registration process
userId
String
Required
This value is the unique UserID provided during the CareerOneStop Web API registration process
keyword
String
Required
Search term for the job search. To request all jobs within a city, a ZIP code, or a state, use keyword "0". An actual keyword is required for nationwide searches. When either keyword is an O*NET code or title, this API will search for jobs matching either that code OR the corresponding title.
location
String Required This value accepts a city, state (Chicago, IL) or state (IL) or ZIP code (61299). Use "US" for a nationwide search.
radius
String Required
The radius, in miles of the job opportunities search area. Applies to searches by city or ZIP code.
days Integer Required Number of days to go back to get the job postings. Use 0 to get all postings, regardless of age.
sortColumns
String Required

This value determines the sort order, that is, by which property (column) the postings are sorted. Valid values are:
0 (default) - sorts by relevance to the search term
jobtitle
company
location
acquisitiondate

sortOrder
String Required

Use this parameter in conjunction with sortColumns to set the order of the results. Valid values are:
0 (default) – use sortOrder=0 with sortColumns=0 to get the most relevant postings first
ASC – ascending; A-Z, or old to new
DESC – descending; Z-A, or new to old

startRow
Integer
Required
Specifies the start row. Allowed values are 0 (first record) to 500.
pageSize
Integer
Required
This value is the number of results to be returned by Web API. Maximum is 250 results.
companyName
String
Optional
Company by which you may want to filter job results. 
locationFilter
String
Optional
Location by which you may want to filter job results. If you provide a value in locationFilter, then that value pre-empts any value in “location” parameter, and we use a radius of “0” (pre-empting any value in the “radius” parameter).
showFilters
boolean
Optional
The flag value to include company and location filter values in the response. True - show filters. False - exclude filters (default).
enableJobDescriptionSnippet
boolean
Optional
Use this parameter to determine whether to include first 250 characters of the job description in the response. True - show snippet. False - exclude snippet (default).
enableMetaData
boolean Optional
Use this parameter to determine whether to include MetaData in the response.
True- Include metadata 
False - exclude metadata (default)

Response Structure

{
  "JobCount": "10000",
  "Jobs": [
    {
      "JvId": "25206ecfe4954376b3943722f89fd1c08003",
      "JobTitle": "Staff Nurse/Charge Nurse",
      "Company": "The PARC Joliet Nursing",
      "DescriptionSnippet": "ITS AN EXCITING TIME AT PEARL PAVILION!!!! Under new management with an incredible team we are looking for someone like you to join us and participate in providing the best possible care that Freeport residents desire. Are you an awesome nurse and lo",
      "AcquisitionDate": "2024-05-28T06:24:04-04:00",
      "URL": "https://de.jobsyn.org/25206ecfe4954376b3943722f89fd1c08003",
      "Location": "Joliet, IL",
      "Fc": false
    },
    {
      "JvId": "7f6f3a72600c4085878258d22d81a9878003",
      "JobTitle": "Registered Nurse/Licensed Practical Nurse",
      "Company": "Haralson Nursing & Rehabilitation Center",
      "DescriptionSnippet": "Salary: $28 - $32 per hour Shift Type: Available Hours: Full-time and Part-time (includes weekend rotation) Morning Shift (7:00 am-7:00 pm) Night Shift (7:00 pm-7:00 am) Benefits: Health Dental Vision Free Life Insurance PTO available Haralson and Re",
      "AcquisitionDate": "2024-05-22T07:00:07-04:00",
      "URL": "https://de.jobsyn.org/7f6f3a72600c4085878258d22d81a9878003",
      "Location": "Bremen, GA",
      "Fc": false
    },
    {
      "JvId": "d1cbdb52e74b4765b80846face358cba8003",
      "JobTitle": "Nurse Aide/ Nurse Assistant",
      "Company": "Grande Center for Post Acute and Nursing LLC",
      "DescriptionSnippet": "Employer:                Grande Center for Post Acute and Nursing LLC(dba Excel Care at Dover)Worksite Phone:        973 361 5200 Worksite Address:     65 North Sussex Street, Dover, NJ 07801  Employer Contact:    Sam Gottlieb, Director of Human Reso",
      "AcquisitionDate": "2024-05-24T01:21:29-04:00",
      "URL": "https://de.jobsyn.org/d1cbdb52e74b4765b80846face358cba8003",
      "Location": "Dover, NJ",
      "Fc": false
    },
    {
      "JvId": "bd0f4e96ae894d97974b04cef8a970688003",
      "JobTitle": "Nurse (Registered Nurse)",
      "Company": "Federal Bureau of Prisons FCC Allenwood",
      "DescriptionSnippet": "Summary Corrections professionals who foster a humane and secure environment and ensure public safety by preparing individuals for successful reentry into our communities. Our highly-skilled, diverse, and innovative workforce creates a strong foundat",
      "AcquisitionDate": "2024-04-10T07:13:57-04:00",
      "URL": "https://de.jobsyn.org/bd0f4e96ae894d97974b04cef8a970688003",
      "Location": "White Deer, PA",
      "Fc": false
    },
    {
      "JvId": "5060f1ee52f54566bd7694c23877efb28003",
      "JobTitle": "Registered Nurse",
      "Company": "The Nurse Connection Staffing",
      "DescriptionSnippet": "NY1498010 REGISTERED PROFESSIONAL NURSE\nFull time and part time positions with The Nurse Connection Staffing. OBJECTIVE:  Provision of professional nursing services in compliance with the New York Nurse Practice Act and any licensure requirement, gov",
      "AcquisitionDate": "2024-05-03T12:08:09-04:00",
      "URL": "https://de.jobsyn.org/5060f1ee52f54566bd7694c23877efb28003",
      "Location": "Utica, NY",
      "Fc": false
    },
    {
      "JvId": "0ab73e6cc58f445da12677a6f554d3c98003",
      "JobTitle": "Nurse Manager",
      "Company": "Tarrytown Rehabilitation & Nursing Center",
      "DescriptionSnippet": "We offer the Following: Premium Compensation Great Benefits Package Fun, Family-Like Team, and Atmosphere! Work in a Beautifully Remodeled Office Professional Growth & Stability Innovative Training Programs Benefits: 401(k) Dental insurance Health in",
      "AcquisitionDate": "2024-05-17T06:27:50-04:00",
      "URL": "https://de.jobsyn.org/0ab73e6cc58f445da12677a6f554d3c98003",
      "Location": "Plattsburgh, NY",
      "Fc": false
    },
    {
      "JvId": "a9ac41ec52f74c4094f549738a1461e58003",
      "JobTitle": "Nurse Manager",
      "Company": "Sodus Rehab & Nursing Center",
      "DescriptionSnippet": "We offer the Following: Premium Compensation Great Benefits Package Fun, Family-Like Team, and Atmosphere! Work in a Beautifully Remodeled Office Professional Growth & Stability Innovative Training Programs Benefits: 401(k) Dental insurance Health in",
      "AcquisitionDate": "2024-05-17T03:29:45-04:00",
      "URL": "https://de.jobsyn.org/a9ac41ec52f74c4094f549738a1461e58003",
      "Location": "Plattsburgh, NY",
      "Fc": false
    },
    {
      "JvId": "d76d5d902e1f4062a8aed6cbc5d6a54d8003",
      "JobTitle": "Registered Nurse",
      "Company": "The Nurse Connection Staffing",
      "DescriptionSnippet": "Registered Nurses Full Time and Part Time Positions- Provision of professional nursing services in compliance with the New York Nurse Practice Act and any licensure requirement, governmental laws and regulations and The Nurse Connection, Inc. policie",
      "AcquisitionDate": "2024-05-28T21:29:16-04:00",
      "URL": "https://de.jobsyn.org/d76d5d902e1f4062a8aed6cbc5d6a54d8003",
      "Location": "Binghamton, NY",
      "Fc": false
    },
    {
      "JvId": "69b9b5819b6b456a9275bfa53bf539ac8003",
      "JobTitle": "Charge Nurse",
      "Company": "Colonial Manor Nursing Home",
      "DescriptionSnippet": "NEW STARTING WAGE & SIGN ON BONUS!!!! Colonial Manor is looking for compassionate & caring Licensed Nurses to join our team. Come be a part of a growing team of family-oriented care providers who are focused on resident centered care, culture change,",
      "AcquisitionDate": "2024-05-22T03:26:03-04:00",
      "URL": "https://de.jobsyn.org/69b9b5819b6b456a9275bfa53bf539ac8003",
      "Location": "Lakefield, MN",
      "Fc": false
    },
    {
      "JvId": "b939e331bca740edb91f0dd08c1438f68003",
      "JobTitle": "Treatment Nurse",
      "Company": "The PARC Joliet Nursing",
      "DescriptionSnippet": "Treating skin reactions Preventing skin breakdown Treating and managing vascular ulcers, pressure ulcers and diabetic ulcers Initiating preventative measures Providing comprehensive wound management, including reducing causative factors, controlling ",
      "AcquisitionDate": "2024-05-28T06:24:04-04:00",
      "URL": "https://de.jobsyn.org/b939e331bca740edb91f0dd08c1438f68003",
      "Location": "Joliet, IL",
      "Fc": false
    }
  ],
  "Locations": null,
  "Companies": null,
  "JobsKeywordLocations": {
    "Keyword": "nurse",
    "Location": "United States",
    "IsValidLocation": true,
    "Radius": "25",
    "StartRow": "0",
    "EndRow": "10",
    "IsCode": false,
    "Title": "",
    "LocationState": "United States"
  },
  "MetaData": {
    "Publisher": "CareerOneStop publishes this API (www.careeronestop.org/Developers/WebAPI/web-api.aspx)",
    "Sponsor": "U.S. Department of Labor, Employment and Training Administration",
    "LastAccessDate": "2024-07-05T15:10:11",
    "CitationSuggested": "This data is delivered by an API from CareerOneStop, sponsored by U.S. Department of Labor, Employment and Training Administration.  www.careeronestop.org Job postings come from NLx (www.usnlx.com), by the National Labor Exchange, which is co-sponsored by the Direct Employers Association (www.directemployers.org) and the National Association of State Workforce Agencies (www.naswa.org).",
    "DataSource": [
      {
        "DataName": "NLx job postings",
        "DataSourceName": "NLx, National Labor Exchange",
        "DataSourceUrl": "http://nlx.org/",
        "DataLastUpdate": "Rolling (via API)",
        "DataVintageOrVersion": "Rolling (via API)",
        "DataDescription": "Job postings come from NLx (www.usnlx.com), by the National Labor Exchange, which is co-sponsored by the Direct Employers Association (www.directemployers.org) and the National Association of State Workforce Agencies (www.naswa.org). The data include jobs posted on state job banks as well as by private employers. ",
        "DataSourceCitation": "Job postings come from NLx (www.usnlx.com), by the National Labor Exchange, which is co-sponsored by the Direct Employers Association (www.directemployers.org) and the National Association of State Workforce Agencies (www.naswa.org)."
      }
    ]
  }
}

<ListJobSearchInternal>xmlns:i="http://www.w3.org/2001/XMLSchema-instance"   <xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels"><Companies i:nil="true"/>
<JobCount>10000</JobCount>
<Jobs>
<Jobs>
<AcquisitionDate>2024-05-28T06:24:04-04:00</AcquisitionDate>
<Company>The PARC Joliet Nursing</Company>
<DescriptionSnippet>ITS AN EXCITING TIME AT PEARL PAVILION!!!! Under new management with an incredible team we are looking for someone like you to join us and participate in providing the best possible care that Freeport residents desire. Are you an awesome nurse and lo</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Staff Nurse/Charge Nurse</JobTitle>
<JvId>25206ecfe4954376b3943722f89fd1c08003</JvId>
<Location>Joliet, IL</Location>
<URL>https://de.jobsyn.org/25206ecfe4954376b3943722f89fd1c08003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-22T07:00:07-04:00</AcquisitionDate>
<Company>Haralson Nursing &amp; Rehabilitation Center</Company>
<DescriptionSnippet>Salary: $28 - $32 per hour Shift Type: Available Hours: Full-time and Part-time (includes weekend rotation) Morning Shift (7:00 am-7:00 pm) Night Shift (7:00 pm-7:00 am) Benefits: Health Dental Vision Free Life Insurance PTO available Haralson and Re</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Registered Nurse/Licensed Practical Nurse</JobTitle>
<JvId>7f6f3a72600c4085878258d22d81a9878003</JvId>
<Location>Bremen, GA</Location>
<URL>https://de.jobsyn.org/7f6f3a72600c4085878258d22d81a9878003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-24T01:21:29-04:00</AcquisitionDate>
<Company>Grande Center for Post Acute and Nursing LLC</Company>
<DescriptionSnippet>Employer: Grande Center for Post Acute and Nursing LLC(dba Excel Care at Dover)Worksite Phone: 973 361 5200 Worksite Address: 65 North Sussex Street, Dover, NJ 07801 Employer Contact: Sam Gottlieb, Director of Human Reso</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Nurse Aide/ Nurse Assistant</JobTitle>
<JvId>d1cbdb52e74b4765b80846face358cba8003</JvId>
<Location>Dover, NJ</Location>
<URL>https://de.jobsyn.org/d1cbdb52e74b4765b80846face358cba8003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-04-10T07:13:57-04:00</AcquisitionDate>
<Company>Federal Bureau of Prisons FCC Allenwood</Company>
<DescriptionSnippet>Summary Corrections professionals who foster a humane and secure environment and ensure public safety by preparing individuals for successful reentry into our communities. Our highly-skilled, diverse, and innovative workforce creates a strong foundat</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Nurse (Registered Nurse)</JobTitle>
<JvId>bd0f4e96ae894d97974b04cef8a970688003</JvId>
<Location>White Deer, PA</Location>
<URL>https://de.jobsyn.org/bd0f4e96ae894d97974b04cef8a970688003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-03T12:08:09-04:00</AcquisitionDate>
<Company>The Nurse Connection Staffing</Company>
<DescriptionSnippet>
<NY1498010 REGISTERED PROFESSIONAL NURSE
<Full time and part time positions with The Nurse Connection Staffing. OBJECTIVE: Provision of professional nursing services in compliance with the New York Nurse Practice Act and any licensure requirement, gov
</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Registered Nurse</JobTitle>
<JvId>5060f1ee52f54566bd7694c23877efb28003</JvId>
<Location>Utica, NY</Location>
<URL>https://de.jobsyn.org/5060f1ee52f54566bd7694c23877efb28003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-17T06:27:50-04:00</AcquisitionDate>
<Company>Tarrytown Rehabilitation &amp; Nursing Center</Company>
<DescriptionSnippet>We offer the Following: Premium Compensation Great Benefits Package Fun, Family-Like Team, and Atmosphere! Work in a Beautifully Remodeled Office Professional Growth &amp; Stability Innovative Training Programs Benefits: 401(k) Dental insurance Health in</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Nurse Manager</JobTitle>
<JvId>0ab73e6cc58f445da12677a6f554d3c98003</JvId>
<Location>Plattsburgh, NY</Location>
<URL>https://de.jobsyn.org/0ab73e6cc58f445da12677a6f554d3c98003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-17T03:29:45-04:00</AcquisitionDate>
<Company>Sodus Rehab &amp; Nursing Center</Company>
<DescriptionSnippet>We offer the Following: Premium Compensation Great Benefits Package Fun, Family-Like Team, and Atmosphere! Work in a Beautifully Remodeled Office Professional Growth &amp; Stability Innovative Training Programs Benefits: 401(k) Dental insurance Health in</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Nurse Manager</JobTitle>
<JvId>a9ac41ec52f74c4094f549738a1461e58003</JvId>
<Location>Plattsburgh, NY</Location>
<URL>https://de.jobsyn.org/a9ac41ec52f74c4094f549738a1461e58003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-28T21:29:16-04:00</AcquisitionDate>
<Company>The Nurse Connection Staffing</Company>
<DescriptionSnippet>Registered Nurses Full Time and Part Time Positions- Provision of professional nursing services in compliance with the New York Nurse Practice Act and any licensure requirement, governmental laws and regulations and The Nurse Connection, Inc. policie</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Registered Nurse</JobTitle>
<JvId>d76d5d902e1f4062a8aed6cbc5d6a54d8003</JvId>
<Location>Binghamton, NY</Location>
<URL>https://de.jobsyn.org/d76d5d902e1f4062a8aed6cbc5d6a54d8003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-22T03:26:03-04:00</AcquisitionDate>
<Company>Colonial Manor Nursing Home</Company>
<DescriptionSnippet>NEW STARTING WAGE &amp; SIGN ON BONUS!!!! Colonial Manor is looking for compassionate &amp; caring Licensed Nurses to join our team. Come be a part of a growing team of family-oriented care providers who are focused on resident centered care, culture change,</DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Charge Nurse</JobTitle>
<JvId>69b9b5819b6b456a9275bfa53bf539ac8003</JvId>
<Location>Lakefield, MN</Location>
<URL>https://de.jobsyn.org/69b9b5819b6b456a9275bfa53bf539ac8003</URL>
</Jobs>
<Jobs>
<AcquisitionDate>2024-05-28T06:24:04-04:00</AcquisitionDate>
<Company>The PARC Joliet Nursing</Company>
<DescriptionSnippet>Treating skin reactions Preventing skin breakdown Treating and managing vascular ulcers, pressure ulcers and diabetic ulcers Initiating preventative measures Providing comprehensive wound management, including reducing causative factors, controlling </DescriptionSnippet>
<Fc>false</Fc>
<JobTitle>Treatment Nurse</JobTitle>
<JvId>b939e331bca740edb91f0dd08c1438f68003</JvId>
<Location>Joliet, IL</Location>
<URL>https://de.jobsyn.org/b939e331bca740edb91f0dd08c1438f68003</URL>
</Jobs>
</Jobs>
<JobsKeywordLocations>
<EndRow>10</EndRow>
<IsCode>false</IsCode>
<IsValidLocation>true</IsValidLocation>
<Keyword>nurse</Keyword>
<Location>United States</Location>
<LocationState>United States</LocationState>
<Radius>25</Radius>
<StartRow>0</StartRow>
<Title/>
</JobsKeywordLocations>
<Locations i:nil="true"/>
<MetaData
<xmlns:d2p1="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.Core.MetaData">
<d2p1:CitationSuggested>This data is delivered by an API from CareerOneStop, sponsored by U.S. Department of Labor, Employment and Training Administration. www.careeronestop.org Job postings come from NLx (www.usnlx.com), by the National Labor Exchange, which is co-sponsored by the Direct Employers Association (www.directemployers.org) and the National Association of State Workforce Agencies (www.naswa.org).</d2p1:CitationSuggested>
<d2p1:DataSource>
<d2p1:MetaDataSource>
<d2p1:DataDescription>Job postings come from NLx (www.usnlx.com), by the National Labor Exchange, which is co-sponsored by the Direct Employers Association (www.directemployers.org) and the National Association of State Workforce Agencies (www.naswa.org). The data include jobs posted on state job banks as well as by private employers. </d2p1:DataDescription>
<d2p1:DataLastUpdate>Rolling (via API)</d2p1:DataLastUpdate>
<d2p1:DataName>NLx job postings</d2p1:DataName>
<d2p1:DataSourceCitation>Job postings come from NLx (www.usnlx.com), by the National Labor Exchange, which is co-sponsored by the Direct Employers Association (www.directemployers.org) and the National Association of State Workforce Agencies (www.naswa.org).</d2p1:DataSourceCitation>
<d2p1:DataSourceName>NLx, National Labor Exchange</d2p1:DataSourceName>
<d2p1:DataSourceUrl>http://nlx.org/</d2p1:DataSourceUrl>
<d2p1:DataVintageOrVersion>Rolling (via API)</d2p1:DataVintageOrVersion>
</d2p1:MetaDataSource>
</d2p1:DataSource>
<d2p1:LastAccessDate>2024-07-05T15:32:03</d2p1:LastAccessDate>
<d2p1:Publisher>CareerOneStop publishes this API (www.careeronestop.org/Developers/WebAPI/web-api.aspx)</d2p1:Publisher>
<d2p1:Sponsor>U.S. Department of Labor, Employment and Training Administration</d2p1:Sponsor>
</MetaData>
</ListJobSearchInternal>

Response Parameters

Name
Description
Type
Parent
Jobcount
Count of the search results
String
Empty Cell
Jobs
The list of job postings resulting from this search
List of Objects
Empty Cell
JvId
ID for this job posting
String
Jobs
JobTitle
Job title
String
Jobs
Company
Company posting this job
String
Jobs
DescriptionSnippet
First 250 characters of the job description
String
Jobs
AcquisitionDate
Acquisition date and time for this job posting at NLX, in UTC (universal coordinated time). Consider converting to your local time zone.
String
Jobs
URL
URL at which you can apply for this posting
String
Jobs
Location
Geographic location of this job
String
Jobs
Fc
If the company posting this job is a federal contractor, Fc is True; otherwise, Fc is False.
Boolean
Jobs
Locations
Locations that are represented in the search results; included in response if showFilters request parameter is set to True
List of Objects
Empty Cell
LocationName
Location name
String
Locations
LocationCount
Number of results in this location
String
Locations
LocationValue
Updated version of response parameter LocationName. Allows filter by location names that include special characters.
String
Locations
Companies
Companies that are represented in the search results; included in response if showFilters request parameter is set to True
List of Objects
Empty Cell
CompanyName
Company name; can be used as a filter in a subsequent search
String
Companies
JobCount
Number of results in this company
String
Companies
CompanyValue
Updated version of response parameter CompanyName. Allows filter by company names that include special characters.
String
Companies
JobsKeywordLocations
Information about the request
Object
Empty Cell
Keyword
Keyword (search term)
String
JobsKeywordLocations
Location
Location given in the request
String
JobsKeywordLocations
IsValidLocation
Is the location valid?
Boolean
JobsKeywordLocations
Radius
Radius
String
JobsKeywordLocations
StartRow
Start Row
String
JobsKeywordLocations
EndRow
End Row
String
JobsKeywordLocations
IsCode
Is keyword (search term) an occupation code? 
Boolean
JobsKeywordLocations
Title
If keyword (search term) is an occupation code, then this parameter is the corresponding occupation title
String
JobsKeywordLocations
LocationState
If location is a state, this field is the full name of that state. If location is city or ZIP, this field is null
String
JobsKeywordLocations
MetaData
Information about the source of the API
Object
Empty Cell
Publisher
Publisher of the API
String
MetaData
Sponsor
Sponsor of the API
String
MetaData
LastAccessDate           
 When the API was run, using UTC (ISO 8601) format
String
MetaData
CitationSuggested
If you use this data, CareerOneStop suggests you use this citation.
String
MetaData
DataSource
The data source object(s)
List of Objects
MetaData
DataName
Name of data
String
DataSource
DataSourceName
Name of data source
String
DataSource
DataSourceUrl
Url of data source
String
DataSource
DataLastUpdate
Date when CareerOneStop last updated this data
String
DataSource
DataVintageOrVersion
Version or vintage of the data
String
DataSource
DataDescription
Description of the data
String
DataSource
DataSourceCitation
Suggested citation for this data source
String
DataSource

Errors

Error/Status Code Description
 200
OK / Success. The request went through successfully and there is a response body.
 400
Bad Request (Request was invalid or missing parameters)
 401    
Unauthorized. This error occurs specifically when authentication is required and has failed or has not yet been provided correctly. (ex: Invalid API Token)
 404
This error will be shown in two scenarios 1) Not found - (An error occurred) and 2) Not found - (No data available)
 500
Internal Server Error. This error will occur when there is something critically wrong in the API call.