beaquery 0.0.17

No project description provided

BEAquery

---

Table of Contents

BEA query is a set of commands to investigate, retrieve, or view datasets provided by BEA.

beaillustrated collects information about all of the BEA datasets, their parameters, and parameter values. It then displays this information in your browser

The remaining commands retrieve and either store data in CSV files or display the data along with interactive plots in your browser.

beaqueryq can be used to do all that the commands above do.

• Installation
• License

Installation

```console
pip install beaquery
```

## License

`beaquery` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

##
## beaillustrated
##
usage: beaillustrated [-h] [--format {json,XML}] [--directory DIRECTORY]

display BEA data model

options:
-h, --help show this help message and exit
--format {json,XML} requested BEA result format(json)
--directory DIRECTORY
where to store the generated html


##
## beafixedassets
##
usage: beafixedassets [-h] --tn TN --yr YR [--format {json,XML}]
[--csvfn CSVFN] [--splitkey SPLITKEY] [--xkey XKEY]
[--ykey YKEY] [--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA FixedAssets data

options:
-h, --help show this help message and exit
--tn TN FixedAssets table name
--yr YR year YYYY or X for all years
--format {json,XML} result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(LineDescription) to use to split the
plots
--xkey XKEY table column name(TimePeriod) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(METRIC_NAME) to use to label the data
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beagdpbyind
##
usage: beagdpbyind [-h] --tid TID --indstry INDSTRY --freq FREQ --yr YR
[--format {json,XML}] [--csvfn CSVFN]
[--splitkey SPLITKEY] [--xkey XKEY] [--ykey YKEY]
[--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA GDPbyIndustry data

options:
-h, --help show this help message and exit
--tid TID table id
--indstry INDSTRY industry
--freq FREQ frequency M, Q, A or comma separated list
--yr YR year YYYY or ALL
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(IndustrYDescription) to use to split
the plots
--xkey XKEY table column name(Year) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY y key units(Billions?) to use to label the plotdata
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beaiip
##
usage: beaiip [-h] --toi TOI --comp COMP --freq FREQ --yr YR
[--format {json,XML}] [--csvfn CSVFN] [--splitkey SPLITKEY]
[--xkey XKEY] [--ykey YKEY] [--unitskey UNITSKEY]
[--htmlfn HTMLFN]

get BEA IIP data

options:
-h, --help show this help message and exit
--toi TOI type of investment
--comp COMP composition
--freq FREQ frequency M, Q, A or comma separated list
--yr YR year YYYY or ALL
--format {json,XML} result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(Component) to use to split the plots
--xkey XKEY table column name(TimePeriod) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(CL_UNIT) to use to label the data
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beainputoutput
##
usage: beainputoutput [-h] --tid TID --yr YR [--format {json,XML}]
[--csvfn CSVFN] [--splitkey SPLITKEY] [--xkey XKEY]
[--ykey YKEY] [--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA InputOutput data

options:
-h, --help show this help message and exit
--tid TID table id
--yr YR year YYYY or ALL
--format {json,XML} request result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(ColDescr) to use to split the plots
--xkey XKEY table column name(Year) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(ColType) to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beaissta
##
usage: beaissta [-h] --chan CHAN --dest DEST --indstry INDSTRY --aoc AOC
--yr YR [--format {json,XML}] [--csvfn CSVFN]
[--splitkey SPLITKEY] [--xkey XKEY] [--ykey YKEY]
[--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA IntlServSTA data

options:
-h, --help show this help message and exit
--chan CHAN channel
--dest DEST destination
--indstry INDSTRY industry
--aoc AOC area or country
--yr YR year YYYY or ALL
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(TimeSeriesDescription) to use to
split the plots
--xkey XKEY table column name(Year) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name({'option_strings': ['--unitskey'],
'dest': 'unitskey', 'nargs': None, 'const': None,
'default': 'CL_UNIT', 'type': None, 'choices': None,
'required': False, 'help': 'table column name(%s) to y
label the plot', 'metavar': None, 'container':
,
'prog': 'beaissta'}) to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beaistrade
##
usage: beaistrade [-h] --tos TOS [--tdir TDIR] [--affl AFFL] [--aoc AOC]
--yr YR [--format {json,XML}] [--csvfn CSVFN]
[--splitkey SPLITKEY] [--xkey XKEY] [--ykey YKEY]
[--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA IntlServTrade data

options:
-h, --help show this help message and exit
--tos TOS type of service
--tdir TDIR trade direction
--affl AFFL affiliation
--aoc AOC area or country
--yr YR year YYYY or ALL
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(TimeSeriesDescription) to use to
split the plots
--xkey XKEY table column name(Year) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(CL_UNIT) to use to label the data
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beaita
##
usage: beaita [-h] --indctr INDCTR --aoc AOC --freq FREQ --yr YR
[--format {json,XML}] [--csvfn CSVFN] [--splitkey SPLITKEY]
[--xkey XKEY] [--ykey YKEY] [--unitskey UNITSKEY]
[--htmlfn HTMLFN]

get BEA ITA data

options:
-h, --help show this help message and exit
--indctr INDCTR ITA indicator
--aoc AOC ITA area or country
--freq FREQ frequency M, Q, A or comma separated list
--yr YR year YYYY or ALL
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(TimeSeriesDescription) to use to
split the plots
--xkey XKEY table column name(Year) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name({'option_strings': ['--unitskey'],
'dest': 'unitskey', 'nargs': None, 'const': None,
'default': 'CL_UNIT', 'type': None, 'choices': None,
'required': False, 'help': 'table column name(%s) to y
label the plot', 'metavar': None, 'container':
,
'prog': 'beaita'}) to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beamne
##
usage: beamne [-h] [--sid SID] --doi DOI --cls CLS [--cnt CNT]
[--indstry INDSTRY] --yr YR [--format {json,XML}]
[--csvfn CSVFN] [--splitkey SPLITKEY] [--xkey XKEY]
[--ykey YKEY] [--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA MNE data

options:
-h, --help show this help message and exit
--sid SID MNE series id
--doi DOI direction of investment
--cls CLS classification
--cnt CNT country
--indstry INDSTRY industry
--yr YR year YYYY or all
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(SeriesName) to use to split the plots
--xkey XKEY table column name(Year) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(TableScale) to to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beanipa
##
usage: beanipa [-h] --tn TN [--showm SHOWM] --freq FREQ --yr YR
[--format {json,XML}] [--csvfn CSVFN] [--splitkey SPLITKEY]
[--xkey XKEY] [--ykey YKEY] [--unitskey UNITSKEY]
[--htmlfn HTMLFN]

get BEA NIPA data

options:
-h, --help show this help message and exit
--tn TN NIPA table name
--showm SHOWM NIPA show millions
--freq FREQ frequency M, Q, A or comma separated list
--yr YR year YYYY or X for all
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(LineDescription) to use to split the
plots
--xkey XKEY table column name(TimePeriod) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(METRIC_NAME) to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beaniud
##
usage: beaniud [-h] --tn TN --freq FREQ --yr YR [--format {json,XML}]
[--csvfn CSVFN] [--splitkey SPLITKEY] [--xkey XKEY]
[--ykey YKEY] [--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA NIUnderlyingDetail data

options:
-h, --help show this help message and exit
--tn TN NIUnderlyingDetail table name
--freq FREQ frequency M, Q, A or comma separated list
--yr YR year YYYY or X or all
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name({'option_strings': ['--splitkey'],
'dest': 'splitkey', 'nargs': None, 'const': None,
'default': 'LineDescription', 'type': None, 'choices':
None, 'required': False, 'help': 'table column name(%s)
to use to split the plots', 'metavar': None,
'container': 0x1038858e0>, 'prog': 'beaniud'}) to use to split
the plots
--xkey XKEY table column name(TimePeriod) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(METRIC_NAME) to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## bearegional
##
usage: bearegional [-h] --tn TN --fips FIPS --lncd LNCD --yr YR
[--format {json,XML}] [--csvfn CSVFN]
[--splitkey SPLITKEY] [--xkey XKEY] [--ykey YKEY]
[--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA Regional data

options:
-h, --help show this help message and exit
--tn TN table name
--fips FIPS geo fips
--lncd LNCD line code
--yr YR year YYYY or ALL
--format {json,XML} query result format(json)
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(GeoName) to use to split the plots
--xkey XKEY table column name(TimePeriod) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY table column name(CL_UNIT) to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beaugdpbyind
##
usage: beaugdpbyind [-h] --tid TID --indstry INDSTRY --freq FREQ --yr YR
[--format {json,XML}] [--csvfn CSVFN]
[--splitkey SPLITKEY] [--xkey XKEY] [--ykey YKEY]
[--unitskey UNITSKEY] [--htmlfn HTMLFN]

get BEA UnderlyingGDPbyIndustry data

options:
-h, --help show this help message and exit
--tid TID table id
--indstry INDSTRY industry
--freq FREQ frequency M, Q, A or comma separated list
--yr YR year YYYY or ALL
--format {json,XML} result format
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name(IndustrYDescription) to split the
plots
--xkey XKEY table column name(Year) to use to plot the data
--ykey YKEY table column name(DataValue) to use to plot the data
--unitskey UNITSKEY name(Billions?) to y label the plot
--htmlfn HTMLFN name of file to store dataset HTML result


##
## beaqueryq
##
usage: beaqueryq [-h]
[--dataset {NIPA,NIUnderlyingDetail,MNE,FixedAssets,ITA,IIP,InputOutput,IntlServTrade,IntlServSTA,GDPbyIndustry,Regional,UnderlyingGDPbyIndustry,APIDatasetMetaData}]
[--tn TN] [--tid TID] [--sid SID] [--showm SHOWM]
[--freq FREQ] [--yr YR]
[--doi {inward,outward,parent,state}] [--cls CLS]
[--indstry INDSTRY] [--cnt CNT] [--indctr INDCTR]
[--aoc AOC] [--toi TOI] [--comp COMP] [--tos TOS]
[--tdir TDIR] [--affl AFFL] [--chan CHAN] [--dest DEST]
[--fips FIPS] [--lncd LNCD] [--csvfn CSVFN]
[--splitkey SPLITKEY] [--xkey XKEY] [--ykey YKEY]
[--unitskey UNITSKEY] [--htmlfn HTMLFN]
[--format {json,XML}] [--hierarchy] [--tableregister]

get BEA data

options:
-h, --help show this help message and exit
--dataset {NIPA,NIUnderlyingDetail,MNE,FixedAssets,ITA,IIP,InputOutput,IntlServTrade,IntlServSTA,GDPbyIndustry,Regional,UnderlyingGDPbyIndustry,APIDatasetMetaData}
dataset name
--tn TN NIPA NIUnderlyingDetail FixedAssets Regional table
name
--tid TID InputOutput GDPbyIndustry UnderlyingGDPbyIndustry
table id
--sid SID MNE series id
--showm SHOWM NIPA show millions
--freq FREQ frequency M, Q, A or comma separated list
--yr YR year YYYY X or all
--doi {inward,outward,parent,state}
MNE direction of investment
--cls CLS MNE classification
--indstry INDSTRY MNE IntlServSTA GDPbyIndustry UnderlyingGDPbyIndustry
Industry
--cnt CNT MNE country
--indctr INDCTR ITA indicator
--aoc AOC ITA IntlServTrade IntlServSTA area or country
--toi TOI IIP type of investment
--comp COMP IIP component
--tos TOS IntlServTrade type of service
--tdir TDIR IntlServTrade trade direction
--affl AFFL IntlServTrade affiliation
--chan CHAN IntlServSTA channel
--dest DEST IntlServSTA destination
--fips FIPS Regional geo FIPS
--lncd LNCD Regional line code
--csvfn CSVFN name of file to store dataset CSV result
--splitkey SPLITKEY table column name to use to split the table
--xkey XKEY table column name to use to plot the data
--ykey YKEY table column name to use to plot the data
--unitskey UNITSKEY table column name to use to label the data
--htmlfn HTMLFN name of file to store dataset HTML result
--format {json,XML} query result format
--hierarchy BEA data model
--tableregister get NIPA table register