Bea Web Service Api User Guide

User Manual: Pdf

Open the PDF directly: View PDF .
Page Count: 54

Introduction
Access to the BEA API
JavaScript Usage
Data Return Format
Error Return Format
Meta-Data API Methods
Data Retrieval API Method
DataSet Documentation
Appendix A – RegionalData (statistics by state, county, and MSA)
RegionalData Request Parameters
Examples of RegionalData Requests
Summary of available data
- Statistics newly available to the API are highlighted
Parameter Details
Appendix B – NIPA (National Income and Product Accounts)
NIPA Dataset Result Data
Appendix C – NIUnderlyingDetail (National Income and Product Accounts)
UNDERLYING DETAIL Dataset Result Data
Appendix D – Fixed Assets
Fixed Assets Dataset Result Data
Appendix E – Data on Direct Investment and Multinational Enterprises (MNEs)
- Type 1: Direct Investment (DI) Data Request
- Examples of Direct Investment (DI) Data Requests
- Type 2: Activities of Multinational Enterprises (AMNE) Data Request
- Examples of Activities of Multinational Enterprises (AMNE) Data Requests
- Parameter Details
Appendix F – Gross Domestic Product by Industry (GDPbyIndustry)
- Gross Domestic Product by Industry (GDPbyIndustry) Data Request
- Examples of GDP by Industry (GDPbyIndustry) Data Requests
- Parameter Details
Appendix G – ITA (International Transactions)
- ITA (International Transactions) Data Request Parameters
- Examples of ITA (International Transactions) Data Requests
- Parameter Details
- ITA (International Transactions) Dimensions Elements in Return Data
Appendix H – IIP (International Investment Position)
- IIP (International Investment Position) Data Request Parameters
- Examples of IIP (International Investment Position) Data Requests
- Parameter Details
- IIP (International Investment Position) Dimensions Elements in Return Data

1 | Page Tuesday, September 30, 2014

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 http://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: http://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:

http://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 three 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

2 | Page Tuesday, September 30, 2014

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:

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetData&datasetname=RegionalData&KeyCode=PCPI_CI&GeoFIPS=STATE&Year=2010&R

esultFormat=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:

http://www.bea.gov/api/data?&UserID=Your-36Character-

Key&method=GETDATASETLIST&ResultFormat=XML&

This request would return a list of the available datasets in JSON format:

http://www.bea.gov/api/data?&UserID=Your-36Character-

Key&method=GETDATASETLIST&ResultFormat=JSON&

The data returned from the API always has the following basic structure, with some additional structure

depending on the data requested:

</Request>

</Results>

</BEAAPI>

In XML form, the root node is always <BEAAPI>, followed by the child node <Request>. The <Request> node

contains <RequestParam> children that echo the parameters passed in the request. The root node, <BEAAPI>,

then has another child node, <Results>, containing the results of the request. The Results content is different

2 Java Script Object Notation

3 Extensible Markup Language

3 | Page Tuesday, September 30, 2014

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-36Character-Key"

{

"ParameterName":"METHOD",

"ParameterValue":"GETDATASETLIST"

{

"ParameterName":"ResultFormat",

"ParameterValue":"JSON"

}

]

"Results":{

"Dataset":[

{

"DatasetName":"RegionalData",

"DatasetDescription":"Retrieves various Regional datasets"

{

"DatasetName":"NIPA",

"DatasetDescription":"Standard NIPA tables"

}

]

}

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:

</Request>

</Results>

</BEAAPI>

Meta-Data API Methods

The API contains three methods for retrieving meta-data as follows:

GetDataSetList – retrieves a list of the datasets currently offered.

Required Parameters: UserID, Method

Optional Parameters: ResultFormat

Result: Dataset node with DatasetName and DatasetDescription attributes.

4 | Page Tuesday, September 30, 2014

Example Request:

http://www.bea.gov/api/data?&UserID=Your-36Character-

Key&method=GETDATASETLIST&ResultFormat=XML&

Example Return:

</Request>

</Results>

</BEAAPI>

GetParameterList – 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:

http://www.bea.gov/api/data?&UserID=Your-36Character-

Key&method=getparameterlist&datasetname=RegionalData&

Example Return:

</Request>

<Parameter ParameterName="KeyCode" ParameterDataType="string" ParameterDescription="The code of the key statistic requested" ParameterIsRequiredFlag="1"

ParameterDefaultValue="" MultipleAcceptedFlag="0" AllValue="" />

<Parameter ParameterName="GeoFips" ParameterDataType="string" ParameterDescription="GeoFips Code" ParameterIsRequiredFlag="0" ParameterDefaultValue="STATE"

MultipleAcceptedFlag="1" AllValue="" />

<Parameter ParameterName="Year" ParameterDataType="integer" ParameterDescription="Year" ParameterIsRequiredFlag="0" ParameterDefaultValue="ALL" MultipleAcceptedFlag="1"

AllValue="ALL" />

</Results>

</BEAAPI>

5 | Page Tuesday, September 30, 2014

In this example, the parameters for the “RegionalData” dataset are being requested. The results indicate that the

dataset has three parameters: KeyCode, GeoFIPS, and Year.

KeyCode is a string typed parameter that would be used to specify which statistic is being requested. We can’t

tell from this what the valid KeyCodes 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).

GeoFIPS is a string typed parameter described as the GeoFIPS code. GeoFIPS is not required, and if it is not

supplied, the default value used is “STATE”. Multiple values are accepted, and there not a special value

meaning “all”.

Year is an integer typed parameter described as “Year”. It is not required in a request, and if is not included, the

default value used is “ALL”. Because this is also the AllValue value, the effect of not including the parameter

in a request would be to default to all available years.

GetParameterValues – retrieves a list of the valid values for a particular parameter.

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:

http://bea.gov/api/data?&UserID=Your-36Character-

Key&method=GetParameterValues&datasetname=RegionalData&ParameterName=keycode&

Example Return:

</Request>

6 | Page Tuesday, September 30, 2014

</Results>

</BEAAPI>

To summarize, the API includes three methods that retrieve meta-data about the statistics that are available: GetDatasetList, GetParameterList, and

GetParameterValues.

Data Retrieval API Method

The API has one method for retrieving data – GetData.

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.

GetData

Required Parameters: UserID, Method, DatasetName, additional required parameters (depending on the

dataset)

7 | Page Tuesday, September 30, 2014

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

• 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 base-10

exponent that should be applied to the data value (e.g. amounts reported in millions would have a

UNIT_MULT of 6; amounts reported in billions would have a UNIT_MULT of 9).

The specific meaning of each dimension is described in the Appendix for each dataset.

The result then includes Data nodes containing the actual results specified in the parameters. Each Data node

contains one attribute for each data dimension (specified in the Dimensions nodes).

Finally, the result may include Note nodes. Notes (as in footnotes) further describe or qualify any of the other

nodes in the result (or the result node itself). A result node qualified by a Note has an attribute named NoteRef.

If a result node includes the NoteRef attribute, the value for it will always be present among the Notes nodes.

Example Request:

http://www.bea.gov/api/data?&UserID=Your-36Character-

Key&method=GetData&datasetname=RegionalData&KeyCode=PCPI_CI&GeoFIPS=STATE&Year=2009&Resul

tFormat=XML&

In this example, the GetData method is used to return the dataset named RegionalData. The KeyCode

parameter is used to request statistic for “Per Capita personal income (county annual income)” – as shown in the

ParameterList meta-data above. The GeoFIPS parameter value is “STATE” – meaning the data for all states is

requested. Finally, a single year’s data is requested – 2009.

Note that the GeoFIPS parameter could have been “COUNTY” for all counties, or a list of individual state or

county GeoFIPS codes. Also, multiple years could have been requested by providing them in a comma-

separated list.

Example Return:

8 | Page Tuesday, September 30, 2014

</Request>

<Notes NoteRef="2" NoteText="Per capita personal income was computed using Census Bureau midyear population estimates. Estimates for 2000-2011 reflect county population

estimates available as of April 2012." />

9 | Page Tuesday, September 30, 2014

<Notes NoteRef="*" NoteText="La Paz County, AZ was separated from Yuma County on January 1, 1983. The Yuma, AZ MSA contains the area that became La Paz County, AZ through 1982

