Skip to Content
CareerOneStop
Technical Information
API Explorer American Job Centers Apprenticeships Boards and Committees Certifications Employment Patterns Job Description Writer Jobs V2 Labor Market Information Licenses Locations Occupations Occupations Reports Professional Associations ReEntry Programs Salaries Skills Gaps Skills Matcher State Resources Tools and Technology Training Unemployment Youth Programs

List Occupations by Keyword

GET
/v1/occupation/{userId}/{keyword}/{dataLevelOnly}/{startRecord}/{limitRecord}
Parameters
string


api token is required field
string


userId is required field
string

ex: nurse or 13-2011.00

keyword is required field
string

ex: Y or N

dataLevelOnly is required field
integer

ex: 0

startRecord is required field
integer

ex: 10

limitRecord is required field
string

ex: onet, soc, socoes, socmat

string

ex: title or code or default value is 0 for keyword search

  TECHNICAL INFORMATION

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["datasettype"] = "value";                        
            qs["searchby"] = "value";                        
            
            var uri = new UriBuilder(Uri.UriSchemeHttps, "api.careeronestop.org")
            {
                Path = "/v1/occupation/{userId}/{keyword}/{dataLevelOnly}/{startRecord}/{limitRecord}",
                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", "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("/v1/occupation/{userId}/{keyword}/{dataLevelOnly}/{startRecord}/{limitRecord}")
                .setParameter("datasettype", "value")
                .setParameter("searchby", "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 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();
	}
   }
}


Response Structure 
                        {
  "RecordCount": 1,
  "DidYouMean": "string",
  "AutoCorrection": "string",
  "Request": {
    "InputOccupation": "string",
    "InputOccupationCode": "string",
    "InputOccupationTitle": "string"
  },
  "OccupationList": [
    {
      "OnetTitle": "string",
      "OnetCode": "string",
      "OccupationDescription": "string"
    }
  ],
  "SocOccupationList": [
    {
      "Title": "string",
      "Code": "string",
      "Description": "string"
    }
  ],
  "SocOesOccupationList": [
    {
      "Title": "string",
      "Code": "string",
      "Description": "string"
    }
  ],
  "SocMatOccupationList": [
    {
      "Title": "string",
      "Code": "string",
      "Description": "string"
    }
  ]
}
                    
                        <OccupationsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels">
  <AutoCorrection>string</AutoCorrection>
  <DidYouMean>string</DidYouMean>
  <OccupationList>
    <OccupationDetail>
      <OccupationDescription>string</OccupationDescription>
      <OnetCode>string</OnetCode>
      <OnetTitle>string</OnetTitle>
    </OccupationDetail>
  </OccupationList>
  <RecordCount>1</RecordCount>
  <Request>
    <InputOccupation>string</InputOccupation>
    <InputOccupationCode>string</InputOccupationCode>
    <InputOccupationTitle>string</InputOccupationTitle>
  </Request>
  <SocMatOccupationList>
    <SocOccupationInfo>
      <Code>string</Code>
      <Description>string</Description>
      <Title>string</Title>
    </SocOccupationInfo>
  </SocMatOccupationList>
  <SocOccupationList>
    <SocOccupationInfo>
      <Code>string</Code>
      <Description>string</Description>
      <Title>string</Title>
    </SocOccupationInfo>
  </SocOccupationList>
  <SocOesOccupationList>
    <SocOccupationInfo>
      <Code>string</Code>
      <Description>string</Description>
      <Title>string</Title>
    </SocOccupationInfo>
  </SocOesOccupationList>
</OccupationsList>