UNM BBER

API Documentation

Welcome to BBER API documentation. To provide users with the most upto date data we used REST API endpoints to serve data.

API endpoint

https://api.bber.unm.edu/api/data/rest/bbertable

Code example

https://github.com/UNM-BBER/BBERAPI-sample

Parameters

Parameter	Description	Sample Values
table	Data soure	rp80, dp05
variables	List of variables for endpoint to return	foodmedt, grosstax
stfips	Federal Information Processing Standards Code	00, 35
areatype	Code describing type of geographic area: e.g. county, service delivery area, MSA	00, 01, 04, 21
area	Six digit code assigned to represent a geographic area. Based on Census Bureau geo ID	000001, 0000028
periodtype	Code for type of period day, month, year, annual, quarterly, etc	01, 04
periodyear	Year that the data represent	2020, 2021
period	1-12 for months or 1-4 for quarters, is 00 for annual	1, 2
indcode	The two to six digit industry code	11, 23
adjusted	Seasonally Adjusted 1, non seasonally adjusted 0	0, 1
ownership	The two digit ownership identifier; 00 all ownerships, 50 private only	00, 50
operation	Data manipulation function to apply to data source (see full list)	growthrate
token	token to get authentication to private/paid data subscription	ABCXXXX

Parameter Range

(Only applicable for the periodyear parameter)

The parameters can be passed on a range to get sequential values. Below example let's you get data for 2018, 2019, 2020 and 2021
https://api.bber.unm.edu/api/data/rest/bbertable?table=sp500&periodyear=2018-2021
You can also request multiple sequences at once:
https://api.bber.unm.edu/api/data/rest/bbertable?table=sp500&periodyear=2005-2010,2015-2020

Selective Parameters

The parameters can be passed as comma separated values to get specific values. Below example let's you get data for 2010, 2015, 2020
https://api.bber.unm.edu/api/data/rest/bbertable?table=sp500&periodyear=2010,2015,2020
Comma separation can also be combined to mix selective and range parameters.

Can be used for all available parameters from the list above.

Merging tables

If selective parameters are used for the table parameter, you can merge multiple tables. But there are some things to keep in mind.
When asking for multiple tables at once, the data will be merged based on common columns, such as stfips, areatype, area, periodtype, periodyear, etc., but also on all other variables that might have the same name. Usually you want to only request certain variables from multiple tables, which you can do in combination with the variables parameter. To specify which variable should be requested from which table, use TABLENAME.VARIABLENAME as the normal variable name.
An example

https://api.bber.unm.edu/api/data/rest/bbertable?table=b11005,b11001&variables=b11005.tot_hhoneplusu18_famhh_marriedfam_e,b11001.tot_nonfamhh_hhalone_e

Would request the variable tot_hhoneplusu18_famhh_marriedfam_e from the table b11005 and the variable tot_nonfamhh_hhalone_e from the table b11001 and merge it into one response.
Requesting two variables with the same name from two different tables is not possible because those are already used for merging.

Operations

BBER API supports some Data Manipulation.
growthrate: Based on the time parameters, this operation will calculate growth rate in Year-over-Year, Month-over-month, Quarter-over-Quarter and so on. This data gets added as a new column for each data column as growthRate_variable
https://api.bber.unm.edu/api/data/rest/bbertable?table=sp500&operation=growthrate

marginal: Based on the time parameters, this operation will calculate marginal growth in Year-over-Year, Month-over-month, Quarter-over-Quarter and so on. This data gets added as a new column for each data column as marginal_variable
cumulative: Based on the time parameters, this operation will calculate cumulative values from the beginning of the selected time period. This data gets added as a new column for each data column as cumulative_variable

You can request multiple operations at once:

https://api.bber.unm.edu/api/data/rest/bbertable?table=sp500&operation=growthrate,marginal,cumulative

Output Format

The API output is in JSON format. All api calls will provide 2 objects.
data: A list of the key : value pair for the given data source.
metadata: has 2 sub values.
columns: A list of description of each data attributes
table: Information about the data source


  { 
    metadata: { 
      columns: [...], 
      table: {...} 
    }, 
    data: [...]
  }

API with Map

The parameters and values are same for the Map api. The endpoint changes from bbertable to makemap
https://api.bber.unm.edu/data/rest/makemap
The API output is in GEOJSON format. Extra metadata object is included in the response which is the same as general output format

Convert JSON to CSV

The BBER API output gives you a json that has nested metadata. Traditional parsers may not work to parse these to csv. Paste the link you want to convert to csv: