SCC Web Services

The SCC Web Services provides an interface to the terms and descriptions that are related to Source Classification Codes (SCC) found in the Terminology Services (TS) registry.

The web services provided allow searching for SCCs by name or facet, as well as querying an SCC by its code. JSON, XML, or CSV output is returned.

Query Services

Swagger Specification

Search SCCs by Facet

GET /SCC

Summary

This service queries SCCs by one or more facet. When searching a facet, all four facet parameters (facetName[], facetValue[], facetQualifier[], facetMatchType[]) must be supplied.

Parameters

Name	Description
facetName[]	The name of the facet to search. Multiple facet names may be passed, separated by double pipe characters (||). Possible facet names include: Activity Value Required?, Code, Data Category, ERT Valid, History, Last Updated Date, SCC Level Four, SCC Level One, SCC Level Three, SCC Level Two, Sector, Status, Tier 1 Code, Tier 1 Description, Tier 2 Code, Tier 2 Description, Tier 3 Code, Tier 3 Description
facetValue[]	The value to search for the specified facetName. Multiple values may be passed, separated by double pipe characters (||).
facetQualifier[]	The qualifier to use when searching the specified facetName. Possible values: contains, begins, exact. If omitted, contains is used by default.
facetMatchType[]	The type of match to perform when searching. Possible values: all_words, any_word, whole_phrase. If omitted, all_words is used by default.
lastUpdatedSince	The date on or after which the SCC has been modified. If omitted, SCCs will not be filtered by date.
sortFacet	The facet to sort results by. If omitted, the results are sorted by code.
pageNum	The page number of results to show. pageSize must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
pageSize	The number of results to show per page. pageNum must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
format	The output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filename	The filename used. Only used when CSV format is requested.

Results Sample

[
	{
	    "uid": "4358565",
		"code": "2805040000",
		"lastUpdated": "Jan 16, 2018 12:23:26 AM",
    	"createdDate": "Aug 8, 2017 7:09:26 PM",
		"attributes": {
			"activity value required?": {
				"uid": "4314358",
				"text": "No"
			},
			"data category": {
				"uid": "4112945",
				"text": "Nonpoint"
			},
			"last updated date": {
				"text": "4/21/2015"
			},
			"scc level four": {
				"uid": "4342730",
				"text": "Total"
			},
			"scc level one": {
				"uid": "4341160",
				"text": "Miscellaneous Area Sources"
			},
			"scc level three": {
				"uid": "4341680",
				"text": "Sheep and Lambs Waste Emissions"
			},
			"scc level two": {
				"uid": "4341250",
				"text": "Agriculture Production - Livestock"
			},
			"sector": {
				"uid": "4113010",
				"text": "Agriculture - Livestock Waste"
			},
			"short name": {
				"text": "Sheep and Lambs Waste Emissions; Total"
			},
			"status": {
				"uid": "4154330",
				"text": "Active"
			},
			"tier 1/2/3": {
				"uid": "4357346",
				"text": "14 Miscellaneous/01 Agriculture & Forestry/02 Agricultural Livestock"
			}
		},
		"matchedAttributes": [
			"short name"
		]
	}
]

SCC detail by code

GET /SCC/{code}

Summary

This service queries SCCs by code.

Parameters

Name	Description
format	The output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.

Results Sample

{
	"uid": "4360437",
	"code": "2303020000",
	"lastUpdated": "Aug 8, 2017 7:10:14 PM",
	"createdDate": "Aug 8, 2017 7:10:14 PM",
	"attributes": {
		"activity value required?": {
			"uid": "4314358",
			"text": "No"
		},
		"data category": {
			"uid": "4112945",
			"text": "Nonpoint"
		},
		"last updated date": {
			"text": "3/14/2012"
		},
		"scc level four": {
			"uid": "4342730",
			"text": "Total"
		},
		"scc level one": {
			"uid": "4341156",
			"text": "Industrial Processes"
		},
		"scc level three": {
			"uid": "4341623",
			"text": "Iron and Steel Foundries"
		},
		"scc level two": {
			"uid": "4341202",
			"text": "Primary Metal Production: SIC 33"
		},
		"sector": {
			"uid": "4112991",
			"text": "Industrial Processes - Ferrous Metals"
		},
		"status": {
			"uid": "4154330",
			"text": "Active"
		},
		"tier 1/2/3": {
			"uid": "4355239",
			"text": "05 Metals Processing/02 Ferrous Metals Processing/01 Primary"
		}
	}
}

