Get Institution Locations

GET {{baseUrl}}/locations?filters=STNAME:Oregon AND SERVTYPE:11&fields=NAME,UNINUM,SERVTYPE,RUNDATE,CITY,STNAME,ZIP,COUNTY&sort_by=NAME&sort_order=DESC&limit=10&offset=0&format=json&download=true&filename=data_file

Returns locations/branches of financial institutions.

Request Params

KeyDatatypeRequiredDescription
filtersstringThe filter for the location search.
fieldsstringComma delimited list of fields to return.
sort_bystringField name by which to sort returned data
sort_orderstringIndicator if ascending (ASC) or descending (DESC)
limitnumberThe number of records to return. Default is 10 and maximum is 10,000.
offsetnumberThe offset of page to return.
formatstringThe format of the data to return.
downloadbooleanWhether the data should be downloaded as a file.
filenamestringThe filename to use when downloading data.

RESPONSES

status: OK

{"meta":{"total":-53662259,"parameters":{},"index":{"name":"aute dolore fugiat","createTimestamp":"1998-06-02T03:04:31.449Z"}},"data":[{"value":"reference location_properties.yaml not found in the OpenAPI spec"},{"value":"reference location_properties.yaml not found in the OpenAPI spec"}]}