{
  "opencollection": "1.0.0",
  "info": {
    "name": "FDIC Bank Data API (Beta) Demographics Structure API",
    "version": "0.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Structure",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Financial Institutions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/banks/institutions",
            "params": [
              {
                "name": "api_key",
                "value": "",
                "type": "query",
                "description": "Api key used for api.fdic.gov"
              },
              {
                "name": "filters",
                "value": "STALP:IA AND ACTIVE:1",
                "type": "query",
                "description": "The filter for the bank search. All values must be entered in UPPERCASE.\nExamples:\n* Filter by State name  \n`STNAME:\"West Virginia\"`    \n* Filter for any one of multiple State names  \n`STNAME:(\"West Virginia\",\"Delaware\")`\n* Filter all but a specified value  \n`!(STNAME:\"Virginia\")`  \n* Filter by last updated within an inclusive date range  \n`DATEUPDT:[\"2010-01-01\" TO \"2010-12-31\"]`\n* Filter for deposits over 50,000,000 (50000 thousands of dollars)  \n`DEP:[50000 TO *]`\n"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Flexible text search against institution records - currently only supporting name search. \nSearch supports text search and fuzzy matching, as opposed to filters that are exact matches. All values must be entered in UPPERCASE.\nExamples:\n* Search by name\n`NAME: Island`\n* Search by name (fuzzy match)\n`NAME: Iland`\n"
              },
              {
                "name": "fields",
                "value": "ZIP,OFFDOM,CITY,COUNTY,STNAME,STALP,NAME,ACTIVE,CERT,CBSA,ASSET,NETINC,DEP,DEPDOM,ROE,ROA,DATEUPDT,OFFICES",
                "type": "query",
                "description": "Comma delimited list of fields to search. All values must be entered in UPPERCASE."
              },
              {
                "name": "sort_by",
                "value": "OFFICES",
                "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": "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 a list of financial institutions."
        },
        {
          "info": {
            "name": "Get Institution Locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/banks/locations",
            "params": [
              {
                "name": "api_key",
                "value": "",
                "type": "query",
                "description": "Api key used for api.fdic.gov"
              },
              {
                "name": "filters",
                "value": "",
                "type": "query",
                "description": "The filter for the location search. All values must be entered in UPPERCASE."
              },
              {
                "name": "fields",
                "value": "NAME,UNINUM,SERVTYPE,RUNDATE,CITY,STNAME,ZIP,COUNTY",
                "type": "query",
                "description": "Comma delimited list of fields to return. All values must be entered in UPPERCASE."
              },
              {
                "name": "sort_by",
                "value": "NAME",
                "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": "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 locations/branches of financial institutions."
        }
      ]
    }
  ],
  "bundled": true
}