Get Detail on Structure Change Events
GET {{baseUrl}}/history?filters=STATE:"VIRGINIA"&search=non aliquip&fields=INSTNAME,CERT,PCITY,PSTALP,PZIP5&sort_by=PROCDATE&sort_order=DESC&limit=10&offset=0&agg_by=non aliquip&agg_term_fields=non aliquip&agg_limit=10&format=json&download=true&filename=data_file
Returns details on structure change events
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filters | string | The filter criteria that refines the records returned. | |
| Examples: |
- Filter by State
STATE:"VIRGINIA" - Filter all but a specified value
!(STATE:"VIRGINIA") - Filter by Date Range
PROCDATE:[2020-01-01 TO 2020-02-01]| |search| string | | Flexible text search against institution records 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 - Search by State
STATE: VA| |fields| string | | Comma delimited list of fields of failed financial institutions 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 | |agg_term_fields| string | | The field(s) for which aggregations will be counted for each unique term. | |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":-59716044,"parameters":{},"index":{"name":"quis Ut laborum","createTimestamp":"2001-09-28T04:42:41.047Z"}},"data":[{"value":"reference history_properties.yaml not found in the OpenAPI spec"},{"value":"reference history_properties.yaml not found in the OpenAPI spec"}],"totals":{"count":-48068826}}