Bea Web Service Api User Guide
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 67
| Download | |
| Open PDF In Browser | View PDF |
BEA API for Data Retrieval 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. Access to the BEA API The API is available to registered users on the BEA public web site. Before using the API, users must obtain a unique 36-character UserID by registering at https://www.bea.gov/api/signup/ . To register, API users must provide their name (or organization name), a valid email address, and agree to the published terms of service. After completing the registration form an email is sent containing the assigned UserID, and a link that completes the registration process. Assigned UserIDs are activated when the link has been clicked. The URI1 of the API is: https://www.bea.gov/api/data. All API access is through this URI; no other paths are 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: https://www.bea.gov/api/data?&UserID=Your-36Character-Key&method=GETDATASETLIST& 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 datasets, parameters, and valid parameter values. There is one method that returns data. 1 Uniform Resource Identifier Page 1 of 14 February 16, 2018 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: https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetData&datasetname=RegionalIncome&TableName=CA4&LineCode=30&GeoFIPS=COUN T Y&Year=2013&ResultFormat=json&jsonp=MY_FUNCTION_NAME Data Return Format The API returns data in one of two formats: JSON2 or XML3. The optional ResultFormat parameter can be included on any request to specify the format of the results. If ResultFormat is not supplied on the request, or an invalid ResultFormat is specified, the default format returned is JSON. 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: https://www.bea.gov/api/data?&UserID=Your36CharacterKey&method=GETDATASETLIST&ResultFormat=XML& This request would return a list of the available datasets in JSON format: https://www.bea.gov/api/data?&UserID=Your-36CharacterKey&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:2 3 Java Script Object Notation Extensible Markup Language Page 2 of 14 February 16, 2018 In XML form, the root node is always , followed by the child node . The node contains children that echo the parameters passed in the request. The root node, , then has another child node, , containing the results of the request. The Results content is different depending on the method and parameters passed. In this example, the result of the GetDatasetList method is shown to be a simple list of Dataset names and descriptions. In JSON form, the example above returns data as follows (white-space and indentation added for clarity): { "BEAAPI":{ "Request":{ "RequestParam":[ { "ParameterName":"USERID", "ParameterValue":" Your-36CharacterKey " }, { "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":"RegionalIncome", "DatasetDescription":"Regional Income data sets" }, { "DatasetName":"RegionalProduct", "DatasetDescription":"Regional Product data sets" } ] } } } Page 3 of 14 February 16, 2018 Error Return Format When invalid values are supplied for parameters in a request, or required parameters are missing, the results contain an error message – for example: API Calling Limits The API has default calling limits as shown below. These limits are meant to protect BEA’s API and webserver infrastructure from activity that may be detrimental to that infrastructure and/or unfairly impede other API users. • 1000 API calls per minute, and/or • 30 errors per minute, and/or • 100 MB (raw data) per minute. Any user that exceeds the above calling limits will receive an explanatory error message for each API call until the per-minute cause has expired. The best way to avoid such errors is to design your application to call the API within these limits, e.g., programmatically regulate the frequency/size of API calls. Meta-Data API Methods The API contains three methods for retrieving meta-data as follows: G et D at a S et L i st – retrieves a list of the datasets currently offered. Required Parameters: UserID, Method Optional Parameters: ResultFormat Result: Dataset node with DatasetName and DatasetDescription attributes. Example Request: https://www.bea.gov/api/data?&UserID=Your36CharacterKey&method=GETDATASETLIST&ResultFormat=XML& Example Return: Page 4 of 14 February 16, 2018 The RegionalData data set is obsolete and API calls using this data set will no longer function. Users should instead access the datasets RegionalIncome and RegionalProduct, which provide comprehensive detail in statistics, industries, geography, and years. See Appendices I and J for instructions on how to use these two data sets. 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 (https:/www.bea.gov/developers), 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. Required Parameters: UserID, Method, DatasetName Optional Parameters: ResultFormat Result: Parameter node with attributes: • ParameterName – the name of the parameter as used in a data request • ParameterDataType – String or Integer • ParameterDescription – a description of the parameter • ParameterIsRequired – 0 if the parameter can be omitted from a request, 1 if required • ParameterDefaultValue – the default value used for the request if the parameter is not supplied • MultipleAcceptedFlag – 0 if the parameter may only have a single value, 1 if multiple values are permitted. Note that multiple values for a parameter are submitted as a comma-separated string. • AllValue – the special value for a parameter that means all valid values are used without supplying them individually. Example Request 1: https://www.bea.gov/api/data?&UserID=Your-36CharacterKey&method=getparameterlist&datasetname=RegionalIncome&ResultFormat=XML Example Return 1: In this example, the parameters for the “RegionalIncome” 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. Page 5 of 14 February 16, 2018 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: https://www.bea.gov/api/data?&UserID=Your-36CharacterKey&method=getparameterlist&datasetname=RegionalProduct&ResultFormat=XML Example Return 2: In this example, the parameters for the “RegionalProduct” dataset are being requested. The results indicate that the dataset has four parameters: GeoFips, Component, IndustryId, and Year. GeoFIPS is a string typed parameter described as the GeoFIPS code. GeoFIPS is required. Multiple values are accepted, and there are special parameters to specify a group of areas, like “STATE” for all states. Component is an integer corresponding to a GDP component. We don’t have the list of Components in this request but we can tell it is required. Industry is an integer used to specify which industry is being requested for a given Component. We can’t tell from this what the industryIds 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). Year is string typed parameter described as “Year”. It is not required in a request, and if is not included, the default value used is “LAST5” for the last available five years. “ALL” and “LAST10” are also available. To choose specific years, submit a comma-delimited list of years, like “1990,2000,2010”. G et P a ra m et erV a lu es – retrieves a list of the valid values for a particular parameter. Page 6 of 14 February 16, 2018 Required Parameters: UserID, Method, DatasetName, ParameterName Optional Parameters: ResultFormat Result: ParamValue node with attributes that contain the actual permissible values (and usually a description of the value). Example Request 1: https://bea.gov/api/data?&UserID=Your-36CharacterKey&method=GetParameterValues&datasetname=RegionalProduct&ParameterName=Comp onent& Example Return 1: Example Request 2: https://bea.gov/api/data?&UserID=Your-36CharacterKey&method=GetParameterValues&datasetname=RegionalIncome&ParameterName=TableName&ResultFor mat=XML Example Return 2: Page 8 of 14 February 16, 2018 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 new 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 RegionalIncome 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: https://bea.gov/api/data?&UserID=Your-36CharacterKey&method=GetParameterValuesFiltered&datasetname=RegionalIncome&TargetParameter=LineCode&T a bleName=SA1&ResultFormat=XML Example return: Page 7 of 14 February 16, 2018 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: https://bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValuesFiltered&datasetname=RegionalIncome&TargetParameter=Year&Table Na me=CA5N&GeoFips=01001&ResultFormat=XML Example return: Desc="2001" Desc="2002" Desc="2003" Desc="2004" Desc="2005" Desc="2006" Desc="2007" Desc="2008" Desc="2009" Desc="2010" Desc="2011" Desc="2012" Desc="2013" Desc="2014" Key="2001"/> Key="2002"/> Key="2003"/> Key="2004"/> Key="2005"/> Key="2006"/> Key="2007"/> Key="2008"/> Key="2009"/> Key="2010"/> Key="2011"/> Key="2012"/> Key="2013"/> Key="2014"/> There are many more examples of using GetParameterValuesFiltered in the Regional appendices I and J. 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- ParameterValue="CA5N" ParameterName="TABLENAME"/> ParameterValue="XML" ParameterName="RESULTFORMAT"/> ParameterValue="REGIONALINCOME" ParameterName="DATASETNAME"/> ParameterValue="01001" ParameterName="GEOFIPS"/> ParameterValue="GETPARAMETERVALUESFILTERED" ParameterName="METHOD"/> Page 9 of 14 February 16, 2018 Data Retrieval API Method The API has one method for retrieving data – G e t Dat a . Every data retrieval request requires the UserID, Method, and DatasetName parameters. Each dataset has a defined set of parameters – some required and others optional. Each dataset returns different results that are documented in appendices to this document. G e t Dat a Required Parameters: UserID, Method, DatasetName, additional required parameters (depending on the dataset) Optional Parameters: ResultFormat, additional optional parameters (depending on the dataset) Result: Dimensions nodes with attributes: • Ordinal – ordinal number indicating a standardized order of returned dimensions – note that attributes in returned data are not guaranteed to be in any particular order. Programmatic usage of attributes should refer to them by name. • Name – The Name of each data dimension returned • DataType – string or numeric – whether the data dimension is purely numeric or should be treated as string data Page 10 of 14 February 16, 2018 • IsValue – most datasets have one dimension that represents the statistic of interest, and the other dimensions are descriptive of the statistic. IsValue = 1 for the data dimension that is the statistic of interest, otherwise 0. The statistic of interest is usually numeric so that it can be summarized or aggregated based on the descriptive dimension values. 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 base10 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: https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetData&datasetname=RegionalIncome&TableName=CA1&LineCode=3&GeoFIPS=DE& Year=2014&ResultFormat=XML& In this example, the GetData method is used to return a result from the dataset named RegionalIncome. 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 – 2015. 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 commaseparated list, or the special year parameters “LAST5” or “LAST10” could be used. Example Return 1: 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: https://www.bea.gov/api/data?&UserID=Your-36CharacterKey&method=GetData&datasetname=RegionalIncome&TableName=SA1&GeoFIPS=STATE &LineCode=3&Year=2013&ResultFormat=XML& In this example, the GetData method is used to return the dataset named RegionalIncome. 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: Page 11 of 14 February 16, 2018 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. Page 14 of 14 February 16, 2018 Appendix A – RegionalData (DEPRECATED) The RegionalData data set is obsolete and API calls using this data set will no longer function. Users should instead access the datasets RegionalIncome and RegionalProduct, which provide comprehensive detail in statistics, industries, geography, and years. See Appendices I and J for instructions on how to use these two data sets. 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 U.S.production 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: Name Type Description Is Required Multiple Values Accepted No No “All” value TableName String The standard NIPA table identifier Frequency String List of frequencies to retrieve Yes Yes N/A Year String List of year(s) of data to retrieve Yes Yes X ALL N/A Example calls Percent change in Real Gross Domestic Product, Annually and Quarterly for all years https://www.bea.gov/api/data/?&UserID=Your-36Character-Key&method=GetData&DataSetName= NIPA&TableName=T10101&Frequency=A,Q&Year=ALL&ResultFormat=xml Personal Income, Monthly, for 2015 and 2016 https://www.bea.gov/api/data/?&UserID=Your-36Character-Key&method=GetData&DataSetName= 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. ] Parameter Name Parameter Value List https://www.bea.gov/api/data/?&UserID=Your-36CharacterTableName Key&method=GetParameterValues&DataSetName=NIPA&ParameterName= TableName&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterFrequency Key&method=GetParameterValues&DataSetName=NIPA&ParameterName= Frequency&ResultFormat=xml Year https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=NIPA&ParameterName= Year&ResultFormat=xml TableName Parameter – (required) The TableName parameter is a string that identifies a specific NIPA table. Only one NIPA 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 parameter must be passed or an error will result. TableID Parameter – (discontinued; February 2018) The TableID parameter is discontinued. The TableName parameter replaces the TableId parameter. A crosswalk between TableId and TableName values can be found in the appendix to this document. Frequency Parameter – (required, multiple values allowed) The Frequency parameter is a string that refers to the time series for the requested NIPA table. Multiple frequencies are requested by specifying them as a comma-delimited string, e. g. “A,Q,M”. 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. Accepted parameter values are: 1. A – Annual 2. Q – Quarterly 3. M – Monthly Year Parameter – (required, multiple values allowed) The Year parameter specifies the year(s) of the data requested. When quarterly or monthly data are requested all available quarters for the specified year(s) will be returned. Multiple years are requested by specifying them as a comma-delimited string, e. g. “2000,2001,2002”. 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 Dataset Result Data NIPA (National Income and Product Accounts) Dimensions Elements in Return Data Parameter Name Ordinal Datatype IsValue Description TableName SeriesCode LineNumber LineDescription TimePeriod 1 String No String No 3 String No 4 String No A description of the transactions measured in the data item. String No Time period for the data item in the form YYYY for annual data; YYYYQn for quarterly data (where n is the quarter digit); or YYYYMx for monthly data (where x is the month digit). 6 String No 7 String No 2 5 Metric_Name Unique identifier for the NIPA table requested. A unique identifier for the time series of the data item. Sequence of the data item within the table. String indicating the measurement of the data item. Example values are Current Dollars, Fisher Price Index, etc. The calculation type of the data item. CL_UNIT 8 UNIT_MULT DataValue 9 String No An integer representing the base-10 exponent of the multiplier used to interpret the data value. For example “6” refers to millions (DataValue × 106). Numeric Yes Value of the data item, formatted with commas. 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: https://bea.gov/national/. Please consult the schedule of releases which impacts data and table availability. Updates and changes to the accounts are detailed at: https://www.bea.gov/national/an1.htm. National Income and Product Account Methodologies can be found in our handbook. TableName – TableID Mapping TableName TableId T10101 1 T10102 2 T10103 3 T10104 4 T10105 5 T10106 6 T10106A 7 T10106B 8 T10106C 9 T10106D 10 T10107 11 T10108 12 T10109 13 T10110 14 T10111 310 T10201 15 T10202 16 T10203 17 T10204 18 T10205 19 T10206 20 T10301 21 T10303 22 T10304 23 T10305 24 T10306 25 T10401 26 T10403 27 T10404 28 T10405 29 T10406 30 T10501 31 T10502 32 T10503 33 T10504 34 T10505 35 T10506 36 T10604 37 T10607 38 T10608 39 T10701 40 T10703 41 T10704 42 T10705 43 T10706 44 TableName TableId T10803 45 T10806 46 T10903 47 T10904 48 T10905 49 T10906 50 T11000 51 T11100 52 T11200 53 T11300 54 T11400 55 T11500 56 T11600 57 T11701 316 T11705 317 T11706 318 T20100 58 T20200A 59 T20200B 60 T20301 61 T20302 62 T20303 63 T20304 64 T20305 65 T20306 66 T20307 67 T20403 68 T20404 69 T20405 70 T20406 71 T20503 72 T20504 73 T20505 74 T20506 75 T20600 76 T20700A 77 T20700B 78 T20801 79 T20803 80 T20804 81 T20805 82 T20806 83 T20807 84 T20900 85 T30100 86 TableName T30200 T30300 T30400 T30500 T30600 T30700 T30800 T30901 T30902 T30903 T30904 T30905 T30906 T31001 T31003 T31004 T31005 T31006 T31101 T31102 T31103 T31104 T31105 T31106 T31200 T31300 T31400 T31501 T31502 T31503 T31504 T31505 T31506 T31600 T31700 T31800A T31800B T31900 T32000 T32100 T32200 T32300 T40100 T40201 T40202 TableId 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 326 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 TableName T40203 T40204 T40205 T40206 T4030A T4030B T50100 T50203 T50205 T50206 T50301 T50302 T50303 T50304 T50305 T50306 T50401 T50402 T50403 T50404 T50405 T50406 T50501 T50502 T50503 T50504 T50505 T50506 T50601 T50602 T50603 T50604 T50605 T50606 T50705A T50705B T50706A T50706B T50805A T50805B T50806A T50806B T50809A T50809B T50903A TableId 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 327 328 329 330 331 332 163 164 165 166 173 174 175 176 333 334 335 TableName TableId T50903B 336 T50904A 337 T50904B 338 T50905A 339 T50905B 340 T50906B 342 T51000 178 T51100 343 T60100B 179 T60100C 180 T60100D 181 T60200A 182 T60200B 183 T60200C 184 T60200D 185 T60300A 186 T60300B 187 T60300C 188 T60300D 189 T60400A 190 T60400B 191 T60400C 192 T60400D 193 T60500A 194 T60500B 195 T60500C 196 T60500D 197 T60600A 198 T60600B 199 T60600C 200 T60600D 201 T60700A 202 T60700B 203 T60700C 204 T60700D 205 T60800A 206 T60800B 207 T60800C 208 T60800D 209 T60900B 210 T60900C 211 T60900D 212 T61000B 213 T61000C 214 T61000D 215 TableName TableId T61100A 216 T61100B 217 T61100C 218 T61100D 219 T61200A 220 T61200B 221 T61200C 222 T61200D 223 T61300A 224 T61300B 225 T61300C 226 T61300D 227 T61400A 228 T61400B 229 T61400C 230 T61400D 231 T61500A 232 T61500B 233 T61500C 234 T61500D 235 T61600A 236 T61600B 237 T61600C 238 T61600D 239 T61700A 240 T61700B 241 T61700C 242 T61700D 243 T61800A 244 T61800B 245 T61800C 246 T61800D 247 T61900A 248 T61900B 249 T61900C 250 T61900D 251 T62000A 252 T62000B 253 T62000C 254 T62000D 255 T62100A 256 T62100B 257 T62100C 258 T62100D 259 T62200A 260 TableName TableId T62200B 261 T62200C 262 T62200D 263 T70100 264 T70201A 265 T70201B 266 T70203A 267 T70203B 268 T70204A 269 T70204B 270 T70205A 271 T70205B 272 T70206B 273 T70303 274 T70304 275 T70305 276 T70306 277 T70403 278 T70404 279 T70405 280 T70406 281 T70500 282 T70600 283 T70700 284 T70800 285 T70900 286 T71000 287 T71100 288 T71200 289 T71300 290 T71400 291 T71500 292 T71600 293 T71700 294 T71800 295 T71900 297 T72000 296 T72100 392 T72200 393 T72300 394 T72400 395 T72500 397 Appendix C – NIPA Underlying Detail (National Income and Product Accounts) The DataSetName is NIUnderlyingDetail. This dataset contains underlying detail data from the National Income and Product Accounts which include measures of the value and composition of U.S.production and the incomes generated in producing it. NIPA Underlying Detail data is provided on a table basis; individual tables contain between fewer than 10 to more than 200 distinct data series. Four parameters are used to retrieve data from the NIPA Underlying Detail dataset, as follows: Name Type Description Is Required Multiple Values Accepted No No “All” value TableName String The standard NIPA table identifier Frequency String List of frequencies to retrieve Yes Yes N/A Year String List of year(s) of data to retrieve Yes Yes X ALL N/A Example calls Personal Conumption Expenditures, Current Dollars, Annually, Quarterly and Monthly for all years https://www.bea.gov/api/data/?&UserID=Your-36Character-Key&method=GetData&DataSetName= 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 https://www.bea.gov/api/data/?&UserID=Your-36Character-Key&method=GetData&DataSetName= 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. ] Parameter Name Parameter Value List https://www.bea.gov/api/data/?&UserID=Your-36Character- TableName Key&method=GetParameterValues&DataSetName=NIUnderlyingDetail&ParameterName= TableName&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36Character- Key&method=GetParameterValues& Frequency DataSetName=NIUnderlyingDetail&ParameterName= Frequency&ResultFormat=xml Year https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues& 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. TableID Parameter – (discontinued; February 2018) The TableID parameter is discontinued. The TableName parameter replaces the TableId parameter. A crosswalk between TableId and TableName values can be found in the appendix to this document. Frequency Parameter – (required, multiple values allowed) The Frequency parameter is a string that refers to the time series for the requested NIPA Underlying Detail table. Multiple frequencies are requested by specifying them as a comma-delimited string, e. g. “A,Q,M”. 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. Accepted parameter values are: 1. A – Annual 2. Q – Quarterly 3. M – Monthly Year Parameter – (required, multiple values allowed) The Year parameter specifies the year(s) of the data requested. When quarterly or monthly data are requested all available quarters for the specified year(s) will be returned. Multiple years are requested by specifying them as a comma-delimited string, e. g. “2000,2001,2002”. 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 Underlying Detail Dataset Result Data NIPA (National Income and Product Accounts) Dimensions Elements in Return Data Parameter Name TableName SeriesCode LineNumber LineDescription TimePeriod Ordinal 1 2 3 4 5 Datatype IsValue String No String No String No Description Unique identifier for the NIPA table requested. A unique identifier for the time series of the data item. Sequence of the data item within the table. String No A description of the transactions measured in the data item. String No Time period for the data item in the form YYYY for annual data; YYYYQn for quarterly data (where n is the quarter digit); or YYYYMx for monthly data (where x is the month digit). 6 String No 7 String No Metric_Name String indicating the measurement of the data item. Example values are Current Dollars, Fisher Price Index, etc. The calculation type of the data item. CL_UNIT 8 UNIT_MULT DataValue 9 String No An integer representing the base-10 exponent of the multiplier used to interpret the data value. For example “6” refers to millions (DataValue × 106). Numeric Yes Value of the data item, formatted with commas. 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: https://bea.gov/national/. Please consult the schedule of releases which impacts data and table availability. Updates and changes to the accounts are detailed at: https://www.bea.gov/national/an1.htm. National Income and Product Account Methodologies can be found in our handbook. TableName – TableID Mapping TableName TableId TableName TableId TableName TableId TableName TableId U001A 2001 U20305 2014 U50203 2070 U50705BU3 2092 U001A2 2012 U20306 2015 U50205 2071 U50706AM 2093 U001B 2023 U20403 2074 U50206 2072 U50706AU 2094 U001BC 2034 U20404 2016 U50404 2029 U50706BM 2095 U002AU 2045 U20405 2017 U50405 2030 U50706BU 2096 U002AUI 2056 U20406 2018 U50406 2031 U51100 2053 U002BU 2059 U30400 2019 U50504 2032 U70204 2054 U002BUI 2060 U30500 2020 U50505 2033 U70205 2057 U003AU 2061 U30600 2021 U50506 2035 U70205S 2055 U003BU 2002 U30700 2022 U50705AM1 2081 U70206 2058 U004A1 2003 U30800 2024 U50705AM2 2082 U90100 2075 U004A2 2004 U31200 2025 U50705AM3 2083 U90200 2076 U004A3 2005 U31300 2026 U50705AU1 2084 U90300 2077 U004B1 2006 U32400 2027 U50705AU2 2085 U90400 2078 U004B2 2007 U32500 2028 U50705AU3 2086 U90500 2079 U004B3 2008 U40203 2114 U50705BM1 2087 U00500 2009 U40204 2111 U50705BM2 2088 U00600 2010 U40205 2113 U50705BM3 2089 U00700 2011 U40206 2112 U50705BU1 2090 U20304 2013 U4030B 2073 U50705BU2 2091 Appendix D – Fixed Assets The FixedAssets 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: Name Type Description Is Required Multiple “All” value Values Accepted TableID Integer The standard Fixed Yes No N/A Assets table identifier Year integer List of year(s) of Yes Yes X ALL TableID Parameter The TableID parameter is an integer that refers to a specific Fixed Assets table. As shown above, the parameter is required, and only one Fixed Assets table can be requested in each GetData submission. The full list of valid Fixed Assets TableIDs is as follows: Page 12 of 14 February 16, 2018 Page 13 of 14 February 16, 2018 Appendix D: Page 1 of 7 February 16, 2018 Note that the description of each table also indicates that only annual data is available. Requesting an invalid TableID returns this error: Omitting the TableID parameter returns this error: Appendix D: Page 2 of 7 February 16, 2018 Year Parameter The Year parameter is an integer that specifies the year(s) of data for the requested Fixed Assets table. As shown above, the parameter is required, and multiple years can be requested in each GetData submission. Multiple years are requested by specifying them as a comma-delimited string, e. g. “2000,2001,2002”. When data is requested for years that don’t exist for a particular Fixed Assets table, only data that exists is returned. For example, if years in the future are requested – like “2013,2014,2015”, the most recent available data is returned starting with 2013. If the request supplies the special value X or ALL for the Year parameter, all available years of data are 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. If only years that don’t exist for a particular table are requested, this error is returned: Omitting the Year parameter returns this error: Using the GetParameterValues meta-data retrieval method for the Year parameter returns a list of the valid year ranges for each Fixed Assets table. Each Fixed Assets table may have a different range of years. For example, Table 1 (at the time of this writing) has annual data from 1925 through 2012 available as indicated in this example return data from the GetParameterValues method: Appendix D: Page 3 of 7 February 16, 2018 Appendix D: Page 4 of 7 February 16, 2018 Fixed Assets Dataset Result Data The Fixed Assets dataset returns data in the standard form described in the API User documentation. In XML form, the main structure of a result is: The Request node of the result contains the parameters supplied to the request. For purposes of this example, the parameters are: The result returned from this request would be: Appendix D: Page 5 of 7 February 16, 2018 All requests for the Fixed Assets dataset will return similar results, including the elements that describe the dimensions, data, and footnotes (Dimensions, Data, and Notes). Dimensions Elements The dimensions included in the returned data are: Ordinal 1 2 3 4 5 6 7 8 Name TableID SeriesCode LineNumber LineDescription TimePeriod CL_UNIT UNIT_MULT DataValue NoteRef 6 Datatype numeric string numeric No string string numeric numeric string IsValue No No No No No No No Yes No Within the set of “Data” elements returned in the result, each of the dimensions is represented as an attribute (name/value pair). All the dimensions (attributes) have a single value, except the Noteref dimension, which can have multiple values represented as a comma-delimited string. The dimensions (attributes) are defined as follows: TableID – The standard Fixed Assets table ID as submitted in the request (an integer). SeriesCode – A string containing the a unique identifier for the line item in the published Fixed Assets table. LineNumber – The line number of the data item as shown in published print versions of the published Fixed Assets table. LineDescription – The “stub” or description of the statistic in the published Fixed Assets table. TimePeriod – A string containing the time period for the data item in the form YYYY for annual data. CL_UNIT – A string containing “USD” when the reported statistic is in U. S. dollars, or “PC” when the reported statistic is a percent, index, or contribution. UNIT_MULT – An integer representing the base-10 exponent of the multiplier used to interpret the data value. For example “6” refers to millions (DataValue X 106) and “9” refers to billions (DataValue X 109). 6 The Noteref attribute included in the data is not shown as one of the dimension elements. Noterefs may appear as an attribute of any element in the result data (except other Noterefs), and refer to a particular NoteRef element. Appendix D: Page 6 of 7 February 16, 2018 DataValue – An integer or decimal value of the statistic. Always a numeric value, but may contain embedded commas. NoteRef – a reference to one of the Notes elements. Noteref in a data element always corresponds to the Noteref in a Notes element. The Noteref attribute may have multiple values represented by a comma-delimited string. This attribute can appear in any data element, or in the Results element. Any Noteref attribute included in the data is guaranteed to have a corresponding Notes element. For the Fixed Assets dataset, every data element includes at least one Noteref that corresponds to a Note element containing the title of the table. Additional footnote references that apply to specific lines may be included in the comma-delimited Noteref string value. Appendix D: Page 7 of 7 February 16, 2018 Appendix E – Data on Direct Investment and Multinational Enterprises (MNEs) The DataSetName is MNE. This dataset contains two types of statistics: 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). Type 1: Direct Investment (DI) Data Request Type Description Required Multiple Values Accepted DirectionOfInvestment String Outward = US direct investment abroad Inward = Foreign investment in the US Yes No Not accepted SeriesID Integer Data Series Identifier No Yes All Classification String Yes No Year String Yes Yes Not accepted All Country String No Yes All All Industry String No Yes All All GetFootnotes String No No Not accepted No Parameter Name Results by country and/or industry Time Period Geographic Area Code Industry Code Yes = Include footnotes No = Exclude footnotes “All” value Default All Examples of Direct Investment (DI) Data Requests U. S. direct investment position in China and Asia for 2011 and 2012 https://www.bea.gov/api/data/?&SeriesId=30&UserID= Your-36CharacterKey&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 https://www.bea.gov/api/data/?&SeriesId=22,23,24,25,26,27&UserID= Your-36CharacterKey&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 Parameter Name Type DirectionOfInvestment String OwnershipLevel Binary NonBankAffiliatesOnly Binary SeriesID Integer Classification String Year String Country String Industry String State String GetFootnotes String Description Outward, Inward, State, Parent 0 = Majority-Owned Affiliates 1 = All Affiliates 0 = Both Bank and NonBank Affiliates 1 = Nonbank Affiliates Data Series Identifier Results by country and/or industry Time Period Geographic Area Code Industry Code Two-digit State FIPS Code Yes = Include footnotes No = Exclude footnotes Required Multiple Values Accepted “All” value Yes No Not accepted Yes No Not accepted Yes No Not accepted No Yes All Yes No Yes Yes Not accepted All No Yes All All No Yes All All No No All All No No Not accepted No Default All Examples of Activities of Multinational Enterprises (AMNE) Data Requests Net income and sales for Brazilian affiliates of U. S. parent enterprises, all industries, 2011 and 2012 https://www.bea.gov/api/data/?&UserID= Your-36CharacterKey&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 https://www.bea.gov/api/data/?&UserID= Your-36CharacterKey&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. ] Parameter Name Parameter Value List DirectionOfInvestment https://www.bea.gov/api/data/?&UserID= Your-36Character-Key Y&method=GetParameterValues&DataSetName=MNE&ParameterName=Dir ectionOfInvestment&ResultFormat=xml OwnershipLevel https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=Ow nershipLevel&ResultFormat=xml NonBankAffiliatesOnly https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=Non bankAffiliatesOnly&ResultFormat=xml SeriesID https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=MNE&ParameterName= SeriesID&ResultFormat=xml Classification https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=Clas sification&ResultFormat=xml Year https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=Yea r&ResultFormat=xml Country https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=cou ntry&ResultFormat=xml Industry https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=Ind ustry&ResultFormat=xml State https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=stat e&ResultFormat=xml GetFootnotes https://www.bea.gov/api/data/?&UserID= Your-36Character-Key &method=GetParameterValues&DataSetName=MNE&ParameterName=Get Footnotes&ResultFormat=xml Parameter Details DirectionOfInvestment Parameter – (Required, single value) DirectionOfInvestment can take on two values for DI statistics and four for AMNE statistics. The two values shared by DI and AMNE statistics are: 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. For AMNE statistics only there are two additional options: 3. ‘State’ – provides data on U. S. affiliates of foreign multinational enterprises at the state level. Note that only data on employment (and for 2007 and earlier years, property, plant, and equipment) are available at the state level. 4. ‘Parent’ – provides data on U. S. parent enterprises. OwnershipLevel Parameter – (used with AMNE statistics only, required, single value) 1. 1 – Returns data for all affiliates 2. 0 – Returns data for majority-owned affiliates only If DirectionOfInvestment = “Parent” then OwnershipLevel must be set to 1. NonBankAffiliatesOnly Parameter – (used with AMNE statistics only, required, single value) 1. 1 – Returns data for nonbank affiliates only 2. 0 – Returns data for both bank and nonbank affiliates only 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 SeriesID Parameter – (optional, default = 0, multiple values allowed) 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. Classification Parameter – (required, single value) 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. Year Parameter (required, multiple values allowed) 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. Country Parameter – (optional, default = all, multiple values allowed) 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. Industry Parameter – (optional, default = all, multiple values allowed) 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. State Parameter – (optional, default = all, multiple values allowed) 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: https://www.bls.gov/cew/cewedr10.htm. 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. GetFootnotes Parameter – (optional, default=no, single value) 1. ‘yes’ – Include footnotes with data returned 2. ‘no’ – Do not include footnotes with data returned Appendix F – Gross Domestic Product by Industry (GDPbyIndustry) 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. Gross Domestic Product by Industry (GDPbyIndustry) Data Request Parameter Name Type Description Required Multiple Values Accepted “All” value Default TableID Integer The unique GDP by Industry table identifier (ALL for All) Yes Yes ALL N/A Frequency String A - Annual, Q-Quarterly Yes Yes A,Q N/A Year Integer Yes Yes ALL N/A Industry String Yes Yes ALL N/A List of year(s) of data to retrieve (ALL for All) List of industries to retrieve (ALL for All) Examples of GDP by Industry (GDPbyIndustry) Data Requests Annual Value Added by Industry data for all industries for years 2011 and 2012: https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey&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. https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey&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 Name Appendix F: Page 1 of 3 Parameter Value List February 16, 2018 TableID Frequency Year Industry https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%20Y&method=GetParameterValues&DataSetName=GDPbyIndustry&Param eterName=TableID&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%20Y&method=GetParameterValues&DataSetName=GDPbyIndustry&Param eterName=Frequency&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%20Y&method=GetParameterValues&DataSetName=GDPbyIndustry&Param eterName=Year&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%20Y&method=GetParameterValues&DataSetName=GDPbyIndustry&Param eterName=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. • 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. Appendix F: Page 2 of 3 February 16, 2018 • If a data request is submitted for quarterly or annual data before the earliest estimate period the user will receive one of the following errors: 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: Appendix F: Page 3 of 3 February 16, 2018 Appendix G – ITA (International Transactions) 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: ITA (International Transactions) Data Request Parameters Parameter Name Type Indicator String AreaOrCountry String Frequency String Year String Description The indicator code for the type of transaction requested The area or country requested A - Annual, QSA Quarterly seasonally adjusted, QNSA Quarterly not seasonally adjusted Year requested Required Multiple Values Accepted “All” value Default No Yes All All No Yes All AllCountries No Yes All All No Yes All All Examples of ITA (International Transactions) Data Requests Balance on goods with China for 2011 and 2012 https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&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 https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetData&DataSetName=ITA&Indicator=PfInvAssets&AreaOrCountry=AllCountries&Frequency=Q NSA&Year=2013&ResultFormat=xml Appendix G: Page 1 of 3 February 16, 2018 API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for Each Parameter [Details of each are described in the section below. ] Parameter Name Parameter Value List Indicator https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=ITA&ParameterName=Indica tor&ResultFormat=xml AreaOrCountry Frequency Year https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=ITA&ParameterName=AreaO rCountry&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=ITA&ParameterName=Frequ ency&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=ITA&ParameterName=Year& ResultFormat=xml Parameter Details Indicator Parameter – (optional, multiple values allowed) The Indicator parameter specifies the type of transaction. The Indicator parameter values usually correspond to lines in ITA tables at https://www.bea.gov/iTable/iTableHtml. 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. AreaOrCountry Parameter – (optional, multiple values allowed) 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. For information on geographic area definitions, see https://www.bea.gov/international/bp_web/geographic_area_definitions. cfm Frequency Parameter – (optional, multiple values allowed) Appendix G: Page 2 of 3 February 16, 2018 3. A – Annual 4. QSA – Quarterly seasonally adjusted 5. QNSA – Quarterly not seasonally adjusted Year Parameter – (optional, multiple values allowed) The Year parameter specifies the year of the data requested. When quarterly data are requested, all available quarters for the specified year will be returned. ITA (International Transactions) Dimensions Elements in Return Data Parameter Name Ordinal Datatype IsValue Indicator 1 String No AreaOrCountry 2 String No Frequency 3 String No Year 4 String No TimeSeriesId 5 String No TimeSeriesDescription 6 String No TimePeriod 7 String No CL_UNIT 8 String No UNIT_MULT 9 String No DataValue 10 Numeric No Description The Indicator parameter value of the data item. The AreaOrCountry parameter value of the data item. The Frequency parameter value of the data item. The Year parameter value of the data item. A unique identifier for the time series of the data item. A description of the transactions measured in the data item. A string containing the time period for the data item in the form YYYY for annual data and YYYYQn for quarterly data (where n is the quarter digit) A string indicating the base unit of measurement of the 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 multiplier used to interpret the data value. For example “6” refers to millions (DataValue × 106). An integer or decimal value of the statistic. May be blank. 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. Appendix G: Page 3 of 3 February 16, 2018 Appendix H – IIP (International Investment Position) 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: IIP (International Investment Position) Data Request Parameters Parameter Name Type Description Required Multiple Values Accepted TypeOfInvestment String Type of investment No Yes All All Component String No Yes All All Frequency String No Yes All All Year String No Yes All All Component of changes in position A - Annual, QNSA Quarterly not seasonally adjusted Year requested “All” value Default Examples of IIP (International Investment Position) Data Requests U. S. assets excluding financial derivatives; change in position attributable to price changes for all available years https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&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 https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetData&DataSetName=IIP&TypeOfInvestment=FinLiabsFoa&Component=Pos&Frequency=QNSA &Year=2013&ResultFormat=xml Appendix H: Page 1 of 3 February 16, 2018 API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for Each Parameter [Details of each are described in the section below. ] Parameter Name Parameter Value List TypeOfInvestment https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IIP&ParameterName=TypeOf Investment&ResultFormat=xml Component Frequency Year https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IIP&ParameterName=Compo nent&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IIP&ParameterName=Freque ncy&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IIP&ParameterName=Year& ResultFormat=xml Parameter Details TypeOfInvestment Parameter – (optional, multiple values allowed) The TypeOfInvestment parameter specifies the type of investment. The TypeOfInvestment parameter values usually correspond to lines in IIP tables at https://www.bea.gov/iTable/iTableHtml. cfm?reqid=62&step=5&isuri=1&6210=2. 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. Component Parameter – (optional, multiple values allowed) 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 financialaccount transactions. Frequency Parameter – (optional, multiple values allowed) 1. A – Annual 2. QNSA – Quarterly not seasonally adjusted Year Parameter – (optional, multiple values allowed) The Year parameter specifies the year of the data requested. When quarterly data are requested, all available quarters for the specified year will be returned. Appendix H: Page 2 of 3 February 16, 2018 Exactly one Year parameter value must be provided in all data requests unless exactly one TypeOfInvestment parameter value other than “ALL” is requested. That is, more than one Year can only be specified if a single TypeOfInvestment is specified. IIP (International Investment Position) Dimensions Elements in Return Data Parameter Name Ordinal Datatype IsValue TypeOfInvestment 1 String No Component 2 String No Frequency 3 String No Year 4 String No TimeSeriesId 5 String No TimeSeriesDescription 6 String No TimePeriod 7 String No CL_UNIT 8 String No UNIT_MULT 9 String No DataValue 10 Numeric No Description The TypeOfInvestment parameter value of the data item. The Component parameter value of the data item. The Frequency parameter value of the data item. The Year parameter value of the data item. A unique identifier for the time series of the data item. A description of the transactions measured in the data item. A string containing the time period for the data item in the form YYYY for annual data and YYYYQn for quarterly data (where n is the quarter digit) A string indicating the base unit of measurement of the 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 multiplier used to interpret the data value. For example “6” refers to millions (DataValue × 106). An integer or decimal value of the statistic. May be blank. 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. Appendix H: Page 3 of 3 February 16, 2018 Appendix I – RegionalIncome (detailed regional income and employment data sets) The RegionalIncome dataset contains income and employment estimates from the Regional Economic Accounts by state, county, and metropolitan area. All data accessible through the Regional Interactive Tables on bea.gov are also available through this data set and the RegionalProduct data set. RegionalIncome Request Parameters Parameter Name Type Description Required Multiple Values Accepted TableName String Published table name Yes No LineCode Integer Line code in table Yes No GeoFips String The state, county or MSA code Yes Yes “All” value* Default STATE COUNTY MSA MIC PORT DIV CSA PO code* ALL Year String Year requested No Yes LAST5 LAST5 LAST10 *GeoFips -- 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 metropolitan/nonmetropolitan 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). Examples of RegionalIncome Requests Personal income for 2012 and 2013 for all counties, in JSON format https://bea.gov/api/data/?UserID=Your-36CharacterKey&method=GetData&datasetname=RegionalIncome&TableName=CA1&LineCode= 1&Year=2012,2013&GeoFips=COUNTY&ResultFormat=json Real per capita personal income for all states, all years, in XML format https://bea.gov/api/data/?UserID=Your-36Character-Key& method=GetData&datasetname=RegionalIncome&TableName=RPI1&LineCode=2&Y ear=ALL&GeoFips=STATE&ResultFormat=xml Appendix I: Page 1 of 7 February 16, 2018 API Call [GETPARAMETERVALUESFILTERED] to Obtain a List of Available Values & Descriptions for Each Parameter, Filtered by Another Parameter [Examples below] Filtered Parameter Names Parameter Value List Explanation Year TableName https://bea.gov/api/data/?UserID=Your-36CharacterKey&method=GetParameterValuesFiltered&datasetname= RegionalIncome&TargetParameter=Year&TableName=CA5 N,CA25N&ResultFormat=xml List Years for given TableNames GeoFips TableName LineCode https://bea.gov/api/data/?UserID=Your-36CharacterKey&method=GetParameterValuesFiltered&datasetname= RegionalIncome&TargetParameter=GeoFips&TableName= CA4&LineCode=10&ResultFormat=xml List of GeoFips for a given TableName and LineCode TableName Year Geofips https://bea.gov/api/data/?UserID=Your-36CharacterKey&method=GetParameterValuesFiltered&datasetname= RegionalIncome&TargetParameter=TableName&GeoFips= 00000&Year=2014&ResultFormat=xml List of TableNames for a given Year and GeoFips TableName https://bea.gov/api/data/?UserID=Your-36CharacterKey&method=GetParameterValuesFiltered&datasetname= RegionalIncome&TargetParameter=LineCode&TableName =SA25N&ResultFormat=json List of LineCodes for a TableName Parameter Name LineCode Parameter Details TableName paramete r – ( required, single value) TableName specifies a published table from the regional income accounts. Exactly one TableName must be provided. TableName Description Years Areas CA1 Personal Income Summary: Personal Income, Population, Per Capita Personal Income 1969--> All CA25 Total Full-Time and Part-Time Employment by SIC Industry 1969-2000 All Appendix I: Page 2 of 7 February 16, 2018 CA25N Total Full-Time and Part-Time Employment by NAICS Industry 2001-2014 All CA30 Economic Profile 1969 All CA35 Personal Current Transfer Receipts 1969 All CA4 Personal Income and Employment by Major Component 1969 All CA45 Farm Income and Expenses 1969 All CA5 Personal Income by Major Component and Earnings by SIC Industry 1969-2000 All CA5N Personal Income by Major Component and Earnings by NAICS Industry 2001 All CA6 Compensation of Employees by SIC Industry 1998-2000 All CA6N Compensation of Employees by NAICS Industry 2001 All CA91 Gross Flow of Earnings 1990 Counties IRPD1 Implicit Regional Price Deflator by state 2008 States 2008 MSAs, Portions IRPD2 Implicit Regional Price Deflator by MSA and state portion RPI1 Real Personal Income by state 2008 States, US RPI2 Real Personal Income by MSA and state portion 2008 MSA, Portions RPP1 Regional Price Parities by state 2008 States, US 2008 MSAs, Portions 1929 States, Regions, US 1969-2001 States, Regions, US RPP2 Regional Price Parities by MSA and state portion SA1 Personal Income Summary: Personal Income, Population, Per Capita Personal Income SA25 Total Full-Time and Part-Time Employment by SIC Industry Appendix I: Page 3 of 7 February 16, 2018 SA25N Total Full-Time and Part-Time Employment by NAICS Industry SA27 Full-Time and Part-Time Wage and Salary Employment by SIC Industry SA27N Full-Time and Part-Time Wage and Salary Employment by NAICS Industry SA30 SA35 SA4 SA40 SA45 SA5 Economic Profile Personal Current Transfer Receipts Personal Income and Employment by Major Component Property Income Farm Income and Expenses Personal Income by Major Component and Earnings by SIC Industry SA50 Personal Current Taxes SA51 Disposable Personal Income Summary: Disposable Personal Income, Population, and Per Capita Disposable Personal Income SA5H Personal Income by Major Component and Earnings by Industry (Historical) SA5N Personal Income by Major Component and Earnings by NAICS Industry SA6 SA6N Compensation of Employees by SIC Industry Compensation of Employees by NAICS Industry Appendix I: Page 4 of 7 1998 States, Regions, US 1969-2001 States, Regions, US 1998 States, Regions, US 1958 States, Regions, US 1929 States, Regions, US 1929 States, Regions, US 1958 States, Regions, US 1969 States, Regions, US 1958-2001 States, Regions, US 1948 States, Regions, US 1948 States, Regions, US 1929-1957 States, Regions, US 1998 States, Regions, US 1958-2001 States, Regions, US 1998 States, Regions, US February 16, 2018 SA7 SA7H SA7N SQ1 SQ35 SQ4 SQ5 Wages and Salaries by SIC Industry Wages and Salaries by Industry (Historical) Wages and Salaries by NAICS Industry Personal Income Summary: Personal Income, Population, Per Capita Personal Income Personal Current Transfer Receipts Personal Income by Major Component Personal Income by Major Component and Earnings by SIC Industry SQ5H Personal Income by Major Component and Earnings by Industry (Historical) SQ5N Personal Income by Major Component and Earnings by NAICS Industry SQ6 SQ6N SQ7 SQ7H Compensation of Employees by SIC Industry Compensation of Employees by NAICS Industry Wages and Salaries by SIC Industry Wages and Salaries by Industry (Historical) 1958-2001 States, Regions, US 1929-1957 States, Regions, US 1998 States, Regions, US 1948 States, Regions, US 1948 States, Regions, US 1948 States, Regions, US 1958-2001 States, Regions, US 1948-1957 States, Regions, US 1998 States, Regions, US 1958-2001 States, Regions, US 1998 States, Regions, US 1958-2001 States, Regions, US 1948-1957 States, Regions, US SQ7N Wages and Salaries by NAICS Industry 1998 States, Regions, US ACEmp Total Employment (Arts and Culture Satellite Account) 2001 States Appendix I: Page 5 of 7 February 16, 2018 ACComp Total Compensation (Ats and Culture Satellite Account) 2001 States ACEmpRatio Arts Employment Ratio 2001 States ACCompRatio Arts Compensation Ratio 2001 States ACArtsEmp ACPSA Employment 2001 States ACArtsComp ACPSA Compensation 2001 States ACEmpLQ Arts Employment Location Quotient 2001 States ACCompLQ Arts Compensation Location Quotient 2001 States LineCode parameter – (required, single value) LineCode corresponds to the statistic in a table. The available LineCodes are queried using the GetParameterValuesFiltered method. For example: https://bea.gov/api/data/?UserID=Your-36CharacterKey&method=GetParameterValuesFiltered&datasetname=RegionalIncome&TargetParameter=LineCode& TableName=SA25N&ResultFormat=json GeoFips parameter – (required, multiple value) GeoFips specifies geography. It can be all states (STATE), all counties (COUNTY), all Metropolitan Statistical Areas (MSA), all Micropolitan Statistical Areas (MIC), all Metropolitan Divisions (DIV), all Combined Statistical Areas (CSA), or all metropolitan/nonmetropolitan portions (PORT). 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 https://www.census.gov/geo/www/ansi/ansi.html. A comprehensive list of MSAs and their component counties can be accessed here https://www.bea.gov/regional/docs/msalist.cfm. Year parameter – (optional, multiple value) Year is either a list of years, LAST5, LAST10, or ALL. Year will default to all available years if the parameter is not specified. Errors An invalid TableName or LineCode will result in an error code of 40, “The dataset requested requires parameters that were missing from the request.” Appendix I: Page 6 of 7 February 16, 2018 An invalid Year or GeoFips will result in an error code of 101, “No result was returned.” Other errors may occur. Additional information Explanation of the estimates, including a schedule of the release of new regional data, can be found in the regional section of our website: https://bea.gov/regional/. Definitions of the estimates can be accessed at our glossary of regional definitions, at https://bea.gov/regional/definitions/. Regional Product and Income Methodologies can be found at https://bea.gov/regional/methods.cfm. Appendix I: Page 7 of 7 February 16, 2018 Appendix J – RegionalProduct (detailed state and MSA product data sets) The RegionalProduct dataset contains Gross Domestic Product (GDP) estimates from the Regional Economic Accounts by state and metropolitan area. All data accessible through the Regional Interactive Tables on bea.gov are also available through this data set and the RegionalIncome data set. RegionalProduct Request Parameters Parameter Name Type Description Required Multiple Values Accepted Component String Component name Yes No IndustryId Integer Yes No GeoFips String Yes Yes Year String No Yes Industry code of the Component The state or MSA code Year requested “All” value Default STATE MSA ALL LAST5 LAST10 LAST5 Examples of RegionalProduct Requests Real GDP for all years for all MSAs, in JSON format https://bea.gov/api/data/?UserID=Your36CharacterKey&method=GetData&datasetname=RegionalProduct&Component=RGDP_MAN&Ind ustryId=1&Year=ALL&GeoFips=MSA&ResultFormat=json GDP for 2012 and 2013 for selected Southeast states, for the Retail Trade industry, in XML format https://bea.gov/api/data/?UserID=Your-36CharacterKey&method=GetData&datasetname=RegionalProduct&Component=GDP_sAN&Indu stryId=35&Year=2012,2013&GeoFips=01000,05000,12000,13000,21000,22000, 28000,37000,45000,47000,51000,54000&ResultFormat=XML API Call [GETPARAMETERVALUESFILTERED] to Obtain a List of Available Values & Descriptions for Each Parameter, Filtered by Another Parameter [Examples below] Parameter Name Appendix J: Page 1 of 5 Filtered Parameter Names Parameter Value List Explanation February 16, 2018 Year Appendix J: Page 2 of 5 Component https://bea.gov/api/data/?UserID=Your36CharacterList Years for Key&method=GetParameterValuesFiltered& given datasetname=RegionalProduct&TargetParam Component eter=Year&Component=PCRGDP_SAN&R esultFormat=xml February 16, 2018 GeoFips Component IndustryId Year GeoFips Component IndustryId Component https://bea.gov/api/data/?UserID=Your36CharacterKey&method=GetParameterValuesFiltered& datasetname=RegionalProduct&TargetParam eter=GeoFips&Component=GDP_SAN&Re sultFormat=xml https://bea.gov/api/data/?UserID=Your36CharacterKey&method=GetParameterValuesFiltered& datasetname=RegionalProduct&TargetPara meter=Component&GeoFips=00000&Year= 2013&ResultFormat=xml https://bea.gov/api/data/?UserID=Your36CharacterKey&method=GetParameterValuesFiltered& datasetname=RegionalProduct&TargetPara meter=IndustryId&Component=GDP_SAS&R esultFormat=xml List of GeoFips for a given Component List of Components for a given Year and GeoFips List of IndustryIds for a Component Parameter Details Component parameter – ( required, single value) Component specifies a published table from the regional product accounts. Exactly one Component must be provided. Description Years Component Series State Quarterly NAICS GDP_SQN GDP in current dollars 2005 State Quarterly NAICS QI_SQN Quantity indexes for real GDP 2005 State Quarterly RGDP_SQN NAICS Real GDP in chained dollars 2005 Metro Annual GDP_MAN NAICS GDP in current dollars 2001 Metro Annual PCRGDP_MAN NAICS Per capita real GDP 2001 Metro Annual QI_MAN NAICS Quantity indexes for real GDP 2001 Metro Annual RGDP_MAN NAICS Real GDP in chained dollars 2001 State Annual COMP_SAN NAICS Compensation of employees 1997 State Annual GDP_SAN NAICS GDP in current dollars 1997 Appendix J: Page 3 of 5 February 16, 2018 GOS_SAN PCRGDP_SAN QI_SAN RGDP_SAN SUBS_SAN TOPI_SAN TOPILS_SAN GDP_SAS State Annual NAICS State Annual NAICS State Annual NAICS State Annual NAICS State Annual NAICS State Annual NAICS State Annual NAICS State Annual SIC Gross operating surplus 1997 Per capita real GDP 1997 Quantity indexes for real GDP Real GDP in chained dollars 1997 1997 Subsidies 1997 TOPI 1997 TOPI less subsidies 1997 Gross domestic product (GDP) by state 1963-1997 1963-1997 COMP_SAS State Annual SIC Taxes on production and imports less subsidies State Annual SIC Compensation of employees SUBS_SAS State Annual SIC Subsidies 1963-1997 TOPI_SAS State Annual SIC Taxes on production and imports 1963-1997 GOS_SAS State Annual SIC Gross operating surplus 1963-1997 QI_SAS State Annual SIC Quantity indexes for real GDP by state 1963-1997 RGDP_SAS State Annual SIC Real GDP by state 1963-1997 PCRGDP_SAS State Annual SIC Per capita real GDP by state 1963-1997 PCE_SAN State Annual PCPCE_SAN State Annual TOPILS_SAS Personal Consumption Expenditures (PCE) by state Per capita Personal Consumption Expenditures (PCE) by state 1963-1997 1997 1997 GeoFips parameter– (required, multiple value) GeoFips specifies geography. It can be all states (STATE) or all Metropolitan Statistical Areas (MSA). It can also be a list of ANSI state-county codes or metropolitan area codes. State and metropolitan statistical area FIPS codes can be obtained from Census at https://www.census.gov/geo/www/ansi/ansi.html. A comprehensive list of MSAs and their component counties can be accessed here https://www.bea.gov/regional/docs/msalist.cfm. Year parameter – (optional, multiple value) Year is either a list of years, LAST5, LAST10, or ALL. Year will default to all available years if the Appendix J: Page 4 of 5 February 16, 2018 parameter is not specified. Errors An invalid Component or IndustryId will result in an error code of 40, “The dataset requested requires parameters that were missing from the request.” An invalid Year or GeoFips will result in an error code of 101, “No result was returned.” Other errors may occur. Additional Information Explanation of the estimates, including a schedule of the release of new regional data, can be found in the regional section of our website: https://bea.gov/regional/. Definitions of the estimates can be accessed at our glossary of regional definitions, at https://bea.gov/regional/definitions/. Regional Product and Income Methodologies can be found at https://bea.gov/regional/methods.cfm. Appendix J: Page 5 of 5 February 16, 2018 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. InputOutput Data Request Parameter Name Type TableID Integer Year Integer Description The unique Input Output table identifier List of year(s) of data to retrieve Required Multiple Values Accepted “All” value Default Yes Yes N/A N/A Yes Yes ALL N/A Examples of InputOutput Data Requests Data from The Use of Commodities by Industries, Before Redefinitions (Producer’s Prices) sector level table for years 2010, 2011, and 2012: https://www.bea.gov/api/data/?&UserID=%Your-36CharacterKey&method=GetData&DataSetName=InputOutput&Year=2010,2011,2012,2013&tableID=2&&ResultFormat=x ml Data for 2007 from The Make of Commodities by Industries, Before Redefinitions sector and summary level tables: https://www.bea.gov/api/data/?&UserID=%Your-36CharacterKey&method=GetData&DataSetName=InputOutput&Year=2007&tableID=46,47&&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 Name Parameter Value List TableID https://www.bea.gov/api/data/?&UserID=%Your-36Character-Key &method=GetParameterValues&DataSetName=InputOutput&ParameterName= TableID&ResultFormat=xml Appendix K: Page 1 of 2 February 16, 2018 Year https://www.bea.gov/api/data/?&UserID=%Your-36Character-Key &method=GetParameterValues&DataSetName=InputOutput&ParameterName= Year&ResultFormat=xml Parameter Details TableID Parameter (Required, multiple values accepted, no default value) • The TableID parameter is a unique table identifier. This parameter is required to query data and does accept multiple comma separated values. 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: Appendix K: Page 2 of 2 February 16, 2018 Appendix L – Underlying Gross Domestic Product by Industry (UnderlyingGDPbyIndustry) 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. Underlying Gross Domestic Product by Industry (UnderlyingGDPbyIndustry) Data Request Parameter Name Type Description Required Multiple Values Accepted TableID Integer The unique GDP by Industry table identifier (ALL for All) Yes Yes ALL N/A Frequency String Q-Quarterly Yes Yes Q N/A Year Integer Yes Yes ALL N/A Industry String Yes Yes ALL N/A List of year(s) of data to retrieve (ALL for All) List of industries to retrieve (ALL for All) “All” value Default Examples of Underlying GDP by Industry (UnderlyingGDPbyIndustry) Data Requests Quarterly Value Added by Industry data for all industries for years 2012 and 2013: https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey&method=GetData&DataSetName=underlyingGDPbyIndustry&Year=2013,2012&Industry=ALL&tableID=1&Freq uency=Q&ResultFormat=xml All quarterly data in all tables for the Agriculture industry in 2012. https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey&method=GetData&DataSetName=underlyingGDPbyIndustry&Year=2012&Industry=11&tableID=ALL&Frequenc y=Q&ResultFormat=xml Appendix L: Page 1 of 3 February 16, 2018 API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for Each Parameter [Details of each are described in the section below.] Parameter Name Parameter Value List TableID https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%20Y&method=GetParameterValues&DataSetName=underlyingGDPbyIndust ry&ParameterName=TableID&ResultFormat=xml Frequency Year Industry https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%20Y&method=GetParameterValues&DataSetName=underlyingGDPbyIndust ry&ParameterName=Frequency&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%20Y&method=GetParameterValues&DataSetName=underlyingGDPbyIndust ry&ParameterName=Year&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=%20Your-36CharacterKey%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 a (Q) indicating that the table is published quarterly. No Annual data is available in the underlying GDP by industry dataset Frequency Parameter (Required, multiple values accepted, no default value) • 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 quarterly (Frequency = Q). No Annual data is currently available in the underlying GDP by industry dataset • If a data request is submitted for annual data 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. • All available quarters for a year will be returned. Appendix L: Page 2 of 3 February 16, 2018 • Underlying GDP by industry data publications begin in 2012 to present • If a data request is submitted for quarterly data before the earliest estimate period the user will receive one of the following errors: 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 (Q) if the industry is published quarterly and (A) indicating that the industry is also 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. For example, requesting 1,101 TableIDs for 2012 will return only table 1 data because the tableID 101 does not exist. Blanks will not be returned for missing data. • If no data fit the selected criteria the user will receive the following error: Appendix L: Page 3 of 3 February 16, 2018 Appendix M – IntlServTrade (International Services Trade) 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: IntlServTrade (International Services Trade) Data Request Parameters Required Multiple Values Accepted “All” value Default The type of service requested No Yes All All String The trade direction requested No Yes All All Affiliation String The affiliation requested No Yes All All AreaOrCountry String The area or country requested No Yes All AllCountries Year String The year requested No Yes All All Parameter Name Type Description TypeOfService String TradeDirection Examples of IntlServTrade (International Services Trade) Data Requests Imports of services from Germany for 2014 and 2015 https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&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 https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetData&DataSetName=IntlServTrade&TypeOfService=Telecom&TradeDirection=Exports &Affiliation=UsParents&AreaOrCountry=AllCountries&Year=All&ResultFormat=xml Appendix M: Page 1 of 4 February 16, 2018 API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for Each Parameter [Details of each are described in the section below.] Parameter Name TypeOfService TradeDirection Affiliation AreaOrCountry Year Parameter Value List https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IntlServTrade&ParameterName= TypeOfService&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IntlServTrade&ParameterName= TradeDirection&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IntlServTrade&ParameterName= Affiliation&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IntlServTrade&ParameterName= AreaOrCountry&ResultFormat=xml https://www.bea.gov/api/data/?&UserID=Your-36CharacterKey&method=GetParameterValues&DataSetName=IntlServTrade&ParameterName= Year&ResultFormat=xml Parameter Details TypeOfService Parameter (optional, multiple values allowed) The TypeOfService parameter specifies the type of service being traded (e.g. travel, transport, or insurance services). 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. TradeDirection Parameter (optional, multiple values allowed) The TradeDirection parameter specifies the trade direction of the services transactions. There are four valid parameter values other than “All”: 1. Exports – Exports 2. Imports – Imports 3. Balance – Balance (exports less imports) 4. SupplementalIns – Supplemental detail on insurance transactions Affiliation Parameter (optional, multiple values allowed) The Affiliation parameter specifies the trade direction for the services transactions. There are five valid parameter values other than “All”: 1. AllAffiliations – The total for all trade, whether affiliated or unaffiliated Appendix M: Page 2 of 4 February 16, 2018 2. 3. 4. 5. Unaffiliated – Unaffiliated trade Affiliated – Affiliated trade UsParents – U.S. parents’ trade with their foreign affiliates UsAffiliates – U.S. affiliates’ trade with their foreign parent groups AreaOrCountry Parameter (optional, multiple values allowed) The AreaOrCountry parameter specifies the counterparty area or country of the services 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 TypeOfService parameter value other than “All” is requested. That is, a list of countries can only be specified if a single TypeOfService is specified. For information on geographic area definitions, see https://www.bea.gov/international/bp_web/geographic_area_definitions.pdf Year Parameter (optional, multiple values allowed) The Year parameter specifies the year of the data requested. IntlServTrade (International Services Trade) Dimensions Elements in Return Data Parameter Name Ordinal Datatype IsValue Description TypeOfService 1 String No The TypeOfService parameter value of the data item. TradeDirection 2 String No The TradeDirection parameter value of the data item. Affiliation 3 String No The Affiliation parameter value of the data item. AreaOrCountry 4 String No The AreaOrCountry parameter value of the data item. Year 5 String No The Year parameter value of the data item. TimeSeriesId 6 String No A unique identifier for the time series of the data item. TimeSeriesDescription 7 String No TimePeriod 8 String No CL_UNIT 9 String No UNIT_MULT 10 String No DataValue 11 Numeric No Appendix M: Page 3 of 4 A description of the transactions measured in the data item. A string containing the time period for the data item in the form YYYY for annual data A string indicating the base unit of measurement of the 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 multiplier used to interpret the data value. For example “6” refers to millions (DataValue × 106). An integer or decimal value of the statistic. May be blank. February 16, 2018 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 commadelimited string. Any NoteRef attribute included in the data is guaranteed to have a corresponding Notes element. The NoteRef attribute may be blank. Appendix M: Page 4 of 4 February 16, 2018
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.6 Linearized : Yes Author : Walt Kampas Create Date : 2018:02:16 10:57:01-05:00 Modify Date : 2018:02:16 10:57:01-05:00 Title : Tagged PDF : Yes XMP Toolkit : Adobe XMP Core 5.6-c015 84.159810, 2016/09/10-02:41:30 Metadata Date : 2018:02:16 10:57:01-05:00 Creator Tool : Acrobat PDFMaker 17 for Word Format : application/pdf Creator : Walt Kampas Document ID : uuid:d8489414-68ae-4928-953f-20fddd52a184 Instance ID : uuid:dbe00506-075f-4fe3-bf95-f8e53e639d5e Producer : Adobe PDF Library 15.0 Page Count : 67EXIF Metadata provided by EXIF.tools