Get Historical Aggregate Data by Year

GET {{baseUrl}}/summary?filters=STNAME:"Alabama"&fields=STNAME,YEAR,INTINC,EINTEXP,NIM,NONII,NONIX,ELNATR,ITAXR,IGLSEC,ITAX,EXTRA,NETINC&sort_by=YEAR&sort_order=DESC&limit=10&offset=0&agg_by=non aliquip&agg_term_fields=non aliquip&agg_sum_fields=non aliquip&agg_limit=5553&format=json&download=true&filename=data_file

Returns aggregate financial and structure data, subtotaled by year, regarding finanical institutions.

Request Params

KeyDatatypeRequiredDescription
filtersstringThe filter criteria that refines the records included in the calculated result.
example: >-
STNAME:"Alabama" AND YEAR:2005
Examples:
  • Filter by Community Banks (CB) vs. Savings Institutions (SI)
    CB_SI:CB
  • Filter by State name
    STNAME:"Virginia"
  • Filter all but a specified value
    !(STNAME:"Virginia")
  • Filter for any one of multiple State names
    STNAME:("West Virginia","Delaware")
  • Filter data by the year range
    YEAR:["2015" TO "2017"] | | fields | string | | Comma delimited list of fields with aggregated annual financial data to return. | | sort_by | string | | Field name by which to sort returned data | | sort_order | string | | Indicator if ascending (ASC) or descending (DESC) | | limit | number | | The number of records to return. Default is 10 and maximum is 10,000. | | offset | number | | The offset of page to return. | | agg_by | string | | The field(s) by which data will be aggregated. Valid values are 'YEAR' or 'YEAR,STNAME'. | | agg_term_fields | string | | The field(s) for which aggregations will be counted for each unique term. | | agg_sum_fields | string | | The field(s) for which aggregations will be summed or aggregated. | | agg_limit | number | | The limit on how many aggregated results will be displayed | | format | string | | The format of the data to return. | | download | boolean | | Whether the data should be downloaded as a file. | | filename | string | | The filename to use when downloading data. |

RESPONSES

status: OK

{"meta":{"total":-53742652,"parameters":{},"index":{"name":"ad eu esse","createTimestamp":"1942-11-30T09:22:49.861Z"}},"data":[{"value":"reference summary_properties.yaml not found in the OpenAPI spec"},{"value":"reference summary_properties.yaml not found in the OpenAPI spec"}]}