and excludes it beginning with 1983." />

<Notes NoteRef="*" NoteText="Broomfield County, CO, was created from parts of Adams, Boulder, Jefferson, and Weld counties effective November 15, 2001. Estimates for Broomfield

county begin with 2002." />

<Notes NoteRef="*" NoteText="Estimates for 1979 forward reflect Alaska Census Areas as defined by the Census Bureau; those for prior years reflect Alaska Census Divisions as defined in

the 1970 Decennial Census. Estimates from 1988 forward separate Aleutian Islands Census Area into Aleutians East Borough and Aleutians West Census Area. Estimates for 1991 forward

separate Denali Borough from Yukon-Koyukuk Census Area and Lake and Peninsula Borough from Dillingham Census Area. Estimates from 1993 forward separate Skagway-Yakutat-Angoon

Census Area into Skagway-Hoonah-Angoon Census Area and Yakutat Borough. Estimates from 2008 forward separate Skagway-Hoonah-Angoon Census Area into Skagway Borough and

Hoonah-Angoon Census Area. Estimates from 2009 forward separate Wrangell-Petersburg Census Area into Petersburg Census Area and Wrangell City and Borough. In addition, a part of the

Prince of Wales-Outer Ketchikan Census Area was annexed by Ketchikan Gateway Borough and part (Meyers Chuck Area) was included in the new Wrangell City and Borough. The remainder

of the Prince of Wales-Outer Ketchikan Census Area was renamed Prince of Wales-Hyder Census Area." />

<Notes NoteRef="*" NoteText="Virginia combination areas consist of one or two independent cities with 1980 populations of less than 100,000 combined with an adjacent county. The

county name appears first, followed by the city name(s). Separate estimates for the jurisdictions making up the combination area are not available." />

</Results>

</BEAAPI>

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 also several Data nodes having a NoteRef attribute with the value “*”, and there are several Notes

nodes having the matching NoteRef attribute (“*”). This should be interpreted to mean that the Notes nodes

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.

10 | Page Tuesday, September 30, 2014

Appendix A – RegionalData (statistics by state, county, and MSA)

The RegionalData dataset contains estimates from the Regional Economic Accounts. These include estimates of

GDP by state and metropolitan area; estimates of personal income and employment by state, metropolitan area,

and county; and regional price parities by state and MSA.

RegionalData Request Parameters

Parameter Name Type Description Required

Multiple

Values

Accepted

“All”

value Default

KeyCode String

The code for the

statistic requested

Yes No

GeoFips String The state, county or

MSA code No Yes

STATE

COUNTY

MSA

STATE

Year String Year requested No Yes ALL

ALL

Examples of RegionalData Requests

Personal income for 2011 and 2012 for all counties, in JSON format

http://bea.gov/api/data/?UserID=Your-36Character-

Key&method=GetData&datasetname=RegionalData&KeyCode=TPI_CI&Year=2012,2011&Ge

oFips=COUNTY&ResultFormat=json

Real GDP for all years, all states, in XML format

http://bea.gov/api/data/?UserID=Your-36Character-

Key&method=GetData&datasetname=RegionalData&KeyCode=GDP_SP&Year=ALL&GeoFips=

STATE&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

GeoFips

http://bea.gov/api/data/?UserID=Your-36Character-

Key&method=GetParameterValues&datasetname=RegionalData&ParameterNa

me=GeoFips&ResultFormat=xml

11 | Page Tuesday, September 30, 2014

Year

http://bea.gov/api/data/?UserID=Your-36Character-

Key&method=GetParameterValues&datasetname=RegionalData&ParameterNa

me=Year&ResultFormat=xml

KeyCode

http://bea.gov/api/data/?UserID=Your-36Character-

Key&method=GetParameterValues&datasetname=RegionalData&ParameterNa

me=KeyCode&ResultFormat=xml

Summary of available data

Statistics newly available to the API are highlighted

KeyCode Classification Statistic BeginYear

GDP_SP state annual product GDP in current dollars 1997

RGDP_SP state annual product Real GDP in chained dollars 1997

PCRGDP_SP state annual product Per capita real GDP 1997

COMP_SP state annual product Compensation of employees 1997

TOPILS_SP state annual product Taxes on production and

imports less subsidies 1997

GOS_SP state annual product Gross operating surplus 1997

SUBS_SP state annual product Subsidies 1997

TOPI_SP state annual product Taxes on production and

imports 1997

GDP_MP MSA annual product GDP in current dollars 2001

RGDP_MP MSA annual product Real GDP in chained dollars 2001

PCRGDP_MP MSA annual product Per capita real GDP 2001

TPI_SI state annual income Total personal income 1929

12 | Page Tuesday, September 30, 2014

POP_SI

state annual income

Population

1929

PCPI_SI

state annual income

Per capita personal income

1929

NFPI_SI

state annual income

Nonfarm personal income

1929

FPI_SI

state annual income

Farm income

1929

EARN_SI

state annual income

Earnings by place of work

1929

CGSI_SI state annual income

Contributions for government

social insurance

1929

AR_SI

state annual income

Adjustment for residence

1948

NE_SI state annual income

Net earnings by place of

residence

1929

DIR_SI state annual income Dividends, interest, and rent 1929

PCTR_SI state annual income

Personal current transfer

receipts

1929

WS_SI state annual income Wages and salaries 1929

SUPP_SI state annual income

Supplements to wages and

salaries

1929

PROP_SI state annual income Proprietors’ Income 1929

EMP000_SI state annual income

Total employment (full and

part time)

1969

EMP100_SI

state annual income

Wage and salary employment

1969

EMP200_SI

state annual income

Proprietors’ employment

1969

PJEARN_SI

state annual income

Average earnings per job

1969

PJWS_SI

state annual income

Average wage per job

1969

PJCOMP_SI

state annual income

Average compensation per job

1998

DPI_SI state annual income Disposable personal income 1948

PCDPI_SI state annual income

Per capita disposable personal

income (dollars)

1948

PCNE_SI

state annual income

Per capita net earnings

1958

PCTRAN_SI state annual income

Per capita personal current

transfer receipts

1958

PCINCMAIN_SI state annual income

Per capita income

maintenance

1958

PCUNIC_SI state annual income

Per capita unemployment

insurance compensation

1958

PCRET_SI state annual income

Per capita retirement and

other

1958

PCDIR_SI state annual income

Per capita dividends, interest,

and rent

1958

TPI_CI county annual income Total personal income 1969

POP_CI county annual income Population 1969

13 | Page Tuesday, September 30, 2014

PCPI_CI

county annual income

Per capita personal income

1969

NFPI_CI

county annual income

Nonfarm personal income

1969

FPI_CI

county annual income

Farm income

1969

EARN_CI

county annual income

Earnings by place of work

1969

CGSI_CI county annual income

Contributions for government

social insurance

1969

AR_CI

county annual income

Adjustment for residence

1969

NE_CI county annual income

Net earnings by place of

residence

1969

DIR_CI county annual income Dividends, interest, and rent 1969

PCTR_CI county annual income

Personal current transfer

receipts

1969

WS_CI county annual income Wages and salaries 1969

SUPP_CI county annual income

Supplements to wages and

salaries

1969

PROP_CI

county annual income

Proprietors' Income

1969

EMP000_CI county annual income

Total employment (full and

part time)

1969

EMP100_CI

county annual income Wage and salary employment 1969

EMP200_CI

county annual income

Proprietors’ employment

1969

PJEARN_CI

county annual income

Average earnings per job

1969

PJWS_CI

county annual income

Average wage per job

1969

PJCOMP_CI

county annual income

Average compensation per job

2001

PCNE_CI

county annual income

Per capita net earnings

1969

PCTRAN_CI county annual income

Per capita personal current

transfer receipts

1969

PCINCMAIN_CI county annual income

Per capita income

maintenance

1969

PCUNIC_CI county annual income

Per capita unemployment

insurance compensation

1969

PCRET_CI county annual income

Per capita retirement and

other

1969

PCDIR_CI county annual income

Per capita dividends, interest,

and rent

1969

TPI_MI MSA annual income Total personal income 1969

POP_MI MSA annual income Population 1969

