An official website of the United States government
United States Department of Labor
United States Department of Labor
The .gov means it's official.
Federal government websites often end in .gov or .mil. Before sharing sensitive information,
make sure you're on a federal government site.
The site is secure.
The
https:// ensures that you are connecting to the official website and that any
information you provide is encrypted and transmitted securely.
BLS Public Data API Signatures (Version 2.0)The BLS Public Data API utilizes the following three signatures:
All signatures must include an HTTP type, a RESTful URL, and at least one series ID. The series ID(s) can include an underscore (_), dash (-) and hash (#), but must not include lower case letters or special characters. All requests specifying years must include a four-digit start and end year in numeric format (e.g. YYYY). The following are sample responses for each of API signature with added white spaces for easier readability. Single SeriesUse this signature to retrieve data for a single time series for the past three years. Be sure to include the specific series ID at the end of the URL. Parameters are optional.:
Sample JSON Response: {
"status": "REQUEST_SUCCEEDED",
"responseTime": 16,
"message": [
],
"Results": [
{
"series": [
{
"seriesID": "LAUCN040010000000005",
"data": [
{
"year": "2013",
"period": "M11",
"periodName": "November",
"value": "16393",
"footnotes": [
{
"code": "P",
"text": "Preliminary."
}
]
},
{
"year": "2013",
"period": "M10",
"periodName": "October",
"value": "16536",
"footnotes": [
{
...
}
]
}
]
}
]
}
]
}
Multiple SeriesUse this signature to retrieve data for more than one timeseries for the past three years. Registered users can include up to 50 series IDs, each separated with a comma, in the body of a request.
Sample Response: {
"status": "REQUEST_SUCCEEDED",
"responseTime": 37,
"message": [ ],
"Results": [
{
"series": [
{
"seriesID": "LAUCN040010000000005",
"data": [
{
"year": "2013",
"period": "M11",
"periodName": "November",
"value": "16393",
"footnotes": [
{
"code": "P",
"text": "Preliminary."
}
],
. . .
{
"seriesID": "LAUCN040010000000006",
"data": [
{
"year": "2013",
"period": "M11",
"periodName": "November",
"value": "20155",
"footnotes": [
{
"code": "P",
"text": "Preliminary."
}
],
. . .
}
Sample of a JSON Response: {
"status": "REQUEST_SUCCEEDED",
"responseTime": 37,
"message": [ ],
"Results": [
{
"series": [
{
"seriesID": "LAUCN040010000000005",
"data": [
{
"year": "2013",
"period": "M11",
"periodName": "November",
"value": "16393",
"footnotes": [
{
"code": "P",
"text": "Preliminary."
}
],
. . .
{
"seriesID": "LAUCN040010000000006",
"data": [
{
"year": "2013",
"period": "M11",
"periodName": "November",
"value": "20155",
"footnotes": [
{
"code": "P",
"text": "Preliminary."
}
],
. . .
}
One or More Series with Optional ParametersUse this signature to retrieve data for one or more timeseries within a set time frame of up to 20 years. This signature also provides the option of retrieving calculations, annual averages, aspects, and catalog data. To retrieve these optional parameters, users must include their assigned registration key. Unless otherwise specified, the Users should also include at least one series ID, the start year, and the end year in the body of the request. If you include multiple series IDs, be sure to separate each with a comma.
Sample Response: {
"status": "REQUEST_SUCCEEDED",
"responseTime": 706,
"message": [ ],
"Results": [
{
"series": [{
"seriesID": "WMU00140201020000001300002500",
"catalog": {
"series_title": "Average hourly wage for business and financial operations occupations, full-time, in Bloomington, IN",
"series_id": "WMU00140201020000001300002500",
"seasonality": "Not Seasonally Adjusted",
"survey_name": "Modeled Wage Estimates",
"survey_abbreviation": "WM",
"measure_data_type": "Average Hourly Wage",
"commerce_industry": "All industries",
"occupation": "Business and Financial Operations Occupations",
"occupation_work_class": "Civilian workers",
"area": "Bloomington, IN"
},
"data": [{
"year": "2018",
"period": "A01",
"periodName": "Annual",
"latest": "true",
"value": "30.71",
"aspects": [{
"name": "Relative Standard Error",
"value": "1.9",
"footnotes": [{}]
}],
"footnotes": [{}]
}]
},
. . .
}
Latest Series DataUse this signature to retrieve the most recent data point for a given BLS series ids.
Sample JSON Response: {
"status":"REQUEST_SUCCEEDED",
"responseTime":253,
"message":[],
"Results": {
"series": [
{
"seriesID":"LAUCN040010000000005",
"data":[
{
"year": "2013",
"period": "M11",
"periodName": "November",
"latest": "true",
"value": "16393",
"footnotes": [
{
"code": "P",
"text": "Preliminary."
}
]
}]
]
}
}
Popular SeriesUse this signature to retrieve a list of series IDs for the 25 most popular BLS and survey-specific series. Parameters for retrieving series IDs for survey-specific series are optional.
Sample JSON Response: {"status":"REQUEST_SUCCEEDED","responseTime":29,"message":[],"Results":{
"series":
[{"seriesID":"LNS14000000"},
{"seriesID":"CUUR0000SA0"},
{"seriesID":"CES0000000001"},
{"seriesID":"LNS14000006"},
{"seriesID":"CUSR0000SA0"},
{"seriesID":"LNS11300000"},
{"seriesID":"CUUR0000SA0L1E"},
{"seriesID":"CES3000000001"},
{"seriesID":"CES0500000003"},
{"seriesID":"LNU04000000"},
{"seriesID":"PCU327320327320"},
{"seriesID":"PCU33312033312014"},
{"seriesID":"LNS12000000"},
{"seriesID":"CUSR0000SA0L1E"},
{"seriesID":"CUUR0000SAM1"},
{"seriesID":"CUUR0000SEMC01"},
{"seriesID":"LNS12300000"},
{"seriesID":"LNS12035019"},
{"seriesID":"CUUR0000SEMC"},
{"seriesID":"CUUR0000SS5702"},
{"seriesID":"CUUR0000SS5703"},
{"seriesID":"CUUR0000SEMC02"},
{"seriesID":"CES0500000001"},
{"seriesID":"CUUR0100SEMC"},
{"seriesID":"CUUR0100SAM1"}]
}}
Sample JSON Response: {"status":"REQUEST_SUCCEEDED","responseTime":38,"message":[],"Results":{
"series":
[{"seriesID":"LASST060000000000003"},
{"seriesID":"LASST260000000000003"},
{"seriesID":"LASST480000000000003"},
{"seriesID":"LASST340000000000003"},
{"seriesID":"LASST120000000000003"},
{"seriesID":"LASST360000000000003"},
{"seriesID":"LASST420000000000003"},
{"seriesID":"LASST210000000000003"},
{"seriesID":"LASST080000000000003"},
{"seriesID":"LASST370000000000003"},
{"seriesID":"LASST180000000000003"},
{"seriesID":"LASST390000000000003"},
{"seriesID":"LASST550000000000003"},
{"seriesID":"LASST170000000000003"},
{"seriesID":"LASST010000000000003"},
{"seriesID":"LASST130000000000003"},
{"seriesID":"LASST040000000000003"},
{"seriesID":"LASST280000000000003"},
{"seriesID":"LASST510000000000003"},
{"seriesID":"LASST530000000000003"},
{"seriesID":"LASST250000000000003"},
{"seriesID":"LASST270000000000003"},
{"seriesID":"LASST290000000000003"},
{"seriesID":"LASST320000000000003"},
{"seriesID":"LASST470000000000003"}]
}}
All SurveysUse this signature to retrieve a list of all BLS surveys.
Sample JSON Response: {
"status":"REQUEST_SUCCEEDED",
"responseTime":424,
"message":[],
"Results": {
"survey": [
{
"survey_abbreviation": "AP",
"survey_name": "Consumer Price Index - Average Price Data"
},
{
"survey_abbreviation": "BD",
"survey_name": "Business Employment Dynamics"
},
{
"survey_abbreviation": "BG",
"survey_name": "Collective Bargaining Agreements-State and Local Government"
},
{
"survey_abbreviation": "BP",
"survey_name": "Collective Bargaining Agreements-Private Sector"
},
]
}
}
Single SurveyUse this signature to retrieve the metadata associated with a single BLS survey. Be sure to include the specific survey abbreviation.
Sample JSON Response: {
"status":"REQUEST_SUCCEEDED",
"responseTime":46,
"message":[],
"Results":{
"survey": [{
"survey_name":"American Time Use",
"survey_abbreviation":"TU",
"allowsNetChange":"false",
"allowsPercentChange":"false",
"hasAnnualAverages":"false"
}]
}
}
To help you get started, sample code for some of the most popular programming languages has been written:
Last Modified Date: October 5, 2020 |
