Overview

Introduction

The Occupational Earnings API provides real-time aggregation of occupational earnings percentiles and estimates of the number of jobs at or below a certain wage. The latest four dataruns are available for querying (for example, if 2024.3 is the latest, you can access 2023.4, 2024.1, 2024.2, and 2024.3).

Note: By default, all clients are allowed a maximum of 5 requests per second. Contact us if you require higher limits.

📑Latest OpenAPI Specification

Request Headers

(*) Indicates the action to be required

All requests must include the following headers:

Header Key	Value	Description
*Authorization	Bearer `<ACCESS_TOKEN>`	This is the token obtained from the Authentication API. Include it in this header to authorize the request. (This must be included in all authenticated requests)
Content-Type	application/json	Required for endpoints that accept a request body. Specifies that the body is in JSON format.

Authentication

All endpoints in this category require an OAuth 2.0 Bearer Token for authentication. Tokens are granted through Lightcast’s Authentication API and are valid for 1 hour.

To access the Occupational Earnings API, the token must include the following scope:

occearn (for access to occupational earnings data)

Sample Request

curl --request POST \
  --url https://auth.emsicloud.com/connect/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data client_id=CLIENT_ID \
  --data client_secret=CLIENT_SECRET \
  --data grant_type=client_credentials \
  --data scope=occearn

Request Parameters

Parameter	Type	Description
client_id	string	The client ID provided by Lightcast.
client_secret	string	The client secret associated with your client ID.
grant_type	string	Must be set to `client_credentials`.
scope	string	Use `occearn` based on your access.

Sample Response

{
  "access_token": "<ACCESS_TOKEN>",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Note that the Tokens expire after 3600 seconds. To maintain uninterrupted access, refresh the token before it expires. To know more about this, refer to the Authentication guide.

Response Parameters

Parameter	Type	Description
access_token	string	The token used to authorize the API requests.
expires_in	integer	Number of seconds before the token expires.
token_type	string	Indicates the type of token. (Always Bearer).

Status Code Summary

Code	Meaning	Description
200	OK	Request was successful.
400	Bad Request	The request was unacceptable, often due to missing a required parameter.
401	Unauthorized	Authentication error.
404	Not Found	Resource not found.