PCPI_MI MSA annual income Per capita personal income 1969

NFPI_MI

MSA annual income Nonfarm personal income 1969

FPI_MI

MSA annual income

Farm income

1969

EARN_MI

MSA annual income

Earnings by place of work

1969

14 | Page Tuesday, September 30, 2014

CGSI_MI MSA annual income

Contributions for government

social insurance

1969

AR_MI MSA annual income Adjustment for residence 1969

NE_MI MSA annual income

Net earnings by place of

residence

1969

DIR_MI MSA annual income Dividends, interest, and rent 1969

PCTR_MI MSA annual income

Personal current transfer

receipts

1969

WS_MI

MSA annual income

Wages and salaries

1969

SUPP_MI MSA annual income

Supplements to wages and

salaries

1969

PROP_MI

MSA annual income

Proprietors’ income

1969

EMP000_MI MSA annual income

Total employment (full and

part time)

1969

EMP100_MI MSA annual income Wage and salary employment 1969

EMP200_MI MSA annual income Proprietors’ employment 1969

PJEARN_MI MSA annual income Average earnings per job 1969

PJWS_MI

MSA annual income Average wage per job 1969

PJCOMP_MI

MSA annual income Average compensation per job 2001

PCNE_MI

MSA annual income

Per capita net earnings

1969

PCTRAN_MI MSA annual income

Per capita personal current

transfer receipts

1969

PCINCMAIN_MI MSA annual income

Per capita income

maintenance

1969

PCUNIC_MI MSA annual income

Per capita unemployment

insurance compensation

1969

PCRET_MI MSA annual income

Per capita retirement and

other

1969

PCDIR_MI MSA annual income

Per capita dividends, interest,

and rent

1969

TPI_QI state quarterly income Total personal income 1948

NFPI_QI state quarterly income Nonfarm personal income 1948

FPI_QI state quarterly income Farm income 1948

EARN_QI state quarterly income Earnings by place of work 1948

CGSI_QI state quarterly income

Contributions for government

social insurance

1948

AR_QI state quarterly income Adjustment for residence 1948

NE_QI state quarterly income

Net earnings by place of

residence

1948

DIR_QI

state quarterly income

Dividends, interest, and rent

1948

PCTR_QI

state quarterly income

Personal current transfer

1948

15 | Page Tuesday, September 30, 2014

receipts

WS_QI

state quarterly income

Wages and salaries

1948

SUPP_QI state quarterly income

Supplements to wages and

salaries

1948

PROP_QI state quarterly income Proprietors’ income 1948

RPI_SI

state regional price parities

Real personal income

2008

RPCPI_SI state regional price parities

Per capita real personal

income

2008

RPPIPD_SI state regional price parities Implicit regional price deflator 2008

RPPALL_SI state regional price parities RPPs: All items 2008

RPPGOODS_SI state regional price parities RPPs: Goods 2008

RPPRENTS_SI state regional price parities RPPs: Services: Rents 2008

RPPOTHER_SI state regional price parities RPPs: Services: Other 2008

RPI_MI

MSA regional price parities

Real personal income

2008

RPCPI_MI MSA regional price parities

Per capita real personal

income

2008

RPPIPD_MI MSA regional price parities Implicit regional price deflator 2008

RPPALL_MI MSA regional price parities RPPs: All items 2008

RPPGOODS_MI MSA regional price parities RPPs: Goods 2008

RPPRENTS_MI MSA regional price parities RPPs: Services: Rents 2008

RPPOTHER_MI

MSA regional price parities

RPPs: Services: Other

2008

Parameter Details

KeyCode parameter – (required, single value)

KeyCode specifies a statistic drawn from the regional income and product accounts public tables. Exactly one

KeyCode must be provided.

GeoFips parameter – (optional, multiple value)

GeoFips specifies geography. It can be all states (STATE), all counties (COUNTY), or all MSAs (MSA). It can

also be a list of ANSI state-county codes or metropolitan statistical area codes. For example, the counties in

Connecticut and Delaware–

09001,09003,09005,09007,09009,09011,09013,09015,10001,10003,10005

GeoFips will default to all states, counties, or MSAs, if not specified. State, county, and metropolitan statistical

area FIPS codes can be obtained from Census at http://www.census.gov/geo/www/ansi/ansi.html. A

16 | Page Tuesday, September 30, 2014

comprehensive list of MSAs and their component counties can be accessed here

http://www.bea.gov/regional/docs/msalist.cfm.

Year parameter – (optional, multiple value)

Year is either a list of years, or ALL. Year will default to all available years if the parameter is not specified.

Errors

An invalid KeyCode will result in an error code of 99, unknown error.

An invalid GeoFips or Year will result in an error code of 101, no data returned.

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: http://bea.gov/regional/. Definitions of the estimates can be accessed at our

glossary of regional definitions, at http://bea.gov/regional/definitions/. Regional Product and Income

Methodologies can be found at http://bea.gov/regional/methods.cfm.

17 | Page Tuesday, September 30, 2014

Appendix B – NIPA (National Income and Product Accounts)

The NIPA dataset contains data from the standard set of NIPA tables as published in the Survey of Current

Business. Availability of updated NIPA data follows the BEA News Release schedule as posted on the BEA

web site. The NIPA dataset may be unavailable for a few minutes preceding the monthly GDP release while

data is being updated (as it is for all other methods of acquiring newly released data). Four parameters are used

to retrieve data from the NIPA dataset, as follows:

Name

Type

Description

Is Required

Multiple

Values

Accepted

“All” value

TableID

Integer

The standard NIPA

table identifier

Yes

N/A

Frequency

String

A - Annual, Q-

Quarterly, M-

Monthly

Yes

N/A

Year

integer

List of year(s) of

data to retrieve

Yes

“X”

ShowMillions

String

A flag indicating

that million-dollar

data should be

returned

N/A

TableID Parameter

The TableID parameter is an integer that refers to a specific NIPA table. As shown above, the parameter is

required, and only one NIPA table can be requested in each GetData submission. The list of valid TableIDs

may change depending on the monthly news release cycles. For example, after the monthly GDP release and

before the following Personal Income release, a few of the Personal Income tables are temporarily unavailable.

The full list of valid NIPA TableIDs is as follows:

<ParamValue TableID="26" Description="Table 1.4.1. Percent Change From Preceding Period in Real Gross Domestic Product, Real Gross Domestic Purchases, and Real Final Sales to

Domestic Purchasers (A) (Q)" />

<ParamValue TableID="27" Description="Table 1.4.3. Real Gross Domestic Product, Real Gross Domestic Purchases, and Real Final Sales to Domestic Purchasers, Quantity Indexes (A) (Q)"

18 | Page Tuesday, September 30, 2014

<ParamValue TableID="30" Description="Table 1.4.6. Relation of Real Gross Domestic Product, Real Gross Domestic Purchases, and Real Final Sales to Domestic Purchasers, Chained

Dollars (A) (Q)" />

<ParamValue TableID="40" Description="Table 1.7.1. Percent Change from Preceding Period in Real Gross Domestic Product, Real Gross National Product, and Real Net National Product

(A) (Q)" />

<ParamValue TableID="55" Description="Table 1.14. Gross Value Added of Domestic Corporate Business in Current Dollars and Gross Value Added of Nonfinancial Domestic Corporate

Business in Current and Chained Dollars (A) (Q)" />

<ParamValue TableID="316" Description="Table 1.17.1. Percent Change From Preceding Period in Real Gross Domestic Product, Real Gross Domestic Income, and Other Major NIPA

Aggregates (A) (Q)" />

<ParamValue TableID="100" Description="Table 3.10.1. Percent Change From Preceding Period in Real Government Consumption Expenditures and General Government Gross Output (A)

(Q)" />

19 | Page Tuesday, September 30, 2014

<ParamValue TableID="105" Description="Table 3.11.1. Percent Change From Preceding Period in Real National Defense Consumption Expenditures and Gross Investment by Type (A) (Q)"

<ParamValue TableID="121" Description="Table 3.18A. Relation of Federal Government Current Receipts and Expenditures in the National Income and Product Accounts to the Consolidated

Cash Statement, Fiscal Years and Quarters (A) (Q)" />