Search SCC Hierarchy Item by Facet or Level

GET /SCCHierarchyItem

Summary

This service queries SCC hierarchy items by facet or level.

Parameters

Name	Description
level[]	Level of the SCC hierarchy item. Possible values: 1, 2, 3, 4. Multiple values are allowed.
facetName[]	The name of the facet to search. Multiple facet names may be passed, separated by double pipe characters (||). Possible facet names include: Activity Value Required?, Code, Data Category, ERT Valid, History, Last Updated Date, SCC Level Four, SCC Level One, SCC Level Three, SCC Level Two, Sector, Status, Tier 1 Code, Tier 1 Description, Tier 2 Code, Tier 2 Description, Tier 3 Code, Tier 3 Description
facetValue[]	The value to search for the specified facetName. Multiple values may be passed, separated by double pipe characters (||).
facetQualifier[]	The qualifier to use when searching the specified facetName. Possible values: contains, begins, exact. If omitted, contains is used by default.
facetMatchType[]	The type of match to perform when searching. Possible values: all_words, any_word, whole_phrase. If omitted, all_words is used by default.
pageNum	The page number of results to show. pageSize must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
pageSize	The number of results to show per page. pageNum must also be specified; otherwise both parameters are ignored. If omitted, the full result set is returned.
format	The output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filename	The filename used. Only used when CSV format is requested.

Results Sample

[
	{
		"name": "Brick Kilns",
		"level": 1
	},
	{
		"name": "Domestic Ammonia",
		"level": 1
	},
	{
		"name": "External Combustion",
		"level": 1
	},
	{
		"name": "External Combustion Boilers",
		"level": 1
	}
]

List All SCC Lookup Element Types

GET /LookupElementType

Summary

This service queries all available SCC lookup types and attributes. This can be used to determine exactly which facets are searchable.

Parameters

Name	Description
format	The output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filename	The filename used. Only used when CSV format is requested.

Results Sample

[
	{
		"id": "1006127",
		"name": "activity value required?"
	},
	{
		"name": "code description"
	},
	{
		"id": "1005801",
		"name": "data category"
	},
	{
		"id": "1006128",
		"name": "ert valid"
	},
	{
		"name": "history"
	},
	{
		"name": "last inventory year"
	},
	{
		"name": "last updated date"
	},
	{
		"name": "map to"
	},
	{
		"name": "option group"
	},
	{
		"name": "option set"
	},
	{
		"id": "1006163",
		"name": "scc level four"
	},
	{
		"id": "1006160",
		"name": "scc level one"
	},
	{
		"id": "1006162",
		"name": "scc level three"
	},
	{
		"id": "1006161",
		"name": "scc level two"
	},
	{
		"id": "1005802",
		"name": "sector"
	},
	{
		"name": "short name"
	},
	{
		"id": "1005900",
		"name": "status"
	},
	{
		"id": "1006181",
		"name": "tier 1/2/3"
	},
	{
		"name": "usage notes"
	}
]

List All SCC Lookup Elements by ID

GET /LookupElement/{ID}

Summary

This service queries all SCC lookup elements of a specific lookup element type ID. See the /LookupElementType service to determine lookup element type IDs. This can be used to populate a list of options for a filtering on one or more facets; for example, a filter on data category.

Parameters

Name	Description
lastUpdatedSince	The date on or after which the lookup element has been modified. If omitted, lookup elements will not be filtered by date.
format	The output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filename	The filename used. Only used when CSV format is requested.

Results Sample

[
	{
		"uid": "4340903",
		"code": "Biogenic",
		"lastUpdated": "Jun 16, 2017 1:02:22 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "B"
			},
			"last update in eis": {
				"text": "5/22/2009 7:05:33 AM"
			}
		}
	},
	{
		"uid": "4340902",
		"code": "Facility Inventory",
		"lastUpdated": "Jun 16, 2017 1:01:07 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",		
		"attributes": {
			"data category code": {
				"text": "FI"
			}
		}
	},
	{
		"uid": "4112948",
		"code": "Event",
		"lastUpdated": "Jun 16, 2017 12:52:42 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "E"
			},
			"definition": {
				"text": "Include fires that are reported in a day-specific format: wildfires and prescribed burns. Note that agricultural fires are included in non-point sources as an annual sum for a county."
			}
		}
	},
	{
		"uid": "4112945",
		"code": "Nonpoint",
		"lastUpdated": "Jun 16, 2017 12:52:57 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "NP"
			},
			"definition": {
				"text": "Include sources that individually are too small in magnitude to report as point sources. Examples include residential heating, residential charcoal grilling, asphalt paving, and commercial and consumer solvent use."
			}
		}
	},
	{
		"uid": "4112939",
		"code": "Point",
		"lastUpdated": "Jun 16, 2017 12:55:36 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "P"
			},
			"definition": {
				"text": "Include sources (usually large) that are located at a fixed, stationary location. Point sources in the NEI include large industrial facilities and electric power plants, airports, and smaller industrial, non-industrial and commercial facilities. The emissions potential of each facility determines whether that facility should be reported as a point source, according to emissions thresholds set in the Air Emissions Reporting Rule (AERR)."
			}
		}
	},
	{
		"uid": "4112946",
		"code": "Onroad",
		"lastUpdated": "Jun 16, 2017 12:54:17 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "ON"
			},
			"definition": {
				"text": "Include on-road vehicles that use gasoline, diesel, and other fuels. On-road vehicles include light duty and heavy duty vehicles operating on roads, highway ramps, and during idling."
			}
		}
	},
	{
		"uid": "4112947",
		"code": "Nonroad",
		"lastUpdated": "Jun 16, 2017 12:53:38 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "NR"
			},
			"definition": {
				"text": "Include off-road mobile sources that use gasoline, diesel, and other fuels. These source types include construction equipment, and lawn and garden equipment."
			}
		}
	}
]

List All SCC Lookup Elements by Name

GET /LookupElement/Name/{Name}

Summary

This service queries all SCC lookup elements of a specific lookup element type name. See the /LookupElementType service to determine lookup element type names. This can be used to populate a list of options for a filtering on one or more facets; for example, a filter on data category.

Parameters

Name	Description
lastUpdatedSince	The date on or after which the lookup element has been modified. If omitted, lookup elements will not be filtered by date.
format	The output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filename	The filename used. Only used when CSV format is requested.

Results Sample

[
	{
		"uid": "4340903",
		"code": "Biogenic",
		"lastUpdated": "Jun 16, 2017 1:02:22 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "B"
			},
			"last update in eis": {
				"text": "5/22/2009 7:05:33 AM"
			}
		}
	},
	{
		"uid": "4340902",
		"code": "Facility Inventory",
		"lastUpdated": "Jun 16, 2017 1:01:07 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "FI"
			}
		}
	},
	{
		"uid": "4112948",
		"code": "Event",
		"lastUpdated": "Jun 16, 2017 12:52:42 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "E"
			},
			"definition": {
				"text": "Include fires that are reported in a day-specific format: wildfires and prescribed burns. Note that agricultural fires are included in non-point sources as an annual sum for a county."
			}
		}
	},
	{
		"uid": "4112945",
		"code": "Nonpoint",
		"lastUpdated": "Jun 16, 2017 12:52:57 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "NP"
			},
			"definition": {
				"text": "Include sources that individually are too small in magnitude to report as point sources. Examples include residential heating, residential charcoal grilling, asphalt paving, and commercial and consumer solvent use."
			}
		}
	},
	{
		"uid": "4112939",
		"code": "Point",
		"lastUpdated": "Jun 16, 2017 12:55:36 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "P"
			},
			"definition": {
				"text": "Include sources (usually large) that are located at a fixed, stationary location. Point sources in the NEI include large industrial facilities and electric power plants, airports, and smaller industrial, non-industrial and commercial facilities. The emissions potential of each facility determines whether that facility should be reported as a point source, according to emissions thresholds set in the Air Emissions Reporting Rule (AERR)."
			}
		}
	},
	{
		"uid": "4112946",
		"code": "Onroad",
		"lastUpdated": "Jun 16, 2017 12:54:17 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "ON"
			},
			"definition": {
				"text": "Include on-road vehicles that use gasoline, diesel, and other fuels. On-road vehicles include light duty and heavy duty vehicles operating on roads, highway ramps, and during idling."
			}
		}
	},
	{
		"uid": "4112947",
		"code": "Nonroad",
		"lastUpdated": "Jun 16, 2017 12:53:38 AM",
		"createdDate": "Aug 8, 2017 7:10:14 PM",
		"attributes": {
			"data category code": {
				"text": "NR"
			},
			"definition": {
				"text": "Include off-road mobile sources that use gasoline, diesel, and other fuels. These source types include construction equipment, and lawn and garden equipment."
			}
		}
	}
]

