Get Financial Institutions
GET {{baseUrl}}/institutions?filters=STALP:IA AND ACTIVE:1&search=non aliquip&fields=ZIP,OFFDOM,CITY,COUNTY,STNAME,STALP,NAME,ACTIVE,CERT,CBSA,ASSET,NETINC,DEP,DEPDOM,ROE,ROA,DATEUPDT,OFFICES&sort_by=OFFICES&sort_order=DESC&limit=10&offset=0&format=json&download=true&filename=data_file
Returns a list of financial institutions.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filters | string | The filter for the bank search. | |
Examples: |
- Filter by State name
STNAME:"West Virginia"
- Filter for any one of multiple State names
STNAME:("West Virginia","Delaware")
- Filter all but a specified value
!(STNAME:"Virginia")
- Filter by last updated within an inclusive date range
DATEUPDT:["2010-01-01" TO "2010-12-31"]
- Filter for deposits over 50,000,000 (50000 thousands of dollars)
DEP:[50000 TO *]
| |search
| string | | Flexible text search against institution records - currently only supporting name search. Search supports text search and fuzzy matching, as opposed to filters that are exact matches. Examples: - Search by name
NAME: Island
- Search by name (fuzzy match)
NAME: Iland
| |fields
| string | | Comma delimited list of fields to search. | |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. | |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":-68360367,"parameters":{},"index":{"name":"cillum pariatur","createTimestamp":"1954-11-04T18:03:59.429Z"}},"data":[{"value":"reference institution_properties.yaml not found in the OpenAPI spec"},{"value":"reference institution_properties.yaml not found in the OpenAPI spec"}]}