<ParamValue TableID="122" Description="Table 3.18B. Relation of Federal Government Current Receipts and Expenditures in the National Income and Product Accounts to the Budget,

Fiscal Years and Quarters (A) (Q)" />

<ParamValue TableID="123" Description="Table 3.19. Relation of State and Local Government Current Receipts and Expenditures in the National Income and Product Accounts to Census

Bureau "Government Finances" Data, Fiscal Years (A)" />

<ParamValue TableID="135" Description="Table 4.3A. Relation of Foreign Transactions in the National Income and Product Accounts to the Corresponding Items in the International

Transactions Accounts (A)" />

<ParamValue TableID="136" Description="Table 4.3B. Relation of Foreign Transactions in the National Income and Product Accounts to the Corresponding Items in the International

Transactions Accounts (A)" />

20 | Page Tuesday, September 30, 2014

21 | Page Tuesday, September 30, 2014

<ParamValue TableID="290" Description="Table 7.13. Relation of Consumption of Fixed Capital in the National Income and Product Accounts to Depreciation and Amortization as Published

by the Internal Revenue Service (A)" />

<ParamValue TableID="291" Description="Table 7.14. Relation of Nonfarm Proprietors' Income in the National Income and Product Accounts to Corresponding Measures as Published by the

Internal Revenue Service (A)" />

<ParamValue TableID="292" Description="Table 7.15. Relation of Net Farm Income in the National Income and Product Accounts to Net Farm Income as Published by the U.S. Department

of Agriculture (A)" />

<ParamValue TableID="293" Description="Table 7.16. Relation of Corporate Profits, Taxes, and Dividends in the National Income and Product Accounts to Corresponding Measures as

Published by the Internal Revenue Service (A)" />

<ParamValue TableID="294" Description="Table 7.17. Relation of Monetary Interest Paid and Received in the National Income and Product Accounts to Corresponding Measures as

Published by the Internal Revenue Service (A)" />

<ParamValue TableID="295" Description="Table 7.18. Relation of Wages and Salaries in the National Income and Product Accounts to Wages and Salaries as Published by the Bureau of

Labor Statistics (A)" />

<ParamValue TableID="296" Description="Table 7.20. Comparison of Income and Outlays of Nonprofit Institutions Serving Households with Revenue and Expenses as Published by the

Internal Revenue Service (A)" />

Note that the description of each table also indicates the frequencies that are available for each table –

A=Annual, Q=Quarterly, M=Monthly

Requesting an invalid TableID returns this error:

</Error>

Omitting the TableID parameter returns this error:

</AdditionalDetail>

</Error>

Frequency Parameter

The Frequency parameter is a string that refers to the time series for the requested NIPA table. As shown

above, the parameter is required, and multiple frequencies can be requested in each GetData submission.

Multiple frequencies are requested by specifying them as a comma-delimited string, e.g. “A,Q,M”. When data

is requested for frequencies that don’t exist for a particular NIPA table, only data that exists is returned.

The full list of valid frequencies is as follows:

If an invalid frequency is supplied in the GetData request (e.g. “Z”), this error is returned:

22 | Page Tuesday, September 30, 2014

</Error>

If only frequencies that don’t exist for a particular table are requested, this error is returned:

</Error>

Omitting the Frequency parameter returns this error:

</AdditionalDetail>

</Error>

Year Parameter

The Year parameter is an integer that specifies the year(s) of data for the requested NIPA 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 NIPA 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” for the Year parameter, all available years of data are

returned. Note that using the “X” 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:

</Error>

Omitting the Year parameter returns this error:

</AdditionalDetail>

</Error>

Using the GetParameterValues meta-data retrieval method for the Year parameter returns a list of the valid year

ranges for each NIPA table. Each NIPA table may have a different range of years available for different

frequencies, so the valid combinations of years and frequencies are shown for each NIPA table. For example,

Table 1 (at the time of this writing) has annual data from 1930 through 2011, Quarterly data from 1947 through

2012, and no monthly data as indicated in this example return data from the GetParameterValues method:

23 | Page Tuesday, September 30, 2014

24 | Page Tuesday, September 30, 2014

ShowMillions Parameter

The ShowMillions parameter is a string indicates whether data for the requested NIPA table should be returned

in million-dollar units. As shown above, the parameter is optional. Million-dollar estimate data doesn’t exist

for all tables, and data is returned in million-dollar units only if available. When million-dollar data doesn’t

exist for a table, data is returned as if million-dollar data was not requested. In addition, requests for million-

dollar data are always returned with a cautionary footnote about million-dollar estimates.

The valid values for the ShowMillions parameter are:

Invalid values for the ShowMillions parameter (e.g. “Z” or “cupcake”) are ignored.

NIPA Dataset Result Data

The NIPA dataset returns data in the standard form described in the API User documentation. In XML form,

the main structure of a result is:

</BEAAPI>

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:

<Data TableID="5" SeriesCode="A191RC" LineNumber="1" LineDescription="Gross domestic product" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="13,973.7"

NoteRef="5" />

<Data TableID="5" SeriesCode="DPCERC" LineNumber="2" LineDescription="Personal consumption expenditures" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9"

DataValue="9,845.9" NoteRef="5" />

<Data TableID="5" SeriesCode="DDURRC" LineNumber="4" LineDescription="Durable goods" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="1,029.6"

NoteRef="5" />

<Data TableID="5" SeriesCode="DNDGRC" LineNumber="5" LineDescription="Nondurable goods" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="2,164.8"

NoteRef="5" />

25 | Page Tuesday, September 30, 2014

<Data TableID="5" SeriesCode="A006RC" LineNumber="7" LineDescription="Gross private domestic investment" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9"

DataValue="1,549.3" NoteRef="5" />

<Data TableID="5" SeriesCode="A007RC" LineNumber="8" LineDescription="Fixed investment" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="1,703.5"

NoteRef="5" />

<Data TableID="5" SeriesCode="A008RC" LineNumber="9" LineDescription="Nonresidential" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="1,349.3"

NoteRef="5" />

<Data TableID="5" SeriesCode="B010RC" LineNumber="11" LineDescription="Equipment and software" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="898.2"

NoteRef="5" />

<Data TableID="5" SeriesCode="A014RC" LineNumber="13" LineDescription="Change in private inventories" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="-

154.2" NoteRef="5" />

<Data TableID="5" SeriesCode="A019RC" LineNumber="14" LineDescription="Net exports of goods and services" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="-

388.7" NoteRef="5" />

<Data TableID="5" SeriesCode="A822RC" LineNumber="21" LineDescription="Government consumption expenditures and gross investment" TimePeriod="2009" CL_UNIT="USD"

UNIT_MULT="9" DataValue="2,967.2" NoteRef="5" />

<Data TableID="5" SeriesCode="A824RC" LineNumber="23" LineDescription="National defense" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="776.0"

NoteRef="5" />

<Data TableID="5" SeriesCode="A829RC" LineNumber="25" LineDescription="State and local" TimePeriod="2009" CL_UNIT="USD" UNIT_MULT="9" DataValue="1,823.6"

NoteRef="5" />

All requests for the NIPA 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

Name

Datatype

IsValue

TableID

numeric

SeriesCode

string

LineNumber

numeric

LineDescription

TimePeriod

string

CL_UNIT

string

UNIT_MULT

numeric

DataValue

numeric

Yes

NoteRef4

string

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 NIPA table ID as submitted in the request (an integer).

SeriesCode – A string containing the a unique identifier for the line item in the published NIPA table.

4 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.

26 | Page Tuesday, September 30, 2014

LineNumber – The line number of the data item as shown in published print versions of the published NIPA

table.

LineDescription – The “stub” or description of the statistic in the published NIPA table.

TimePeriod – A string containing the time period for the data item in the form YYYY for annual data,

YYYYQn for quarterly data (where n is the quarter digit), and YYYYMnn for monthly data (where nn is 2

digits representing the month – i.e. ‘01’ through ‘12’).

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).

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 NIPA 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/series/timeperiods may be included in the comma-delimited Noteref string

value.

27 | Page Tuesday, September 30, 2014

Appendix C – NIUnderlyingDetail (National Income and Product Accounts)

The NIUnderlyingDetail dataset contains detailed estimate data from underlying NIPA series that appear in the

