FIADB-API & EVALIDator User Documentation

import requests
import pandas as pd


# this function will accept a FIADB-API fullreport URL and return dataframes for the estimates as well as subtotals, and totals where available.
def fiadb_api_GET(url):
    # make request
    resp = requests.get(url)
    # parse response to json
    data = resp.json()

    # create output dictionary and populate it with estimate data frames
    outDict = {}
    # append estimates
    outDict['estimates'] = pd.DataFrame(data['estimates'])

    # append subtotals and totals if present
    if 'subtotals' in data.keys():
        subT = {}
        for i in data['subtotals'].keys():
            subT[i] = pd.DataFrame(data['subtotals'][i])
        outDict['subtotals'] = subT
        outDict['totals'] = pd.DataFrame(data['totals'])

    # append metadata
    outDict['metadata'] = data['metadata']
    return outDict


# example of usage
url = "https://apps.fs.usda.gov/fiadbstatic-api/fullreport?rselected=Land%20Use%20-%20Major&cselected=Land%20use&snum=79&wc=102020&outputFormat=NJSON"
getData = fiadb_api_GET(url=url)

# estimate data frame
getData['estimates']

# list of subtotal data frames
getData['subtotals']

# totals data frame
getData['totals']

# list all estimate metadata elements
getData['metadata'].keys()

# access metadata elements
getData['metadata']

import requests
import pandas as pd


# this function will accept a FIADB-API fullreport URL and return dataframes for the estimates as well as subtotals, and totals where available.
def fiadb_api_POST(parameterDictionary):
    # make request
    resp = requests.post(r"https://apps.fs.usda.gov/fiadbstatic-api/fullreport",data=parameterDictionary)
    # parse response to json
    data = resp.json()

    # create output dictionary and populate it with estimate data frames
    outDict = {}
    # append estimates
    outDict['estimates'] = pd.DataFrame(data['estimates'])

    # append subtotals and totals if present
    if 'subtotals' in data.keys():
        subT = {}
        for i in data['subtotals'].keys():
            subT[i] = pd.DataFrame(data['subtotals'][i])
        outDict['subtotals'] = subT
        outDict['totals'] = pd.DataFrame(data['totals'])

    # append metadata
    outDict['metadata'] = data['metadata']
    return outDict


# example of usage
requestParameters = {snum:2, wc:102020, rselected:'County code and name', cselected:'Land Use - Major', outputFormat:'NJSON')
getData = fiadb_api_POST(parameterDictionary=requestParameters)

# estimate data frame
getData['estimates']

# list of subtotal data frames
getData['subtotals']

# totals data frame
getData['totals']

# list all estimate metadata elements
getData['metadata'].keys()

# access metadata elements
getData['metadata']['sql']

library(httr)
library(jsonlite)
library(dplyr)
library(rlist)

# this function will accept a FIADB-API fullreport URL and return dataframes for the estimates as well as subtotals, and totals where available.
fiadb_api_GET = function(url){
  # make request
  resp <- GET(url=url)
  # parse response from JSON to R list
  respObj <- content(resp, "parsed", encoding = "ISO-8859-1")
  # create empty output list
  outputList = list()
  # add estimates data frame to output list
  outputList[['estimates']] <- as.data.frame(do.call(rbind,respObj$estimates))

  # if estimate includes totals and subtotals, add those data frames to output list
  if ('subtotals' %in% names(respObj)){
    subtotals <- list()
    # one subtotal data frame for each grouping variable
    for (i in names(respObj$subtotals)){
      subtotals[[i]] <- as.data.frame(do.call(rbind,respObj$subtotals[[i]]))
    }
    outputList[['subtotals']] <- subtotals

    # totals data frame
    outputList[['totals']] <- as.data.frame(do.call(rbind,respObj$totals))
  }

  # add estiamte metadata
  outputList[['metadata']] <- respObj$metadata

  return(outputList)
}

# example of usage
url <- "https://apps.fs.usda.gov/fiadbstatic-api/fullreport?rselected=Land%20Use%20-%20Major&cselected=Land%20use&snum=79&wc=102020&outputFormat=NJSON"
getData <- fiadb_api_GET(url=url)

# estimate data frame
getData[['estimates']]

# list of subtotal data frames
getData[['subtotals']]

# totals data frame
getData[['totals']]

# list of estimate metadata elements
getData[['metadata']]

# access metadata elements
postData[['metadata']][['sql']]

library(httr)
library(jsonlite)
library(dplyr)
library(rlist)

# this function will accept a FIADB-API fullreport URL and return dataframes for
fiadb_api_POST <- function(argList){
  # make request
  resp <- POST(url="https://apps.fs.usda.gov/fiadbstatic-api/fullreport", body=argList, encode="form")
  # parse response from JSON to R list
  respObj <- content(resp, "parsed", encoding = "ISO-8859-1")
  # create empty output list
  outputList <- list()
  # add estimates data frame to output list
  outputList[['estimates']] <- as.data.frame(do.call(rbind,respObj$estimates))

  # if estimate includes totals and subtotals, add those data frames to output list
  if ('subtotals' %in% names(respObj)){
    subtotals <- list()
    # one subtotal data frame for each grouping variable
    for (i in names(respObj$subtotals)){
      subtotals[[i]] <- as.data.frame(do.call(rbind,respObj$subtotals[[i]]))
    }
    outputList[['subtotals']] <- subtotals

    # totals data frame
    outputList[['totals']] <- as.data.frame(do.call(rbind,respObj$totals))
  }

  # add estiamte metadata
  outputList[['metadata']] <- respObj$metadata

  return(outputList)
}

# example of usage
# create a list of parameter values
argList = list(snum=2,wc=102020,rselected='County code and name',cselected='Land Use - Major',outputFormat='NJSON')
# submit list to POST request function
postData = fiadb_api_POST(argList)

# estimate data frame
postData[['estimates']]

# list of subtotal data frames
postData[['subtotals']]

# totals data frame
postData[['totals']]

# list of estimate metadata elements
postData[['metadata']]
names(postData[['metadata']])