Get Timestamp of SCC Data Last Updated

GET /LastUpdate

Summary

This service returns the UNIX timestamp of when the SCC data was last updated.

Parameters

Name	Description
format	The output format. Possible values: JSON, XML, CSV. If omitted, JSON format is used by default.
filename	The filename used. Only used when CSV format is requested.

Results Sample

{
	"lastUpdated": 1465580415000
}

Sample URLs

Description	URL
Search for SSCs with Data Category matching "onroad" exactly, SCC Level Four matching "Total Spillage and Displacement" exactly, Tier 1 Description containing "highway", and Sector beginning with "gas" in XML format	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC?facetName[]=data+category&facetValue[]=onroad&facetQualifier[]=exact&facetName[]=scc+level+four&facetValue[]=total+spillage+and+displacement&facetQualifier[]=exact&facetName[]=tier+1+description&facetValue[]=highway&facetQualifier=contains&facetName[]=sector&facetValue[]=gas&facetQualifier[]=begins&format=XML
Query the SCC with code 2303020000	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC/2303020000
Query SCC hierarchy items with names containing "combustion" with SCC levels 1 or 2	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCCHierarchyItem?level[]=1&level[]=2&facetName[]=scc level one||scc level two||scc level three||scc level four&facetValue[]=combustion&facetQualifier[]=contains&facetMatchType[]=whole_phrase
Search all SCCs with ERT Valid of "Yes", and show the first 50 results.	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC?facetName[]=ert+valid&facetValue[]=yes&facetQualifier[]=exact&pageNum=1&pageSize=50
Searches all SCCs with Short Name containing the phrase "sheep and lamb"	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC?facetName[]=Short Name&facetValue[]=sheep and lamb&facetQualifier[]=contains&facetMatchType[]=whole_phrase
Searches all SCCs with any one of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four, Short Name, or Sector containing the words external and combustion	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC?facetName[]=SCC Level One||SCC Level Two||SCC Level Three||SCC Level Four||Short Name||Sector&facetValue[]=external combustion&facetQualifier[]=contains&facetMatchType[]=all_words
Searches all SCCs with Short Name containing the phrase "sheep and lamb" and with any of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four containing the word agriculture	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC?facetName[]=Short Name&facetValue[]=sheep and lamb&facetQualifier[]=contains&facetMatchType[]=whole_phrase&facetName[]=SCC Level One||SCC Level Two||SCC Level Three||SCC Level Four&facetValue[]=agriculture&facetQualifier[]=contains&facetMatchType[]=all_words
Searches all SCCs with any one of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four, Short Name, or Sector containing the words external and combustion and with any of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four containing the word boilers	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC?facetName[]=SCC Level One||SCC Level Two||SCC Level Three||SCC Level Four||Short Name||Sector&facetValue[]=external combustion&facetQualifier[]=contains&facetMatchType[]=all_words&facetName[]=SCC Level One||SCC Level Two||SCC Level Three||SCC Level Four&facetValue[]=boilers&facetQualifier[]=contains&facetMatchType[]=all_words
Searches all SCCs with Short Name containing the phrase "sheep and lamb" and with any of SCC Level One, SCC Level Two, SCC Level Three, SCC Level Four containing the word agriculture and with Data Category exactly matching "Nonpoint" or "Nonroad"	http://sor-scc-api.epa.gov:80/sccwebservices/v1/SCC?facetName[]=Short Name&facetValue[]=sheep and lamb&facetQualifier[]=contains&facetMatchType[]=whole_phrase&facetName[]=SCC Level One||SCC Level Two||SCC Level Three||SCC Level Four&facetValue[]=boilers&facetQualifier[]=contains&facetMatchType[]=all_words&facetName[]=Data Category&facetValue[]=Nonpoint||Nonroad&facetQualifier[]=exact&facetMatchType[]=whole_phrase
Get all lookup types.	http://sor-scc-api.epa.gov:80/sccwebservices/v1/LookupElementType
Get all possible data categories.	http://sor-scc-api.epa.gov:80/sccwebservices/v1/LookupElement/Name/data%20category
Get the UNIX timestamp of when the SCC data was last updated.	http://sor-scc-api.epa.gov:80/sccwebservices/v1/LastUpdated

---

Demo

Try it out for yourself. Enter text into the search field below and then click Search. A call will be made to the service and the results will be displayed below.

Also, feel free to view the source of the page or check it out in your browser's developer tools to see exactly how this works.

Search