national income and product account (NIPA) tables as published in the Survey of Current Business. Three

parameters are used to retrieve data from the NIUnderlyingDetail dataset, as follows:

Name

Type

Description

Is Required

Multiple

Values

Accepted

“All” value

TableID

Integer

The standard NIPA

table identifier

Yes

N/A

Frequency

String

A - Annual, Q-

Quarterly, M-

Monthly

Yes

N/A

Year

integer

List of year(s) of

data to retrieve

Yes

“X”

TableID Parameter

The TableID parameter is an integer that refers to a specific NIPA table. As shown above, the parameter is

required, and only one Underlying Detail table can be requested in each GetData submission.

The full list of valid Underlying Detail TableIDs is as follows:

<ParamValue TableID="23" Description="Table 1BU. Real Manufacturing and Trade Inventories, Seasonally Adjusted, End of Period [Chained 2005 dollars, 1997 forward, NAICS] (A) (Q) (M)"

<ParamValue TableID="2" Description="Table 3BU. Real Inventory-Sales Ratios for Manufacturing and Trade, Seasonally Adjusted [Based on chained 2005 dollars, 1997 forward, NAICS] (A)

(Q) (M)" />

<ParamValue TableID="3" Description="Table 4AU1. Real Manufacturing Inventories, by Stage of Fabrication (Materials and supplies), Seasonally Adjusted, End of Period [Chained 2005

dollars, 1967-97, SIC] (Q) (M)" />

<ParamValue TableID="4" Description="Table 4AU2. Real Manufacturing Inventories, by Stage of Fabrication, Seasonally Adjusted (Work-in-process), End of Period [Chained 2005 dollars,

1967-97, SIC] (Q) (M)" />

<ParamValue TableID="5" Description="Table 4AU3. Real Manufacturing Inventories, by Stage of Fabrication (Finished goods), Seasonally Adjusted, End of Period [Chained 2005 dollars,

1967-97, SIC] (Q) (M)" />

<ParamValue TableID="6" Description="Table 4BU1. Real Manufacturing Inventories, by Stage of Fabrication (Materials and supplies), Seasonally Adjusted, End of Period [Chained 2005

dollars, 1997 forward, NAICS] (A) (Q) (M)" />

<ParamValue TableID="7" Description="Table 4BU2. Real Manufacturing Inventories, by Stage of Fabrication (Work-in-process), Seasonally Adjusted, End of Period [Chained 2005 dollars,

1997 forward, NAICS] (A) (Q) (M)" />

<ParamValue TableID="8" Description="Table 4BU3. Real Manufacturing Inventories, by Stage of Fabrication (Finished goods), Seasonally Adjusted, End of Period [Chained 2005 dollars, 1997

forward, NAICS] (A) (Q) (M)" />

<ParamValue TableID="73" Description="Table 4.3BU. Relation of Foreign Transactions in the National Income and Product Accounts to the Corresponding Items in the International

Transactions Accounts (Q)" />

28 | Page Tuesday, September 30, 2014

Note that the description of each table also indicates the frequencies that are available for each table –

A=Annual, Q=Quarterly, M=Monthly.

Requesting an invalid TableID returns this error:

</Error>

Omitting the TableID parameter returns this error:

</AdditionalDetail>

</Error>

Frequency Parameter

The Frequency parameter is a string that refers to the time series for the requested Underlying Detail table. As

shown above, the parameter is required, and multiple frequencies can be requested in each GetData submission.

Multiple frequencies are requested by specifying them as a comma-delimited string, e.g. “A,Q,M”. When data

is requested for frequencies that don’t exist for a particular Underlying Detail table, only data that exists is

returned.

The full list of valid frequencies is as follows:

If an invalid frequency is supplied in the GetData request (e.g. “Z”), this error is returned:

</Error>

If only frequencies that don’t exist for a particular table are requested, this error is returned:

29 | Page Tuesday, September 30, 2014

</Error>

Omitting the Frequency parameter returns this error:

</AdditionalDetail>

</Error>

Year Parameter

The Year parameter is an integer that specifies the year(s) of data for the requested Underlying Detail 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 Underlying Detail 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” for the Year parameter, all

available years of data are returned. Note that using the “X” 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:

</Error>

Omitting the Year parameter returns this error:

</AdditionalDetail>

</Error>

Using the GetParameterValues meta-data retrieval method for the Year parameter returns a list of the valid year

ranges for each UNDERLYING DETAIL table. Each UNDERLYING DETAIL table may have a different

range of years available for different frequencies, so the valid combinations of years and frequencies are shown

for each UNDERLYING DETAIL table. For example, Table 1 (at the time of this writing) has no annual data,

Quarterly data from 1967 through 1997, and monthly data from 1967 through 1997 as indicated in this example

return data from the GetParameterValues method:

30 | Page Tuesday, September 30, 2014

UNDERLYING DETAIL Dataset Result Data

The UNDERLYING DETAIL dataset returns data in the standard form described in the API User

documentation. In XML form, the main structure of a result is:

</BEAAPI>

The Request node of the result contains the parameters supplied to the request. For purposes of this example,

the parameters are:

31 | Page Tuesday, September 30, 2014

The result returned from this request would be:

<Data TableID="13" SeriesCode="DPCERG" LineNumber="1" LineDescription="Personal consumption expenditures (PCE)" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="109.004" NoteRef="13" />

<Data TableID="13" SeriesCode="DMOTRG" LineNumber="4" LineDescription="Motor vehicles and parts" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="97.948"

NoteRef="13" />

<Data TableID="13" SeriesCode="DFDHRG" LineNumber="5" LineDescription="Furnishings and durable household equipment" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="97.811" NoteRef="13" />

<Data TableID="13" SeriesCode="DREQRG" LineNumber="6" LineDescription="Recreational goods and vehicles" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="77.352"

NoteRef="13" />

<Data TableID="13" SeriesCode="DODGRG" LineNumber="7" LineDescription="Other durable goods" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="110.352"

NoteRef="13" />

<Data TableID="13" SeriesCode="DNDGRG" LineNumber="8" LineDescription="Nondurable goods" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="109.177"

NoteRef="13" />

<Data TableID="13" SeriesCode="DFXARG" LineNumber="9" LineDescription="Food and beverages purchased for off-premises consumption" TimePeriod="2009" CL_UNIT="PC"

UNIT_MULT="0" DataValue="113.366" NoteRef="13" />

<Data TableID="13" SeriesCode="DCLORG" LineNumber="10" LineDescription="Clothing and footwear" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="98.765"

NoteRef="13" />

<Data TableID="13" SeriesCode="DGOERG" LineNumber="11" LineDescription="Gasoline and other energy goods" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="106.008" NoteRef="13" />

<Data TableID="13" SeriesCode="DONGRG" LineNumber="12" LineDescription="Other nondurable goods" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="110.777"

NoteRef="13" />

<Data TableID="13" SeriesCode="DHCERG" LineNumber="14" LineDescription="Household consumption expenditures (for services)" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="112.655" NoteRef="13" />

<Data TableID="13" SeriesCode="DHUTRG" LineNumber="15" LineDescription="Housing and utilities" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="113.071"

NoteRef="13" />

<Data TableID="13" SeriesCode="DTRSRG" LineNumber="17" LineDescription="Transportation services" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="115.663"

NoteRef="13" />

<Data TableID="13" SeriesCode="DRCARG" LineNumber="18" LineDescription="Recreation services" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="111.000"

NoteRef="13" />

<Data TableID="13" SeriesCode="DFSARG" LineNumber="19" LineDescription="Food services and accommodations" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="114.211" NoteRef="13" />

<Data TableID="13" SeriesCode="DIFSRG" LineNumber="20" LineDescription="Financial services and insurance" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="108.990"

NoteRef="13" />

<Data TableID="13" SeriesCode="DNPIRG" LineNumber="22" LineDescription="Final consumption expenditures of nonprofit institutions serving households (NPISHs)" TimePeriod="2009"

CL_UNIT="PC" UNIT_MULT="0" DataValue="101.118" NoteRef="13,13.1" />

<Data TableID="13" SeriesCode="DNPERG" LineNumber="23" LineDescription="Gross output of nonprofit institutions" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="111.062" NoteRef="13,13.2" />

<Data TableID="13" SeriesCode="DNPSRG" LineNumber="24" LineDescription="Less: Receipts from sales of goods and services by nonprofit institutions" TimePeriod="2009" CL_UNIT="PC"

UNIT_MULT="0" DataValue="114.802" NoteRef="13,13.3" />

<Data TableID="13" SeriesCode="DPCCRG" LineNumber="25" LineDescription="PCE excluding food and energy" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="108.536"

NoteRef="13,13.4" />

<Data TableID="13" SeriesCode="DNRGRG" LineNumber="26" LineDescription="Energy goods and services" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="110.004"

NoteRef="13,13.5" />

<Data TableID="13" SeriesCode="DPCMRG" LineNumber="27" LineDescription="Market-based PCE" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="109.163"

NoteRef="13,13.6" />

<Data TableID="13" SeriesCode="DPCXRG" LineNumber="28" LineDescription="Market-based PCE excluding food and energy" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="108.641" NoteRef="13,13.6" />

<Data TableID="13" SeriesCode="DPCERG" LineNumber="29" LineDescription="Personal consumption expenditures" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="109.004" NoteRef="13" />

<Data TableID="13" SeriesCode="DPHCRG" LineNumber="30" LineDescription="Household consumption expenditures" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="109.233" NoteRef="13,13.7" />

<Data TableID="13" SeriesCode="DFXARG" LineNumber="31" LineDescription="Food and beverages purchased for off-premises consumption" TimePeriod="2009" CL_UNIT="PC"

UNIT_MULT="0" DataValue="113.366" NoteRef="13" />

<Data TableID="13" SeriesCode="DCAFRG" LineNumber="32" LineDescription="Clothing, footwear, and related services" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="99.607" NoteRef="13" />

<Data TableID="13" SeriesCode="DHUFRG" LineNumber="33" LineDescription="Housing, utilities, and fuels" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="113.104"

NoteRef="13" />

<Data TableID="13" SeriesCode="DFHHRG" LineNumber="34" LineDescription="Furnishings, household equipment, and routine household maintenance" TimePeriod="2009"

CL_UNIT="PC" UNIT_MULT="0" DataValue="101.775" NoteRef="13" />

<Data TableID="13" SeriesCode="DTRNRG" LineNumber="36" LineDescription="Transportation" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="104.857" NoteRef="13"

<Data TableID="13" SeriesCode="DCMCRG" LineNumber="37" LineDescription="Communication" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="99.594" NoteRef="13"

32 | Page Tuesday, September 30, 2014

<Data TableID="13" SeriesCode="DFSARG" LineNumber="40" LineDescription="Food services and accommodations" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="114.211" NoteRef="13" />

<Data TableID="13" SeriesCode="DIFSRG" LineNumber="41" LineDescription="Financial services and insurance" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="108.990"

NoteRef="13" />

<Data TableID="13" SeriesCode="DOISRG" LineNumber="42" LineDescription="Other goods and services" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0" DataValue="116.553"

NoteRef="13" />

<Data TableID="13" SeriesCode="DNPIRG" LineNumber="44" LineDescription="Final consumption expenditures of nonprofit institutions serving households (NPISHs)" TimePeriod="2009"

CL_UNIT="PC" UNIT_MULT="0" DataValue="101.118" NoteRef="13,13.1" />

<Data TableID="13" SeriesCode="DNPERG" LineNumber="45" LineDescription="Gross output of nonprofit institutions" TimePeriod="2009" CL_UNIT="PC" UNIT_MULT="0"

DataValue="111.062" NoteRef="13,13.2" />

<Data TableID="13" SeriesCode="DNPSRG" LineNumber="46" LineDescription="Less: Receipts from sales of goods and services by nonprofit institutions" TimePeriod="2009" CL_UNIT="PC"

UNIT_MULT="0" DataValue="114.802" NoteRef="13,13.3" />

<Notes NoteRef="13" NoteText="Table 2.3.4U. Price Indexes for Personal Consumption Expenditures by Major Type of Product and by Major Function - [Index numbers, 2005=100;

quarters and months are seasonally adjusted]" />

<Notes NoteRef="13.2" NoteText="2. Gross output is net of unrelated sales, secondary sales, and sales to business, to government, and to the rest of the world; excludes own-account

investment (construction and software)." />

<Notes NoteRef="13.3" NoteText="3. Excludes unrelated sales, secondary sales, and sales to business, to government, and to the rest of the world; includes membership dues and fees."

<Notes NoteRef="13.4" NoteText="4. Food consists of food and beverages purchased for off-premises consumption; food services, which include purchased meals and beverages, are not

classified as food." />

<Notes NoteRef="13.6" NoteText="6. Market-based PCE is a supplemental measure that is based on household expenditures for which there are observable price measures. It excludes

most imputed transactions (for example, financial services furnished without payment) and the final consumption expenditures of nonprofit institutions serving households." />

All requests for the Underlying Detail 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

Name

Datatype

IsValue

TableID

numeric

SeriesCode

string

LineNumber

numeric

LineDescription

TimePeriod

string

CL_UNIT

string

UNIT_MULT

numeric

DataValue

numeric

Yes

NoteRef5

string

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 Underlying Detail table ID as submitted in the request (an integer).

SeriesCode – A string containing a unique identifier for the line item in the published Underlying Detail table.

5 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.

33 | Page Tuesday, September 30, 2014

LineNumber – The line number of the data item as shown in published print versions of the published

Underlying Detail table.

LineDescription – The “stub” or description of the statistic in the published Underlying Detail table.

TimePeriod – A string containing the time period for the data item in the form YYYY for annual data,

YYYYQn for quarterly data (where n is the quarter digit), and YYYYMnn for monthly data (where nn is 2

digits representing the month – i.e. ‘01’ through ‘12’).

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).

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 Underlying Detail 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/series/timeperiods may be included in the comma-

delimited Noteref string value.

34 | Page Tuesday, September 30, 2014

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

Values

Accepted

“All” value

TableID

Integer

The standard Fixed

Assets table

identifier

Yes

N/A

Year

integer

List of year(s) of

data to retrieve

Yes

“X”

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:

<ParamValue TableID="19" Description="Table 2.2. Chain-Type Quantity Indexes for Net Stock of Private Fixed Assets, Equipment, Structures, and Intellectual Property Products by Type

(A)" />

<ParamValue TableID="66" Description="Table 2.5. Chain-Type Quantity Indexes for Depreciation of Private Fixed Assets, Equipment, Structures, and Intellectual Property Products by

Type (A)" />

<ParamValue TableID="52" Description="Table 2.8. Chain-Type Quantity Indexes for Investment in Private Fixed Assets, Equipment, Structures, and Intellectual Property Products by

Type (A)" />

<ParamValue TableID="106" Description="Table 2.9. Current-Cost Average Age at Yearend of Private Fixed Assets, Equipment, Structures, and Intellectual Property Products by Type

(A)" />

<ParamValue TableID="107" Description="Table 2.10. Historical-Cost Average Age at Yearend of Private Fixed Assets, Equipment, Structures, and Intellectual Property Products by Type

(A)" />

35 | Page Tuesday, September 30, 2014

<ParamValue TableID="27" Description="Table 4.2. Chain-Type Quantity Indexes for Net Stock of Private Nonresidential Fixed Assets by Industry Group and Legal Form of Organization

(A)" />

<ParamValue TableID="78" Description="Table 4.5. Chain-Type Quantity Indexes for Depreciation of Private Nonresidential Fixed Assets by Industry Group and Legal Form of

Organization (A)" />

<ParamValue TableID="60" Description="Table 4.8. Chain-Type Quantity Indexes for Investment in Private Nonresidential Fixed Assets by Industry Group and Legal Form of Organization

(A)" />

<ParamValue TableID="114" Description="Table 4.9. Current-Cost Average Age at Yearend of Private Nonresidential Fixed Assets by Industry Group and Legal Form of Organization (A)"

<ParamValue TableID="115" Description="Table 4.10. Historical-Cost Average Age at Yearend of Private Nonresidential Fixed Assets by Industry Group and Legal Form of Organization

(A)" />

