{
  "opencollection": "1.0.0",
  "info": {
    "name": "FDIC Bank Data API (Beta) Demographics Failures API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Failures",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get detail on historical bank failures from 1934 to present.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/banks/failures",
            "params": [
              {
                "name": "api_key",
                "value": "",
                "type": "query",
                "description": "Api key used for api.fdic.gov"
              },
              {
                "name": "filters",
                "value": "FAILYR:[\"2014\" TO \"2015\"]",
                "type": "query",
                "description": "The filter criteria that refines the records returned. \nExamples: All values must be entered in UPPERCASE.\n* Filter by Location              \n`CITYST:\"MEMPHIS, TN\"`  \n* Filter all but a specified value  \n`!(CITY:\"PITTSBURGH\")`  \n* Filter by institution fail year range  \n`FAILYR:[\"2015\" TO \"2016\"]`\n"
              },
              {
                "name": "fields",
                "value": "NAME,CERT,FIN,CITYST,FAILDATE,SAVR,RESTYPE,RESTYPE1,QBFDEP,QBFASSET,COST",
                "type": "query",
                "description": "Comma delimited list of fields of failed financial institutions to return. All values must be entered in UPPERCASE."
              },
              {
                "name": "sort_by",
                "value": "FAILDATE",
                "type": "query",
                "description": "Field name by which to sort returned data. All values must be entered in UPPERCASE."
              },
              {
                "name": "sort_order",
                "value": "DESC",
                "type": "query",
                "description": "Indicator if ascending (ASC) or descending (DESC). All values must be entered in UPPERCASE."
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "The number of records to return. Default is 10 and maximum is 10,000."
              },
              {
                "name": "offset",
                "value": "0",
                "type": "query",
                "description": "The offset of page to return."
              },
              {
                "name": "total_fields",
                "value": "QBFDEP,QBFASSET,COST",
                "type": "query",
                "description": "Fields to sum up (in a totals response object). Only numeric columns are valid. All values must be entered in UPPERCASE."
              },
              {
                "name": "subtotal_by",
                "value": "RESTYPE",
                "type": "query",
                "description": "The field by which data will be subtotaled (in totals response object). Only categorical values should be used. All values must be entered in UPPERCASE."
              },
              {
                "name": "agg_by",
                "value": "FAILYR",
                "type": "query",
                "description": "The field by which data will be aggregated. All values must be entered in UPPERCASE."
              },
              {
                "name": "agg_term_fields",
                "value": "RESTYPE",
                "type": "query",
                "description": "The field(s) for which aggregations will be counted for each unique term. All values must be entered in UPPERCASE."
              },
              {
                "name": "agg_sum_fields",
                "value": "QBFASSET,QBFDEP,COST",
                "type": "query",
                "description": "The field(s) for which aggregations will be summed or aggregated. All values must be entered in UPPERCASE."
              },
              {
                "name": "agg_limit",
                "value": "10",
                "type": "query",
                "description": "The limit on how many aggregated results will be displayed"
              },
              {
                "name": "format",
                "value": "json",
                "type": "query",
                "description": "The format of the data to return."
              },
              {
                "name": "download",
                "value": "false",
                "type": "query",
                "description": "Whether the data should be downloaded as a file."
              },
              {
                "name": "filename",
                "value": "data_file",
                "type": "query",
                "description": "The filename to use when downloading data."
              }
            ]
          },
          "docs": "Returns details on failed financial institutions."
        }
      ]
    }
  ],
  "bundled": true
}