BEA API Data Retrieval User Guide
BEA API Data Retrieval User Guide
User Guide
Introduction
The Bureau of Economic Analysis (BEA) publishes economic statistics in a variety of formats. This document
describes the BEA Data Retrieval Application Programming Interface (API) – including detailed instructions
for retrieving data and meta-data published by BEA. The API is intended to provide programmatic access to
published economic statistics using industry-standard methods and procedures. The intended audience of this
document is programmers who are familiar with the concepts and techniques of retrieving data from Web
Services.
The BEA API includes methods for retrieving a subset of BEA statistical data, and meta-data that describes it.
As additional datasets are added, the meta-data retrieval methods can be used to discover the current data
accessible through the API.
NOTES:
1. To prevent abuse, BEA does not permit users to register for an API key with a disposable email
address.
2. In mid-2018, BEA restructured its website and created a new subdomain, [Link], to host all
dynamic, database-driven web applications referenced from the primary domain, [Link].
While API registration and documentation links remain on the primary domain, the URI for the API is
accessed on the [Link] subdomain, as shown below.
The URI 1 of the API is: [Link] All API access is through this URI; no other paths are
0F
used. Data is retrieved by sending an HTTP GET to the URI with appropriate (querystring) parameters supplied.
The minimum parameters for every request include the UserID and the name of the method being invoked. For
example:
[Link]
would retrieve a list of the datasets currently offered by the BEA API (if the UserID was valid – it’s not).
Statistical data offered by the API is organized into defined “Datasets”. An API data retrieval request always
specifies one dataset by name. Each dataset has a number of defined parameters, and each parameter has a
defined set of valid values. There are four API methods that return meta-data about the API – corresponding to
1
Uniform Resource Identifier
JavaScript Usage
While the API may be used from any language capable of issuing HTTP requests (Java, PHP, Perl, Python, C,
etc. ), two features are supported that allow JavaScript to issue requests without violating same-origin security
checks - CORS and JSONP.
If you're writing a browser-based web application for modern web browsers with support for CORS then you
may simply use an XMLHttpRequest as usual, without any changes. All HTTP responses generated by the API
will include the necessary CORS headers.
If you're writing a browser-based web application for legacy browsers without support for CORS then your
request URL query string may include a jsonp argument. If present, this prefix will be wrapped around the
response, allowing you to capture the result of the query.
For example:
[Link]
Key&method=GetData&datasetname=Regional&TableName=CAINC4&LineCode=30&GeoFIPS=COUNTY
&Year=2013&ResultFormat=json&jsonp=MY_FUNCTION_NAME
The valid values for ResultFormat are “JSON” and “XML”. For example, the following request would return a
list of the available datasets in XML format:
[Link]
Key&method=GETDATASETLIST&ResultFormat=XML
This request would return a list of the available datasets in JSON format:
[Link]
Key&method=GETDATASETLIST&ResultFormat=JSON
The data returned from the API always has the following basic structure, with some additional structure
depending on the data requested:
<BEAAPI>
<Request>
<RequestParam ParameterValue="GETDATASETLIST" ParameterName="METHOD"/>
<RequestParam ParameterValue=" Your-36Character-Key" ParameterName="USERID"/>
<RequestParam ParameterValue="XML" ParameterName="RESULTFORMAT"/>
</Request>
<Dataset DatasetDescription="Standard NIPA tables" DatasetName="NIPA"/>
<Dataset DatasetDescription="Standard NI underlying detail tables" DatasetName="NIUnderlyingDetail"/>
<Dataset DatasetDescription="Multinational Enterprises" DatasetName="MNE"/>
<Dataset DatasetDescription="Standard Fixed Assets tables" DatasetName="FixedAssets"/>
<Dataset DatasetDescription="International Transactions Accounts" DatasetName="ITA"/>
<Dataset DatasetDescription="International Investment Position" DatasetName="IIP"/>
<Dataset DatasetDescription="GDP by Industry" DatasetName="GDPbyIndustry"/>
<Dataset DatasetDescription="Regional data sets" DatasetName="Regional"/>
</Results>
</BEAAPI>
2
Java Script Object Notation
3
Extensible Markup Language
In JSON form, the example above returns data as follows (white-space and indentation added for clarity):
{
"BEAAPI":{
"Request"
:{
"RequestParam":[
{
"ParameterName":"USERID",
"ParameterValue":" Your-
36Character-Key "
},
{
"ParameterName":"RESULTFORMAT",
"ParameterValue":"JSON"
},
{
"ParameterName":"METHOD",
"ParameterValue":"GETDATASETLIST
"
}
]
},
"Results":{
"Dataset
":[
{
"DatasetName":"NIPA",
"DatasetDescription":"Standard NIPA
tables"
},
{
"DatasetName":"NIUnderlyingDetail",
"DatasetDescription":"Standard NI underlying
detail tables"
},
{
"DatasetName":"MNE",
"DatasetDescription":"Multinational
Enterprises"
},
{
"DatasetName":"FixedAssets",
"DatasetDescription":"Standard Fixed
Assets tables"
},
{
"DatasetName":"ITA",
"DatasetDescription":"International Transactions Accounts"
},
{
"DatasetName":"IIP",
"DatasetDescription":"International Investment Position"
},
{
"DatasetName":"GDPbyIndustry",
"DatasetDescription":"GDP by
Industry"
},
{
"DatasetName":"Regional",
"DatasetDescription":"Regional data sets"
}
]
}
}
}
NOTE:
These limits have periodically been adjusted since the API’s inception and will continue to be
evaluated and adjusted as needed to protect BEA’s API and webserver infrastructure from extreme
and/or abusive activity that may be detrimental to our infrastructure and/or unfairly impede other
API users.
The BEA API implements a throttling (rate limiting) mechanism to protect our servers from resource contention,
and to promote a fair opportunity for all users to share resources and retrieve data.
There are three standard limits applied for all API user accounts:
• Number of requests per minute (100), and or
• Data volume retrieved per minute (100 MB), and/or
• Errors per minute (30)
When any of these limits are exceeded by an API user in the previous minute, that user will receive an error for
any additional requests for a time-out period of one hour.
<BEAAPI>
<Request>
...
</Request>
<Results>
<Error APIErrorCode="1" APIErrorDescription="Request Denied - exceeded Volume per minute
quota."/>
</Results>
</BEAAPI>
If you make any subsequent API requests during the time-out period, the HTTP 429 response header will
decrement the RETRY-AFTER value until the time-out period is over, based on the starting timestamp.
Here are some techniques to minimize or eliminate throttling while using the BEA API:
[Link]
36Character-
Key&method=GETDATASETLIST&ResultFormat=XML
&ResultFormat=XML&
Example Return:
<BEAAPI>
<Request>
<RequestParam ParameterValue="GETDATASETLIST" ParameterName="METHOD"/>
<RequestParam ParameterValue="Your-36Character-Key" ParameterName="USERID"/>
<RequestParam ParameterValue="XML" ParameterName="RESULTFORMAT"/>
</Request>
<Results>
<Dataset DatasetDescription="Standard NIPA tables" DatasetName="NIPA"/>
<Dataset DatasetDescription="Standard NI underlying detail tables" DatasetName="NIUnderlyingDetail"/>
<Dataset DatasetDescription="Multinational Enterprises" DatasetName="MNE"/>
<Dataset DatasetDescription="Regional data sets" DatasetName="Regional"/>
<Dataset DatasetDescription="Standard Fixed Assets tables" DatasetName="FixedAssets"/>
<Dataset DatasetDescription="International Transactions Accounts" DatasetName="ITA"/>
<Dataset DatasetDescription="International Investment Position" DatasetName="IIP"/>
<Dataset DatasetDescription="GDP by Industry" DatasetName="GDPbyIndustry"/>
</Results>
</BEAAPI>
The RegionalData, RegionalIncome, and RegionalProduct data sets are obsolete and API calls using
these data sets will no longer function. Users should instead access the dataset Regional, which
provides comprehensive detail in statistics, industries, geography, and years. See Appendix N for
instructions on how to use the Regional data set. In addition, BEA continues to add new datasets as
appropriate, and while any new datasets will be announced on the BEA’s website Developers page
([Link] we also encourage users to periodically call the above
GETDATASETLIST discover new datasets.
G et P a ra m et er L i st – retrieves a list of the parameters (required and optional) for a particular dataset.
Example Request 1:
[Link]
Key&method=getparameterlist&datasetname=Regional&ResultFormat=XML
Example Return 1:
<BEAAPI>
<Request>
<RequestParam ParameterName="USERID" ParameterValue="Your-36Character-Key" />
<RequestParam ParameterName="METHOD" ParameterValue="GetParameterList" />
<RequestParam ParameterName="DatasetName" ParameterValue="Regional" />
<RequestParam ParameterName="ResultFormat" ParameterValue="XML" />
</Request>
<Results>
<Parameter ParameterName="GeoFips" MultipleAcceptedFlag="1" ParameterIsRequiredFlag="1"
ParameterDataType="string" ParameterDescription="Comma-delimited list of 5-character geographic codes;
COUNTY for all counties, STATE for all states, MSA for all MSAs, MIC for all Micropolitan Areas, PORT for
all state metro/nonmetro portions, DIV for all Metropolitan Divisions, CSA for all Combined Statistical
Areas, state post office abbreviation for all counties in one state (e.g. NY)" />
<Parameter ParameterName="TableName" MultipleAcceptedFlag="0" ParameterIsRequiredFlag="1" ParameterDataType="string"
ParameterDescription="Income or employment table to retrieve" />
<Parameter ParameterName="LineCode" MultipleAcceptedFlag="0" ParameterIsRequiredFlag="1" ParameterDataType="integer"
ParameterDescription="Line code for a statistic or industry"/>
<Parameter ParameterName="Year" MultipleAcceptedFlag="1" ParameterIsRequiredFlag="0" ParameterDescription="Comma-delimted
list of years; LAST5 for latest 5 years; LAST10 for latest 10 years; ALL for all years" ParameterDefaultValue="LAST5"
ParameterDataType="string" />
</Results>
</BEAAPI>
In this example, the parameters for the “Regional” dataset are being requested. The results indicate that the
dataset has four parameters: GeoFips, LineCode, TableName, and Year.
GeoFips is a string typed parameter indicating the geographic codes requested. GeoFIPS is required.
Multiple values are accepted, in a comma-delimited list, and there are special values such as COUNTY for
all counties.
TableName is a string typed parameter that specifies what table has the statistic requested. We can’t tell from
this what the valid TableNames are, but we can see that it is required (and therefore has no default value), and
that multiple values are not allowed (and therefore there is no special “all” value).
LineCode specifies the requested statistic in the table. This integer is the line code in the table specified in the
TableName parameter. We don’t know what these line codes are, but we can send another request to find out.
Year is a string typed parameter containing the years requested. It is not required in a request, and if is not
included, the default value used is “LAST5”. A comma-delimited list of years is accepted, as well as other
special values like “LAST10” and “ALL”.
Example Request 2:
[Link]
IntlServTrade&ResultFormat=XML
Example Return 2:
<BEAAPI>
<Request>
<RequestParam ParameterValue="XML" ParameterName="RESULTFORMAT"/>
<RequestParam ParameterValue="Your-36Character-Key" ParameterName="USERID"/>
In this example, the parameters for the “IntlServTrade” dataset are being requested. The results indicate that
the dataset has five parameters: TypeOfService, TradeDirection, Affiliation, AreaOrCountry, and Year.
TypeOfService is a string typed parameter described as the type of service. It is not required. Multiple values
are accepted, and there is a value to select all types of service, “All”.
The other parameters have characteristics like the first. To get more information about the parameters,
“GetParameterValues” should be used.
Result: ParamValue node with attributes that contain the actual permissible values (and usually a description
of the value).
Example Request 1:
[Link]
Key&method=GetParameterValues&datasetname=INTLSERVTRADE&ParameterName=Tra
deDirection&ResultFormat=XML
Example Return 1:
<BEAAPI>
<Request>
<RequestParam ParameterName="USERID" ParameterValue="Your-36Character-Key" />
<RequestParam ParameterName="METHOD" ParameterValue="GetParameterValues" />
<RequestParam ParameterName="DatasetName" ParameterValue=INTLSERVTRADE" />
<RequestParam ParameterName="ParameterName" ParameterValue="TRADEDIRECTION" />
<RequestParam ParameterName="ResultFormat" ParameterValue="XML" />
</Request>
<Results>
<ParamValue Desc="Balance” Key="Balance"/>
<ParamValue Desc="Exports" Key="Exports"/>
<ParamValue Desc="Imports" Key="Imports"/>
<ParamValue Desc="Supplemental detail on insurance transactions" Key="SupplementalIns"/>
</Results>
</BEAAPI>
Example Request 2:
[Link]
Key&method=GetParameterValues&datasetname=Regional&ParameterName=TableName&ResultFormat=
XML
To summarize, the API includes three methods that retrieve meta-data about the statistics that are available:
GetDatasetList, GetParameterList, and GetParameterValues. There is also a method called
GetParameterValuesFiltered.
G et P a ra m et erV a lu esFi lt ered – retrieves a list of the valid values for a particular parameter based on
other provided parameters.
In our example above with the Regional data set, it is necessary to supply a TableName and LineCode. You
will want to discover the LineCode values available for a given TableName. The
GetParameterValuesFiltered method is designed to do this.
GetParameterValuesFiltered will return values for one target parameter based on the values of other
named parameters.
Example request to retrieve the valid LineCode values for a given TableName:
[Link]
Key&method=GetParameterValuesFiltered&datasetname=Regional&TargetParameter=LineCode&TableN
ame=SAINC1&ResultFormat=XML
Example return:
<BEAAPI>
<Request>
<RequestParam ParameterValue="Your-36Character-Key" ParameterName="USERID"/>
<RequestParam ParameterValue="XML" ParameterName="RESULTFORMAT"/>
<RequestParam ParameterValue="LINECODE" ParameterName="TARGETPARAMETER"/>
<RequestParam ParameterValue="SAINC1" ParameterName="TABLENAME"/>
<RequestParam ParameterValue="REGIONAL" ParameterName="DATASETNAME"/>
<RequestParam ParameterValue="GETPARAMETERVALUESFILTERED" ParameterName="METHOD"/>
</Request>
<Results>
<ParamValue Desc="[SAINC1] Personal income (millions of dollars)" Key="1"/>
<ParamValue Desc="[SAINC1] Population (persons)" Key="2"/>
<ParamValue Desc="[SAINC1] Per capita personal income (dollars)" Key="3"/>
</Results>
</BEAAPI>
All results from GetParameterValuesFiltered contain “Desc” and “Key”. Key is the value you will want to
pass in as a parameter to the data request for the target parameter you specified. In our example, a desired
Key will be passed into LineCode.
Although there is only one TargetParameter, mulitiple other parameters may be passed in. For example you
may want to know what years are available for a given TableName and GeoFips--
Example request:
[Link]
Key&method=GetParameterValuesFiltered&datasetname=Regional&TargetParameter=Year&TableName
=CAINC5N&GeoFips=01001&ResultFormat=XML
Example return:
There are many more examples of using GetParameterValuesFiltered in the Regional appendix N.
Please note that the GetParameterValuesFiltered method does not yet work with all BEA data sets. If
you try GetParametersValuesFiltered on a data set that does not yet support it, an error will be
returned--
<BEAAPI>
<Request>
<RequestParam ParameterValue="GETPARAMETERVALUESFILTERED" ParameterName="METHOD"/>
<RequestParam ParameterValue="Your-36CharacterKey" ParameterName="USERID"/>
<RequestParam ParameterValue="1" ParameterName="TABLEID"/>
<RequestParam ParameterValue="NIPA" ParameterName="DATASETNAME"/>
<RequestParam ParameterValue="XML" ParameterName="RESULTFORMAT"/>
<RequestParam ParameterValue="Q" ParameterName="FREQUENCY"/>
<RequestParam ParameterValue="YEAR" ParameterName="TARGETPARAMETER"/>
</Request>
<Results>
<Error APIErrorDescription="The GetParameterValuesFiltered method has not been implemented on this dataset (coming soon)."
APIErrorCode="34"/>
</Results>
</BEAAPI>
Each Dataset contains different dimensions. There are a few pre-defined dimensions that are common to most
Datasets, including:
• CL_UNIT – a descriptor of the units reported for the data value (e. g. USD for U. S. dollars, and PC
for percent)
• UNIT_MULT – a descriptor of the multiplier that applies to the data value. This value is the base-
10 exponent that should be applied to the data value (e. g. amounts reported in millions would have
a UNIT_MULT of 6; amounts reported in billions would have a UNIT_MULT of 9).
The specific meaning of each dimension is described in the Appendix for each dataset.
The result then includes Data nodes containing the actual results specified in the parameters. Each Data
node contains one attribute for each data dimension (specified in the Dimensions nodes).
Finally, the result may include Note nodes. Notes (as in footnotes) further describe or qualify any of the other
nodes in the result (or the result node itself). A result node qualified by a Note has an attribute named
NoteRef. If a result node includes the NoteRef attribute, the value for it will always be present among the
Notes nodes.
Example Request 1:
[Link]
Key&method=GetData&datasetname=Regional&TableName=CAINC1&LineCode=3&GeoFIPS=DE&Yea
r=2014&ResultFormat=XML
In this example, the GetData method is used to return a result from the dataset named Regional. The TableId
and LineCode parameters are used to request statistic for “Per Capita personal income (county annual income)”.
The GeoFIPS parameter value is “DE” – meaning the data for all counties in Delaware are requested. A single
year’s data is requested – 2014.
Note that the GeoFIPS parameter could have been “COUNTY” for all counties, or a list of individual state
or county GeoFIPS codes. Also, multiple years could have been requested by providing them in a comma-
separated list, or the special year parameters “LAST5” or “LAST10” could be used.
In this example the Result node contains a NoteRef attribute having the value “2”, and there is a Notes node
having the NoteRef value of “2”. This should be interpreted as meaning that the NoteText attribute for that
Notes node applies to the whole result.
Example Request 2:
[Link]
Key&method=GetData&datasetname=Regional&TableName=SAINC1&GeoFIPS=STATE&LineCode=3&
Year=2013&ResultFormat=XML
In this example, the GetData method is used to return the dataset named Regional. The TableName and
LineCode parameters are used to request statistic for “Per capita personal income (dollars)” – as shown in the
result of the first GetParameterValuesFiltered example above. The GeoFIPS parameter value is “STATE” –
meaning the data for all states is requested. Finally, a single year’s data is requested – 2013.
Note that the GeoFIPS parameter could have been a list of 5-digit geographic codes. Also, multiple years
could have been requested by providing them in a comma-separated list.
Example Return 2:
<BEAAPI>
<Request>
<RequestParam ParameterValue="2013" ParameterName="YEAR"/>
<RequestParam ParameterValue="3" ParameterName="LINECODE"/>
<RequestParam ParameterValue="REGIONAL" ParameterName="DATASETNAME"/>
<RequestParam ParameterValue="STATE" ParameterName="GEOFIPS"/>
<RequestParam ParameterValue="Your-36Character-Key" ParameterName="USERID"/>
<RequestParam ParameterValue="GETDATA" ParameterName="METHOD"/>
<RequestParam ParameterValue="SAINC1" ParameterName="TABLENAME"/>
<RequestParam ParameterValue="XML" ParameterName="RESULTFORMAT"/>
</Request>
<Results NoteRef="2" UTCProductionTime="2015-04-24T14:22:56.983" PublicTable="SA1 Personal Income Summary: Personal Income,
Population, Per Capita Personal Income" UnitOfMeasure="dollars" Statistic="Per capita personal income">
<Dimensions IsValue="0" DataType="string" Name="Code" Ordinal="1"/>
<Dimensions IsValue="0" DataType="string" Name="GeoFips" Ordinal="2"/>
In this example the Result node contains a NoteRef attribute having the value “2”, and there is a Notes node
having the NoteRef value of “2”. This should be interpreted as meaning that the NoteText attribute for that
Notes node applies to the whole result.
There are two Data nodes having a NoteRef attribute with the value “*”, and there is one Notes nodes having
the matching NoteRef attribute (“*”). This should be interpreted to mean that the Notes node having NoteRef
= “*” apply as a group to the corresponding Data nodes.
DataSet Documentation
BEA expects to publish several API Datasets containing a variety of economic statistics. The Datasets that are
currently available are each documented separately as appendices here.
The RegionalData dataset is obsolete and API calls using this dataset will no longer function. Users
should instead access the dataset Regional, which provides comprehensive detail in statistics, industries,
geography, and years. See Appendix N for instructions on how to use the Regional dataset.
Appendix B – NIPA (National Income and Product Accounts)
The DataSetName is NIPA. This dataset contains data from the National Income and Product Accounts
which include measures of the value and composition of [Link] and the incomes generated in
producing it. NIPA data is provided on a table basis; individual tables contain between fewer than 10 to more
than 200 distinct data series. Three parameters are used to retrieve data from the NIPA dataset, as follows:
Example calls
Percent change in Real Gross Domestic Product, Annually and Quarterly for all years
[Link]
NIPA&TableName=T10101&Frequency=A,Q&Year=ALL&ResultFormat=xml
[Link]
NIPA&TableName=T20600&Frequency=M&Year=2015,2016&ResultFormat=xml
API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for
Each Parameter
[Details of each are described in the section below. ]
When data is requested for frequencies that are not available for the requested NIPA table, only data that is
available is returned; if no data is available for the requested frequencies, an error will be returned.
When calling the GetParameterValues method and passing a TableName value the response will identify the
valid frequencies for that table.
1. A – Annual
2. Q – Quarterly
3. M – Monthly
If the request supplies the special value X or ALL for the Year parameter, all available years of data for
that NIPA table returned. Note that using the X or ALL value for all years can return large amounts of
data, and should be avoided when the actual required years are known.
When data is requested for years that are not available for the requested NIPA table, only data that is
available is returned; if no data is available for the requested year(s), an error will be returned.
When calling the GetParameterValues method and passing a TableName value the response will identify the
valid years for that table.
NIPA (National Income and Product Accounts) Dimensions Elements in Return Data
A NoteRef attribute is also included in all data elements and acts as a reference to one of the Notes elements
in the returned data. The NoteRef attribute may have multiple values represented by a comma-delimited
string. Any NoteRef attribute included in the data is guaranteed to have a corresponding Notes element. For
the NIPA dataset, every data element includes at least one Noteref that corresponds to a Note element
containing the title of the table.
Additional Information
Explanation of the estimates can be found in the National section of our website:
[Link] Please consult the schedule of releases which impacts data and table
availability. Updates and changes to the accounts are detailed at: [Link]
National Income and Product Account Methodologies can be found in our handbook.
Example calls
Personal Conumption Expenditures, Current Dollars, Annually, Quarterly and Monthly for all years
[Link]
NIUnderlyingDetail&TableName=U20305&Frequency=A,Q,M&Year=ALL&ResultFormat=xml
Auto and Truck Unit Sales, Production, Inventories, Expenditures and Price, Monthly, for 2015 and 2016
[Link]
NIUnderlyingDetail &TableName=U70205S&Frequency=M&Year=2015,2016&ResultFormat=xml
API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for
Each Parameter
[Details of each are described in the section below. ]
[Link] Key&method=GetParameterValues&
Year DataSetName=NIUnderlyingDetail&ParameterName= Year&ResultFormat=xml
TableName Parameter – (required)
The TableName parameter is a string that identifies a specific NIPA Underlying Detail table. Only one NIPA
Underlying Detail table can be requested in each data request. Requests with an invalid combination of
TableName, Frequency or Year values will result in an error. The TableName must be passed or an error will
result.
When data is requested for frequencies that are not available for the requested NIPA Underlying Detail table,
only data that is available is returned; if no data is available for the requested frequencies, an error will be
returned.
When calling the GetParameterValues method and passing a TableName value the response will identify the
valid frequencies for that table.
1. A – Annual
2. Q – Quarterly
3. M – Monthly
If the request supplies the special value X or ALL for the Year parameter, all available years of data for
that NIPA Underlying Detail table returned. Note that using the X or ALL value for all years can return
large amounts of data, and should be avoided when the actual required years are known.
When data is requested for years that are not available for the requested NIPA Underlying Detail table,
only data that is available is returned; if no data is available for the requested year(s), an error will be
returned.
When calling the GetParameterValues method and passing a TableName value the response will identify the
valid years for that table.
NIPA (National Income and Product Accounts) Dimensions Elements in Return Data
Parameter Name Ordinal Datatype IsValue Description
A NoteRef attribute is also included in all data elements and acts as a reference to one of the Notes elements
in the returned data. The NoteRef attribute may have multiple values represented by a comma-delimited
string. Any NoteRef attribute included in the data is guaranteed to have a corresponding Notes element. For
the NIPA dataset, every data element includes at least one Noteref that corresponds to a Note element
containing the title of the table.
Additional Information
Explanation of the estimates can be found in the National section of our website:
[Link] Please consult the schedule of releases which impacts data and table
availability. Updates and changes to the accounts are detailed at: [Link]
National Income and Product Account Methodologies can be found in our handbook.
TableName – TableID Mapping
The DataSetName is FixedAssets. This dataset contains data from the standard set of Fixed Assets tables as
published online. Two parameters are used to retrieve data from the Fixed Assets dataset, as follows:
Example calls
Current-Cost Net Stock of Private Fixed Assets, Equipment, Structures, and Intellectual Property Products
by Type, for all years
[Link]
Key&method=GetData&DataSetName=FixedAssets&TableName=FAAt201&Year=ALL&ResultFormat=xml
Chain-Type Quantity Indexes for Depreciation of Private Nonresidential Fixed Assets by Industry Group and
Legal Form of Organization, for 2015 and 2016
[Link]
Key&method=GetData&DataSetName=FixedAssets&TableName=FAAt405&Year=2015,2016&ResultFormat=xml
API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for
Each Parameter
[Details of each are described in the section below. ]
If the request supplies the special value X or ALL for the Year parameter, all available years of data for that
NIPA table returned. Note that using the X or ALL value for all years can return large amounts of data, and
should be avoided when the actual required years are known.
When data is requested for years that are not available for the requested NIPA table, only data that is
available is returned; if no data is available for the requested year(s), an error will be returned.
When calling the GetParameterValues method and passing a TableName value the response will identify the
valid years for that table.
NIPA (National Income and Product Accounts) Dimensions Elements in Return Data
A NoteRef attribute is also included in all data elements and acts as a reference to one of the Notes elements in
the returned data. The NoteRef attribute may have multiple values represented by a comma-delimited string.
Any NoteRef attribute included in the data is guaranteed to have a corresponding Notes element. For the NIPA
dataset, every data element includes at least one Noteref that corresponds to a Note element containing the title
of the table.
Additional Information
Explanation of the estimates can be found in the Fixed Assets section of our website:
[Link] Fixed Assets data is updated once
per year, typically between late-August through early October.
TableName – TableID Mapping
FAAt301S 22 FAAt408 60
FAAt302S 25 FAAt502 29
FAAt303E 44 FAAt503 47
FAAt303S 45 FAAt506 90
FAAt304E 69 FAAt507 98
FAAt305E 72 FAAt601 41
FAAt305S 73 FAAt604 80
FAAt306E 75 FAAt605 81
FAAt306S 76 FAAt608 62
1. Direct Investment (DI)—income and financial transactions in direct investment that underlie the U. S.
balance of payments statistics, and direct investment positions that underlie the U. S. international
investment positions; and
2. Activities of Multinational Enterprises (AMNE)—operations and finances of U. S. parent enterprises
and their foreign affiliates and U. S. affiliates of foreign MNEs.
API requests for the two types of statistics share most of the same parameters, though the allowable values for
each parameter may be different, depending on the type of statistic desired (e. g. , DI or AMNE).
[Link] Your-36Character-
Key&method=GetData&DataSetName=MNE&Year=2012,2011&Country=650,699&DirectionOfInvestment=Outw
ard&Classification=Country&ResultFormat=xml
Foreign direct investment position in the U. S. from Germany in the manufacturing industry for 2011 and 2012
[Link] Your-36Character-
Key&method=GetData&DataSetName=MNE&Year=2013,2012,2011,2010&Country=308&Industry=3000&Directi
onOfInvestment=Inward&Classification=CountryByIndustry&ResultFormat=xml
Type 2: Activities of Multinational Enterprises (AMNE) Data Request
Multiple
“All”
Parameter Name Type Description Required Values Default
value
Accepted
Outward, Inward, Not
DirectionOfInvestment String Yes No
State, Parent accepted
0 = Majority-Owned
Not
OwnershipLevel Binary Affiliates Yes No
accepted
1 = All Affiliates
0 = Both Bank and
NonBank Affiliates Not
NonBankAffiliatesOnly Binary Yes No
1 = Nonbank accepted
Affiliates
Data Series
SeriesID Integer No Yes All All
Identifier
Classification Results by country Not
String Yes No
and/or industry accepted
Year String Time Period Yes Yes All
Geographic Area
Country String No Yes All All
Code
Industry String Industry Code No Yes All All
Two-digit State FIPS
State String No No All All
Code
Yes = Include
footnotes Not
GetFootnotes String No No No
No = Exclude accepted
footnotes
Net income and sales for Brazilian affiliates of U. S. parent enterprises, all industries, 2011 and 2012
[Link] Your-36Character-
Key&method=GetData&DataSetName=MNE&Year=2012,2011&Country=202&Industry=all&DirectionOfInvestm
ent=Outward&Classification=CountryByIndustry&SeriesId=5,4&NonBankAffiliatesOnly=0&OwnershipLevel=0&R
esultFormat=xml
Total employment in U. S. affiliates of foreign-owned enterprises, all countries, 2011, include footnotes
[Link] Your-36Character-
Key&method=GetData&DataSetName=MNE&Year=2011&Country=all&Industry=0000&DirectionOfInvestment=I
nward&Classification=Country&SeriesId=8&OwnershipLevel=0&NonbankAffiliatesOnly=0&GetFootnotes=Yes&R
esultFormat=xml
API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for
Each Parameter
[Details of each are described in the section below. ]
1. ‘Outward’ – for AMNE statistics, provides data for foreign affiliates; for DI statistics,
provides data on transactions and positions between foreign affiliates and their U. S.
parent enterprises.
2. ‘Inward’ – for AMNE statistics, provides data for U. S. affiliates; for DI statistics,
provides data on transactions and positions between U. S. affiliates and their
foreign parent groups.
OwnershipLevel Parameter – (used with AMNE statistics only, required, single value)
NonBankAffiliatesOnly Parameter – (used with AMNE statistics only, required, single value)
Select NonBankAffiliatesOnly = 0 for data from 2009 – present for ‘outward’ AMNE and
from 2007 – present for ‘inward’ AMNE
Select NonBankAffiliatesOnly = 1 for data up to 2008 for ‘outward’ AMNE and up to 2006 for
‘inward AMNE
Refer to the GETPARAMETERVALUES API call above for the list of SeriesID values and
their descriptions. Note that not all series are available for all classes of ownership and years.
A value of 0 will return data for all available series given the other parameters. Separate
multiple values with a comma.
Refer to the GETPARAMETERVALUES API call above for the list of CLASSIFICATION
parameter values and their descriptions. Note that not all series are available for all
classifications. The CLASSIFICATION parameter is required and must be single-valued.
Use the four-digit year to request data for a specific year. Use ‘all’ to return data for all
available years. Separate multiple values with a comma.
Refer to the GETPARAMETERVALUES API call above for the list of three-digit
country and region identification values. Use ‘000’ for the total of all countries and ‘all’
for all available countries and regions. Separate multiple values with a comma.
Refer to the GETPARAMETERVALUES API call abovefor the list of four-digit industry
identification values. These generally follow the North American Industry Classification
System (NAICS). Use ‘0000’ for the all- industries total and ‘all’ for all available industries.
Separate multiple values with a comma.
At the state level, data are only available on employment and (for limited years), gross
property, plant, and equipment.
Refer to the GETPARAMETERVALUES API call above for the list of the two-digit Federal
Information Processing Standards (FIPS) codes, available at:
[Link]
Use ‘70’ for “Other U. S. Areas”, ‘75’ for “Foreign”, ‘00’ for total U. S., and ‘all’ for all
states and areas. Separate multiple values with a comma.
The gross domestic product by industry data are contained within a dataset called GDPbyIndustry. BEA's
industry accounts are used extensively by policymakers and businesses to understand industry interactions,
productivity trends, and the changing structure of the U. S. economy. The GDP-by-industry dataset includes
data in both current and chained (real) dollars. The dataset contains estimates for value added, gross output,
intermediate inputs, KLEMS and employment statistics.
[Link]
Key&method=GetData&DataSetName=GDPbyIndustry&Year=2012,2011&Industry=ALL&tableID=1&Frequency=
A&ResultFormat=xml
All annual and quarterly data in all tables for the Agriculture industry in 2010.
[Link]
Key&method=GetData&DataSetName=GDPbyIndustry&Year=2010&Industry=11&tableID=ALL&Frequency=A,Q
&ResultFormat=xml
API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for
Each Parameter
[Details of each are described in the section below. ]
Parameter Details
TableID Parameter – (Required, multiple values accepted, no default value, ‘ALL’ for all tables)
• The TableID parameter is a unique table identifier. This parameter is required to query data and does
accept multiple comma separated values. If all tables are required, use the ‘ALL’ keyword.
• All tables are published annually, but only a subset are published quarterly. The Descr in the
GetParameterValues result will contain (A) if the table is published annually and (Q) indicating that the
table is also published quarterly.
Frequency Parameter – (Required, multiple values accepted, no default value, ‘A,Q’ for all frequencies)
• The Frequency parameter indicates whether annual or quarterly data are to be returned. This parameter is
required to query data and does accept multiple comma separated values.
• All tables are published annually (Frequency = A) but only a subset are published quarterly (Frequency =
Q)
• If a data request is submitted for both annual and quarterly data from a table that is only published
annually then only the annual data will be returned.
• If a data request is submitted for quarterly data from a table that is only published annually then the user
will receive the following error:
Year Parameter – (Required, multiple values accepted, no default value, ’ALL‘ for all years)
• The Year parameter indicates what periods of data are requested. This parameter is required to query data
and does accept multiple comma separated values. Use the keyword ‘ALL’ to return all periods of data.
• If requesting quarterly frequency data, all available quarters for a year will be returned.
• Annual data publications begin in 1997 for most tables and 1998 for percent change and contributions
tables. Quarterly data began publication in 2005.
Industry Parameter – (Required, multiple values accepted, no default value, ‘ALL‘ for all industries)
• The Industry parameter indicates what periods of data are requested. This parameter is required to
query data and does accept multiple comma separated values. Use the keyword ‘ALL’ to return all
industries.
• All industries are published annually, but only a subset are published quarterly. The Descr in the
GetParameterValues result will contain (A) if the industry is published annually and (Q) indicating
that the industry is also published quarterly.
• If a data request is submitted for an industry that is not published in the requested tables the user
will receive the following error:
General Use
• Data will be returned for all data cells that fit the requested criteria. If the request contains parameter
values requesting data for which only part of a set is available, only the data matching the criteria will
be returned. For example, requesting ALL TableIDs for 1997 will return only annual data because the
quarterly publications begin in estimate year 2005. Blanks will not be returned for missing data.
• If no data fit the selected criteria the user will receive the following error:
The DataSetName is ITA. This dataset contains data on U. S. international transactions. BEA's international
transactions (balance of payments) accounts include all transactions between U. S. and foreign residents. Four
parameters are used to retrieve data from the ITA dataset, as follows:
[Link]
Key&method=GetData&DataSetName=ITA&Indicator=BalGds&AreaOrCountry=China&Frequency=A&Year=2011
,2012&ResultFormat=xml
Net U. S. acquisition of portfolio investment assets (quarterly not seasonally adjusted) for 2013
[Link]
Key&method=GetData&DataSetName=ITA&Indicator=PfInvAssets&AreaOrCountry=AllCountries&Frequency=Q
NSA&Year=2013&ResultFormat=xml
Parameter Details
The Indicator parameter specifies the type of transaction. The Indicator parameter values usually correspond to
lines in ITA tables at [Link] cfm?reqid=62&step=2&isuri=1&6210=1.
Exactly one Indicator parameter value must be provided in all data requests unless exactly one AreaOrCountry
parameter value other than “ALL” and “AllCountries” is requested. That is, multiple Indicators can only be
specified if a single AreaOrCountry is specified.
The AreaOrCountry parameter specifies the counterparty area or country of the transactions.
The default parameter value (“AllCountries”) returns the total for all countries, while “All” returns all data
available by area and country.
Exactly one AreaOrCountry parameter value must be provided in all data requests unless exactly one Indicator
parameter value is requested. This single parameter value may not be either “ALL” or “AllCountries. ” That is,
a list of countries or the grand total for all countries can only be specified if a single Indicator is specified.
A NoteRef attribute is also included in all data elements and acts as a reference to one of the Notes elements
in the returned data. The NoteRef attribute may have multiple values represented by a comma-delimited
string. Any NoteRef attribute included in the data is guaranteed to have a corresponding Notes element. The
NoteRef attribute may be blank.
The DataSetName is IIP. This dataset contains data on the U. S. international investment position. BEA's
international investment position accounts include the end of period value of accumulated stocks of U. S.
financial assets and liabilities. Four parameters are used to retrieve data from the IIP dataset, as follows:
Component of
Component String No Yes All All
changes in position
A - Annual, QNSA -
Frequency String Quarterly not No Yes All All
seasonally adjusted
Year String Year requested No Yes All All
U. S. assets excluding financial derivatives; change in position attributable to price changes for all available
years
[Link]
Key&method=GetData&DataSetName=IIP&TypeOfInvestment=FinAssetsExclFinDeriv&Component=ChgPosPrice
&Frequency=A&Year=ALL&ResultFormat=xml
U. S. liabilities to foreign official agencies (quarterly not seasonally adjusted) for 2013
[Link]
Key&method=GetData&DataSetName=IIP&TypeOfInvestment=FinLiabsFoa&Component=Pos&Frequency=QNSA
&Year=2013&ResultFormat=xml
Parameter Details
Exactly one TypeOfInvestment parameter value must be provided in all data requests unless exactly one Year
parameter value other than “ALL” is requested. That is, more than one TypeOfInvestment can only be specified
if a single Year is specified.
The Component parameter specifies either the position (“Pos”) or a component in the change of position from
the previous period. For instance, the parameter value “ChgPosTrans” specifies changes due to financial-
account transactions.
1. A – Annual
2. QNSA – Quarterly not seasonally adjusted
A NoteRef attribute is also included in all data elements and acts as a reference to one of the Notes elements
in the returned data. The NoteRef attribute may have multiple values represented by a comma-delimited
string. Any NoteRef attribute included in the data is guaranteed to have a corresponding Notes element. The
NoteRef attribute may be blank.
NOTE:
The RegionalIncome dataset is obsolete and API calls using this dataset will no longer function.
Users should instead access the dataset Regional, which provides comprehensive detail in
statistics, industries, geography, and years. See Appendix N for instructions on how to use the
Regional dataset.
NOTE:
The RegionalProduct dataset is obsolete and API calls using this dataset will no longer
function. Users should instead access the dataset Regional, which provides comprehensive
detail in statistics, industries, geography, and years. See Appendix N for instructions on how to
use the Regional dataset.
Appendix K – Input‐Output Statistics (InputOutput)
The Input‐Output Statistics are contained within a dataset called InputOutput. BEA's industry accounts are used
extensively by policymakers and businesses to understand industry interactions, productivity trends, and the changing
structure of the U.S. economy. The input-output accounts provide a detailed view of the interrelationships
between U.S. producers and users. The Input‐Output dataset contains Make Tables, Use Tables, and Direct and Total
Requirements tables.
Data from Industry‐by‐Commodity Total Requirements, After Redefinitions (Sector Level) table for years 2010, 2011, and
2012:
[Link]
Key&method=GetData&DataSetName=InputOutput&Year=2010,2011,2012,2013&tableID=56&ResultFormat=x
ml
Data for Industry‐by‐Commodity Total Requirements, After Redefinitions sector and summary level tables:
[Link]
Key&method=GetData&DataSetName=InputOutput&Year=2007&tableID=56,57&&ResultFormat=xml
[Link]
Year &method=GetParameterValues&DataSetName=InputOutput&ParameterName=
Year&ResultFormat=xml
Parameter Details
Year Parameter (Required, multiple values accepted, no default value, ’ALL‘ for all years)
The Year parameter indicates what periods of data are requested. This parameter is required to query data and
does accept multiple comma separated values. Use the keyword ‘ALL’ to return all periods of data.
General Use
Data will be returned for all data cells that fit the requested criteria. If the request contains parameter values
requesting data for which only part of a set is available, only the data matching the criteria will be returned. For
example, requesting ALL Years Use Tables evaluated in Purchasers Value will return data for only 2007 because
these tables are only published in benchmark years. Blanks will not be returned for missing data.
If no data fit the selected criteria the user will receive the following error:
The underlying gross domestic product by industry data are contained within a dataset called UnderlyingGDPbyIndustry.
BEA's industry accounts are used extensively by policymakers and businesses to understand industry interactions,
productivity trends, and the changing structure of the U.S. economy. The underlying GDP-by-industry dataset includes data
in both current and chained (real) dollars. The dataset contains estimates for value added, gross output, and intermediate
input statistics. This dataset is structurally similar to the GDPbyIndustry dataset (Appendix F), but contains additional
industry detail.
Please Note: Cautionary Note on use of underlying detail tables -- The Bureau of Economic Analysis does not
include these detailed estimates in the published tables because their quality is significantly less than that of the
higher level aggregates in which they are included.
[Link]
Key&method=GetData&DataSetName=underlyingGDPbyIndustry&Year=2013,2012&Industry=ALL&tableID=210&Fr
equency=A&ResultFormat=xml
[Link]
Key&method=GetData&DataSetName=underlyingGDPbyIndustry&Year=2012&Industry=11&tableID=ALL&Frequenc
y=A&ResultFormat=xml
[Link]
Frequency Key%20Y&method=GetParameterValues&DataSetName=underlyingGDPbyIndust
ry&ParameterName=Frequency&ResultFormat=xml
[Link]
Year Key%20Y&method=GetParameterValues&DataSetName=underlyingGDPbyIndust
ry&ParameterName=Year&ResultFormat=xml
[Link]
Industry Key%20Y&method=GetParameterValues&DataSetName=underlyingGDPbyIndust
ry&ParameterName=Industry&ResultFormat=xml
Parameter Details
TableID Parameter (Required, multiple values accepted, no default value, ‘ALL’ for all tables)
The TableID parameter is a unique table identifier. This parameter is required to query data and does accept multiple
comma separated values. If all tables are required, use the ‘ALL’ keyword.
The Descr in the GetParameterValues result will contain an (A) indicating that the table is published annually. No
quarterly data is available in the underlying GDP by industry dataset
The Frequency parameter indicates whether annual or quarterly data are to be returned. This parameter is required
to query data and does accept multiple comma separated values.
All tables are published annual only (Frequency = A). No quarterly data is currently available in the underlying GDP by
industry dataset
If a data request is submitted for quarterly data then the user will receive the following error:
Year Parameter (Required, multiple values accepted, no default value, ’ALL‘ for all years)
Industry Parameter (Required, multiple values accepted, no default value, ‘ALL‘ for all industries)
The Industry parameter indicates what periods of data are requested. This parameter is required to query data and
does accept multiple comma separated values. Use the keyword ‘ALL’ to return all industries.
The Descr in the GetParameterValues result will contain (A) if the industry is published annually.
If a data request is submitted for an industry that is not published in the requested tables the user will receive the
following error:
General Use
Data will be returned for all data cells that fit the requested criteria. If the request contains parameter values
requesting data for which only part of a set is available, only the data matching the criteria will be returned. Blanks
will not be returned for missing data.
If no data fit the selected criteria the user will receive the following error:
The DataSetName is IntlServTrade. This dataset contains annual data on U.S. international trade in services.
These data are updated each October to reflect the International Transactions Accounts annual update released
in June. BEA's statistics on services supplied through affiliates by multinational enterprises are not included in
this dataset. Five parameters are used to retrieve data from the IntlServTrade dataset, as follows:
Multiple
Parameter “All”
Type Description Required Values Default
Name value
Accepted
TypeOfService String The type of service requested No Yes All All
[Link]
Key&method=GetData&DataSetName=IntlServTrade&TypeOfService=AllServiceTypes&TradeDirection=I
mports&Affiliation=AllAffiliations&AreaOrCountry=Germany&Year=2014,2015&ResultFormat=xml
Exports of telecommunications services by U.S. parents to their foreign affiliates for all years
[Link]
Key&method=GetData&DataSetName=IntlServTrade&TypeOfService=Telecom&TradeDirection=Exports
&Affiliation=UsParents&AreaOrCountry=AllCountries&Year=All&ResultFormat=xml
Parameter Details
Exactly one TypeOfService parameter value other than “All” must be provided in all data requests unless exactly
one AreaOrCountry parameter value other than “All” is requested. That is, multiple Indicators can only be
specified if a single AreaOrCountry parameter is specified.
Exactly one AreaOrCountry parameter value must be provided in all data requests unless exactly one
TypeOfService parameter value other than “All” is requested. That is, a list of countries can only be specified if a
single TypeOfService is specified.
TimeSeriesId 6 String No A unique identifier for the time series of the data item.
A description of the transactions measured in the data
TimeSeriesDescription 7 String No
item.
A string containing the time period for the data item in
TimePeriod 8 String No
the form YYYY for annual data
A string indicating the base unit of measurement of the
CL_UNIT 9 String No data item. For example, “USD” is used when the
reported statistic is in U.S. dollars.
An integer representing the base-10 exponent of the
UNIT_MULT 10 String No multiplier used to interpret the data value. For
example “6” refers to millions (DataValue × 10 6 ).
An integer or decimal value of the statistic. May be
DataValue 11 Numeric No
blank.
Selected state data tables were discontinued Sept. 27, 2024, and selected county tables were discontinued on
Nov. 14, 2024, due to budget constraints. Additional information is at [Link]
data-tables.
Method=GetData
Multiple
“All”
Parameter Name Type Description Required Values Default
value*
Accepted
Published table
TableName String Yes No
name
STATE
COUNTY
The state, county or MSA
GeoFips String Yes Yes MIC
MSA code (unless
LineCode=ALL)
PORT
DIV
CSA
TERR
PO code
ALL
Year String Year requested No Yes LAST5 LAST5
LAST10
Main
TableName Description Years Areas
SASUMMARY State annual income and product summary 1998 States
TASUMMARY2 Summary estimates of real GDP for U.S. Territories 2002 Territori
es
CAINC1 Personal Income Summary: Personal Income, Population, Per Capita 1969 Counties,
Personal Income Metros
CAINC5N Personal Income by Major Component and Earnings by NAICS 2001 Counties,
Industry Metros
CAINC5S Personal Income by Major Component and Earnings by SIC Industry 1969-2000 Counties,
Metros
CAGDP2 Gross domestic product (GDP) by county and metropolitan area 2001 Counties,
Metros
CAGDP8 Chain-type quantity indexes for real GDP by county and 2001 Counties,
metropolitan area Metros
SAINC1 Personal Income Summary: Personal Income, Population, Per Capita 1929 States
Personal Income
SAINC51 Disposable Personal Income Summary: Disposable Personal Income, 1948 States
Population, and Per Capita Disposable Personal Income
SAINC5N Personal Income by Major Component and Earnings by NAICS 1998 States
Industry
SAINC5S Personal Income by Major Component and Earnings by SIC Industry 1958-2001 States
SAPCE1 Personal consumption expenditures (PCE) by major type of product 1997 States
SAPCE2 Per capita personal consumption expenditures (PCE) by major type 1997 States
of product
SQINC5H Personal Income by Major Component and Earnings by Industry 1948-57 States
(Historical)
SQINC5N Personal Income by Major Component and Earnings by NAICS 1998 States
Industry
SQINC5S Personal Income by Major Component and Earnings by SIC Industry 1958-2001 States
PRGDP1-3 Percent change from preceding year in real gross domestic product GeoFips=
2012 72000
PRGDP2-3 Percent change from preceding year in real personal consumption GeoFips=
expenditures by type 2012 72000
PRGDP3-3 Percent change from preceding year in real exports and imports of GeoFips=
goods and services by type of product 2012 72000
PRGDP4-1-3 Percent change from preceding year in real gross domestic GeoFips=
investment by type 2012 72000
State, county, and metropolitan statistical area FIPS codes can be obtained from Census at
[Link] A comprehensive list of MSAs and their component
counties can be accessed at [Link]
Errors
An invalid parameter value will result in an error code of 40, “The dataset requested requires parameters that
were missing from the request” plus a detailed message that explains the invalid value(s) entered.
Examples:
- For Invalid TableName a detailed message with “TableName entered is invalid” will display.
- When two or more parameter values are incompatible a detailed message will display “TableName entered
is incompatible with the entered GeoFips, LineCode and Year”.
- In the case of incompatible entries, the error message will tell the user which parameters are incompatible
and suggestions of the compatible values will be listed.
Method=GetParameterValuesFiltered
API Call [GETPARAMETERVALUESFILTERED] to Obtain a List of Available Values & Descriptions for Each
Parameter, Filtered by Another Parameter [Examples below]
Target Filtered
Parameter Parameter Parameter Value List Explanation
Name Names
[Link]
36Character-
List Years for given
Year TableName Key&method=GetParameterValuesFiltered&datasetname
TableNames
=Regional&TargetParameter=Year&TableName=CAINC5N
,CAINC25N&ResultFormat=xml
[Link]
36Character- List of GeoFips for a
TableName
GeoFips Key&method=GetParameterValuesFiltered&datasetname given TableName and
LineCode
=Regional&TargetParameter=GeoFips&TableName=CAIN LineCode
C4&LineCode=10&ResultFormat=xml
[Link]
36Character- List of TableNames for
Year
TableName Key&method=GetParameterValuesFiltered&datasetname a given Year and
Geofips
=Regional&TargetParameter=TableName&GeoFips=0000 GeoFips
0&Year=2014&ResultFormat=xml
[Link]
36Character-
List of LineCodes for a
LineCode TableName Key&method=GetParameterValuesFiltered&datasetname
TableName
=Regional&TargetParameter=LineCode&TableName=SAI
NC4&ResultFormat=json
GeoFips parameter
GeoFips specifies geography. It can be all states (STATE), all counties (COUNTY), all Metropolitan
Statistical Areas (MSA), or state post office abbreviation for all counties in one state (e.g. NY). It can also be a
list of ANSI state-county codes or metropolitan area codes. For example, the counties in Connecticut and
Delaware–
09001,09003,09005,09007,09009,09011,09013,09015,10001,10003,10005
State, county, and metropolitan statistical area FIPS codes can be obtained from Census at
[Link] A comprehensive list of MSAs and their component
counties can be accessed at [Link]
Year parameter
Year is either a single value, a list of comma-delimited years, or ALL
Errors
An invalid TableName LineCode, GeoFips or Year will result in an error code of 203, “No parameter values
match the filtered list requested” plus a detailed message that explains the invalid value(s) entered.
Examples:
- For Invalid LineCode a detailed message with “LineCode entered is invalid” will display.
- When there are no available GeoFips data for the entered LineCode a detailed message with “Values of
GeoFips and LineCode are incompatible” will display, followed by a suggestion of compatible values.
Additional information
Explanation of the estimates, including a schedule of the release of new regional data and Income and Product
methodologies can be found on our website: [Link] Definitions of the estimates can be accessed
at our glossary of regional definitions, at [Link]