<ParamValue TableID="29" Description="Table 5.2. Chain-Type Quantity Indexes for Net Stock of Residential Fixed Assets by Type of Owner, Legal Form of Organization, and Tenure

Group (A)" />

<ParamValue TableID="89" Description="Table 5.5. Chain-Type Quantity Indexes for Depreciation of Residential Fixed Assets by Type of Owner, Legal Form of Organization, and Tenure

Group (A)" />

<ParamValue TableID="99" Description="Table 5.8. Chain-Type Quantity Indexes for Investment in Residential Fixed Assets by Type of Owner, Legal Form of Organization, and Tenure

Group (A)" />

<ParamValue TableID="116" Description="Table 5.9. Current-Cost Average Age at Yearend of Residential Fixed Assets by Type of Owner, Legal Form of Organization, and Tenure Group

(A)" />

<ParamValue TableID="117" Description="Table 5.10. Historical-Cost Average Age at Yearend of Residential Fixed Assets by Type of Owner, Legal Form of Organization, and Tenure

Group (A)" />

Note that the description of each table also indicates that only annual data is available.

Requesting an invalid TableID returns this error:

36 | Page Tuesday, September 30, 2014

</Error>

Omitting the TableID parameter returns this error:

</AdditionalDetail>

</Error>

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” for the Year parameter, all available

years of data are returned. Note that using the “X” 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:

</Error>

Omitting the Year parameter returns this error:

</AdditionalDetail>

</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:

37 | Page Tuesday, September 30, 2014

38 | Page Tuesday, September 30, 2014

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:

</BEAAPI>

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:

<Data TableID="16" SeriesCode="k1wtotl1es00" LineNumber="1" LineDescription="Fixed assets and consumer durable goods" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9"

DataValue="53,571.6 " NoteRef="16" />

<Data TableID="16" SeriesCode="k1ttotl1es00" LineNumber="2" LineDescription="Fixed assets" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="48,723.6

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1ptotl1es00" LineNumber="3" LineDescription="Private" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="36,215.6 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1ntotl1es00" LineNumber="4" LineDescription="Nonresidential" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="19,903.3

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1ntotl1eq00" LineNumber="5" LineDescription="Equipment" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="5,622.9 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1ntotl1st00" LineNumber="6" LineDescription="Structures" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="11,944.6 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1ntotl1ip00" LineNumber="7" LineDescription="Intellectual property products" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9"

DataValue="2,335.8 " NoteRef="16" />

<Data TableID="16" SeriesCode="k1r53101es00" LineNumber="8" LineDescription="Residential" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="16,312.3

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1gtotl1es00" LineNumber="9" LineDescription="Government" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="12,508.0

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1gtotl1esnr" LineNumber="10" LineDescription="Nonresidential" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="12,160.1

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1gtotl1eq00" LineNumber="11" LineDescription="Equipment" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="980.3 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1gtotl1stnr" LineNumber="12" LineDescription="Structures" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="10,108.6 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1gtotl1ip00" LineNumber="13" LineDescription="Intellectual property products" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9"

DataValue="1,071.2 " NoteRef="16" />

<Data TableID="16" SeriesCode="k1gtotl1sa00" LineNumber="14" LineDescription="Residential" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="347.9 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1ctotl1cd00" LineNumber="15" LineDescription="Consumer durable goods" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9"

DataValue="4,848.0 " NoteRef="16" />

<Data TableID="16" SeriesCode="k1ttotl1es00" LineNumber="16" LineDescription="Private and government fixed assets" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9"

DataValue="48,723.6 " NoteRef="16" />

<Data TableID="16" SeriesCode="k1ytotl1es00" LineNumber="17" LineDescription="Nonresidential" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="32,063.4

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1ytotl1eq00" LineNumber="18" LineDescription="Equipment" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="6,603.2

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1ytotl1st00" LineNumber="19" LineDescription="Structures" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="22,053.1 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1ytotl1ip00" LineNumber="20" LineDescription="Intellectual property products" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9"

DataValue="3,407.0 " NoteRef="16" />

39 | Page Tuesday, September 30, 2014

<Data TableID="16" SeriesCode="k1x53101es00" LineNumber="21" LineDescription="Residential" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="16,660.2

" NoteRef="16" />

<Data TableID="16" SeriesCode="k1gtotl1es00" LineNumber="22" LineDescription="Government fixed assets" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9"

DataValue="12,508.0 " NoteRef="16" />

<Data TableID="16" SeriesCode="k1gfedr1es00" LineNumber="23" LineDescription="Federal" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="3,121.6 "

NoteRef="16" />

<Data TableID="16" SeriesCode="k1gstlc1es00" LineNumber="24" LineDescription="State and local" TimePeriod="2012" CL_UNIT="USD" UNIT_MULT="9" DataValue="9,386.3

" NoteRef="16" />

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

Name

Datatype

IsValue

TableID

numeric

SeriesCode

string

LineNumber

numeric

LineDescription

TimePeriod

string

CL_UNIT

string

UNIT_MULT

numeric

DataValue

numeric

Yes

NoteRef6

string

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.

40 | Page Tuesday, September 30, 2014

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.

41 | Page Tuesday, September 30, 2014

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

Parameter Name Type Description Required

Multiple

Values

Accepted

“All”

value Default

DirectionOfInvestment String

Outward = US direct

investment abroad

Yes No Not

accepted

Inward = Foreign

investment in the US

SeriesID Integer Data Series Identifier No Yes All All

Classification String Results by country

and/or industry

Yes No Not

accepted

Year

String

Time Period

Yes

All

Country String

Geographic Area

Code

No Yes All All

Industry

String

Industry Code

Yes

All

GetFootnotes String

Yes = Include

footnotes

No No Not

accepted No

No = Exclude footnotes

Examples of Direct Investment (DI) Data Requests

U.S. direct investment position in China and Asia for 2011 and 2012

http://www.bea.gov/api/data/?&SeriesId=30&UserID= Your-36Character-

Key&method=GetData&DataSetName=MNE&Year=2012,2011&Country=650,699&DirectionOfInvestment=Outw

ard&Classification=Country&ResultFormat=xml

Foreign direct investment position in the U.S. from Germany in the manufacturing industry for 2011 and 2012

42 | Page Tuesday, September 30, 2014

http://www.bea.gov/api/data/?&SeriesId=22,23,24,25,26,27&UserID= Your-36Character-

Key&method=GetData&DataSetName=MNE&Year=2013,2012,2011,2010&Country=308&Industry=3000&Directi

onOfInvestment=Inward&Classification=CountryByIndustry&ResultFormat=xml

Type 2: Activities of Multinational Enterprises (AMNE) Data Request

Parameter Name Type Description Required

Multiple

Values

Accepted

“All”

value Default

DirectionOfInvestment String Outward, Inward,

State, Parent Yes No Not

accepted

OwnershipLevel Binary

0 = Majority-Owned

Affiliates

Yes No Not

accepted

1 = All Affiliates

NonBankAffiliatesOnly Binary

0 = Both Bank and

NonBank Affiliates

Yes No Not

accepted

1 = Nonbank

Affiliates

SeriesID Integer

Data Series

Identifier

No Yes All All

Classification String Results by country

and/or industry Yes No Not

accepted

Year

String

Time Period

Yes

All

Country String

Geographic Area

Code

No Yes All All

Industry

String

Industry Code

Yes

All

State String

Two-digit State FIPS

Code

No No All All

GetFootnotes String

Yes = Include

footnotes

No No Not

accepted No

No = Exclude

footnotes

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

http://www.bea.gov/api/data/?&UserID= Your-36Character-

Key&method=GetData&DataSetName=MNE&Year=2012,2011&Country=202&Industry=all&DirectionOfInvestm

ent=Outward&Classification=CountryByIndustry&SeriesId=5,4&NonBankAffiliatesOnly=0&OwnershipLevel=0&R

esultFormat=xml

Total employment in U.S. affiliates of foreign-owned enterprises, all countries, 2011, include footnotes

43 | Page Tuesday, September 30, 2014

http://www.bea.gov/api/data/?&UserID= Your-36Character-

Key&method=GetData&DataSetName=MNE&Year=2011&Country=all&Industry=0000&DirectionOfInvestment=I

nward&Classification=Country&SeriesId=8&OwnershipLevel=0&NonbankAffiliatesOnly=0&GetFootnotes=Yes&R

esultFormat=xml

API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for

Each Parameter

[Details of each are described in the section below.]

Parameter Name

Parameter Value List

DirectionOfInvestment

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

Y&method=GetParameterValues&DataSetName=MNE&ParameterName=Dir

ectionOfInvestment&ResultFormat=xml

OwnershipLevel

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=Ow

nershipLevel&ResultFormat=xml

NonBankAffiliatesOnly

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=Non

bankAffiliatesOnly&ResultFormat=xml

SeriesID

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetParameterValues&DataSetName=MNE&ParameterName=

SeriesID&ResultFormat=xml

Classification

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=Clas

sification&ResultFormat=xml

Year

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=Yea

r&ResultFormat=xml

Country

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=cou

ntry&ResultFormat=xml

Industry

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=Ind

ustry&ResultFormat=xml

State

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=stat

e&ResultFormat=xml

GetFootnotes

http://www.bea.gov/api/data/?&UserID= Your-36Character-Key

&method=GetParameterValues&DataSetName=MNE&ParameterName=Get

Footnotes&ResultFormat=xml

44 | Page Tuesday, September 30, 2014

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)

1. ‘Country’ – Returns a total value by country only

2. ‘Industry’ – Returns a total value by industry only

45 | Page Tuesday, September 30, 2014

3. ‘CountryByIndustry’ – Returns values for a country broken out by industry (where available)

4. ‘IndustryByCountry’ – Returns values for an industry broken out by country (where available)

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 2007 and earlier years), property, plant, and

equipment.

Refer to the GETPARAMETERVALUES API call above for the list of the two-digit Federal Information

Processing Standards (FIPS) codes, or the FIPS codes found at this link:

http://www.epa.gov/envirofw/html/codes/state.html. 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

46 | Page Tuesday, September 30, 2014

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

List of year(s) of data to

retrieve (ALL for All)

Yes Yes ALL N/A

Industry String

List of industries to

retrieve (ALL for All)

Yes Yes ALL N/A

Examples of GDP by Industry (GDPbyIndustry) Data Requests

Annual Value Added by Industry data for all industries for years 2011 and 2012:

http://www.bea.gov/api/data/?&UserID=%20Your-36Character-

Key&method=GetData&DataSetName=GDPbyIndustry&Year=2012,2011&Industry=ALL&tableID=1&Frequency=

A&ResultFormat=xml

All annual and quarterly data in all tables for the Agriculture industry in 2010.

http://www.bea.gov/api/data/?&UserID=%20Your-36Character-

Key&method=GetData&DataSetName=GDPbyIndustry&Year=2010&Industry=11&tableID=ALL&Frequency=A,Q

&ResultFormat=xml

API Call [GETPARAMETERVALUES] to Obtain a List of Available Values & Descriptions for

Each Parameter

[Details of each are described in the section below.]

Parameter Name

Parameter Value List

47 | Page Tuesday, September 30, 2014

TableID

http://www.bea.gov/api/data/?&UserID=%20Your-36Character-

Key%20Y&method=GetParameterValues&DataSetName=GDPbyIndustry&Param

eterName=TableID&ResultFormat=xml

Frequency

http://www.bea.gov/api/data/?&UserID=%20Your-36Character-

Key%20Y&method=GetParameterValues&DataSetName=GDPbyIndustry&Param

eterName=Frequency&ResultFormat=xml

Year

http://www.bea.gov/api/data/?&UserID=%20Your-36Character-

Key%20Y&method=GetParameterValues&DataSetName=GDPbyIndustry&Param

eterName=Year&ResultFormat=xml

Industry

http://www.bea.gov/api/data/?&UserID=%20Your-36Character-

Key%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 =

• 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:

</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.

48 | Page Tuesday, September 30, 2014

• 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:

</Error>

<ErrorDetail Description="Annual data begin in 1997 and quarterly data begins in 2005.

Invalid year: 1996" />

</Error>

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:

</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:

</Error>

49 | Page Tuesday, September 30, 2014

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 Description Required

Multiple

Values

Accepted

“All”

value Default

Indicator String

The indicator code

for the type of

transaction

requested

No Yes All All

AreaOrCountry String

The area or country

requested

No Yes All AllCountries

Frequency String

A - Annual, QSA -

Quarterly seasonally

adjusted, QNSA -

Quarterly not

seasonally adjusted

No Yes All All

Year String Year requested No Yes All

All

Examples of ITA (International Transactions) Data Requests

Balance on goods with China for 2011 and 2012

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetData&DataSetName=ITA&Indicator=BalGds&AreaOrCountry=China&Frequency=A&Year=2011

,2012&ResultFormat=xml

Net U.S. acquisition of portfolio investment assets (quarterly not seasonally adjusted) for 2013

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetData&DataSetName=ITA&Indicator=PfInvAssets&AreaOrCountry=AllCountries&Frequency=Q

NSA&Year=2013&ResultFormat=xml

50 | Page Tuesday, September 30, 2014

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

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetParameterValues&DataSetName=ITA&ParameterName=Indica

tor&ResultFormat=xml

AreaOrCountry

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetParameterValues&DataSetName=ITA&ParameterName=AreaO

rCountry&ResultFormat=xml

Frequency

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetParameterValues&DataSetName=ITA&ParameterName=Frequ

ency&ResultFormat=xml

Year

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&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 http://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

http://www.bea.gov/international/bp_web/geographic_area_definitions.cfm

Frequency Parameter – (optional, multiple values allowed)

51 | Page Tuesday, September 30, 2014

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 Description

Indicator 1 String No

The Indicator parameter value of the data

item.

AreaOrCountry 2 String No

The AreaOrCountry parameter value of the

data item.

Frequency 3 String No

The Frequency parameter value of the data

item.

Year 4 String No The Year parameter value of the data item.

TimeSeriesId 5 String No

A unique identifier for the time series of the

data item.

TimeSeriesDescription 6 String No

A description of the transactions measured in

the data item.

TimePeriod 7 String No

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)

CL_UNIT 8 String No

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.

UNIT_MULT 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 × 10

DataValue 10 Numeric No

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.

52 | Page Tuesday, September 30, 2014

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

“All”

value Default

TypeOfInvestment String Type of investment No Yes All All

Component String

Component of

changes in position No Yes All All

Frequency String

A - Annual, QNSA -

Quarterly not

seasonally adjusted

No Yes All All

Year

String

Year requested

Yes

All

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

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetData&DataSetName=IIP&TypeOfInvestment=FinAssetsExclFinDeriv&Component=ChgPosPrice

&Frequency=A&Year=ALL&ResultFormat=xml

U.S. liabilities to foreign official agencies (quarterly not seasonally adjusted) for 2013

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetData&DataSetName=IIP&TypeOfInvestment=FinLiabsFoa&Component=Pos&Frequency=QNSA

&Year=2013&ResultFormat=xml

53 | Page Tuesday, September 30, 2014

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

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetParameterValues&DataSetName=IIP&ParameterName=TypeOf

Investment&ResultFormat=xml

Component

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetParameterValues&DataSetName=IIP&ParameterName=Compo

nent&ResultFormat=xml

Frequency

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&method=GetParameterValues&DataSetName=IIP&ParameterName=Freque

ncy&ResultFormat=xml

Year

http://www.bea.gov/api/data/?&UserID=Your-36Character-

Key&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

http://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 financial-

account 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.

54 | Page Tuesday, September 30, 2014

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 Description

TypeOfInvestment 1 String No

The TypeOfInvestment parameter value of

the data item.

Component 2 String No

The Component parameter value of the data

item.

Frequency 3 String No

The Frequency parameter value of the data

item.

Year 4 String No The Year parameter value of the data item.

TimeSeriesId 5 String No

A unique identifier for the time series of the

data item.

TimeSeriesDescription 6 String No

A description of the transactions measured in

the data item.

TimePeriod 7 String No

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)

CL_UNIT 8 String No

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.

UNIT_MULT 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 × 10

DataValue 10 Numeric No

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.

Bea Web Service Api User Guide

Navigation menu

Versions of this User Manual:

Views

Navigation