{"openapi":"3.1.0","info":{"title":"FDIC BankFind Suite API","description":"The FDIC BankFind Suite API provides programmatic access to data about FDIC-insured banks and savings institutions, including institution profiles, branch locations, financial summaries, historical structure events, failures, Summary of Deposits (SOD), and demographic data.\n\nKey capabilities\n- Filter with Elastic query string syntax (AND/OR, negation with !, ranges with []/{}; dates as yyyy-mm-dd).\n- Select fields, sort results, paginate with limit/offset.\n- JSON (default) or CSV output via the format query parameter or Accept header.\n\nPagination\n- Use limit (max 10000) and offset for paging through large result sets. meta.total returns the total number of matching records to support client-side pagination.","version":"1.0"},"servers":[{"url":"https://api.onestop.sh/v1/invoke/one-stop/us-bank-directory-and-financials-fdic"}],"security":[{"oneStopApiKey":[]}],"components":{"securitySchemes":{"oneStopApiKey":{"type":"http","scheme":"bearer"}}},"paths":{"/institutions":{"get":{"operationId":"listInstitutions","summary":"Search FDIC-insured institutions","description":"Returns institution-level data for FDIC-insured banks and savings institutions. Use Elastic query string syntax in filters (e.g., STALP:CA AND ACTIVE:1).","parameters":[{"name":"filters","in":"query","description":"Filter expression using Elastic query string syntax. Examples: NAME:\"First Bank\"; STALP:TX AND ACTIVE:1; DEPDOM:[* TO 10000]; DATEUPDT:[2010-01-01 TO 2010-12-31].","style":"form","explode":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Free-text search across indexed institution fields (e.g., name, city). It is less precise than filters and is best used for broad matching.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of institution fields to include in the response. If omitted, a default field set is returned.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Field to sort by. For stable results when paginating, sort by a unique or near-unique field (e.g., CERT).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_order","in":"query","description":"Sort direction.","style":"form","explode":true,"schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"limit","in":"query","description":"Maximum number of records to return per request. Use with offset for pagination.","style":"form","explode":true,"schema":{"type":"integer","default":25,"maximum":10000,"minimum":1}},{"name":"offset","in":"query","description":"Number of records to skip before returning results (zero-based).","style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"format","in":"query","description":"Response format. If omitted, JSON is returned. You may also set the HTTP Accept header instead.","style":"form","explode":true,"schema":{"type":"string","enum":["json","csv"],"default":"json"}}],"responses":{"200":{"description":"List of institutions matching the criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","description":"Metadata for the request and result set.","properties":{"total":{"type":"integer","description":"Total number of records matching the request (ignoring limit/offset)."},"parameters":{"type":"object","description":"Echo of the evaluated query parameters."}}},"data":{"type":"array","description":"Array of institution records. Available fields depend on the fields parameter.","items":{"type":"object","description":"Institution record","additionalProperties":true}}},"required":["meta","data"]}}}},"400":{"description":"Bad request. The query parameters are invalid (e.g., malformed filters or unknown field in fields/sort_by)."},"404":{"description":"Not found."},"406":{"description":"Not acceptable. Requested format is not supported."},"429":{"description":"Too Many Requests."},"500":{"description":"Server error."}}}},"/locations":{"get":{"operationId":"listLocations","summary":"Search FDIC-insured branch and office locations","description":"Returns branch and office location data for FDIC-insured institutions. Filter by geography (e.g., STALP:TX), by institution (e.g., CERT:3510), or by office attributes (e.g., SERVTYPE:11 for full-service brick and mortar).","parameters":[{"name":"filters","in":"query","description":"Elastic query string filter across office/location fields. Examples: CERT:3510; STALP:NY AND SERVTYPE:11; CITY:\"San Francisco\".","style":"form","explode":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Free-text search across indexed location fields (e.g., office name, city).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of location fields to return.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Field to sort by (e.g., OFFNAME, CITY, STALP).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_order","in":"query","description":"Sort direction.","style":"form","explode":true,"schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"limit","in":"query","description":"Maximum number of records to return per request.","style":"form","explode":true,"schema":{"type":"integer","default":25,"maximum":10000,"minimum":1}},{"name":"offset","in":"query","description":"Number of records to skip for pagination (zero-based).","style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"format","in":"query","description":"Response format (json or csv).","style":"form","explode":true,"schema":{"type":"string","enum":["json","csv"],"default":"json"}}],"responses":{"200":{"description":"List of locations matching the criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of matching offices."},"parameters":{"type":"object","description":"Echo of evaluated query parameters."}}},"data":{"type":"array","items":{"type":"object","description":"Office/location record","additionalProperties":true}}},"required":["meta","data"]}}}},"400":{"description":"Bad request (malformed filters or invalid fields)."},"404":{"description":"Not found."},"406":{"description":"Not acceptable (unsupported format)."},"429":{"description":"Too Many Requests."},"500":{"description":"Server error."}}}},"/financials":{"get":{"operationId":"listFinancials","summary":"Retrieve financial reports for institutions","description":"Returns reported financial data for FDIC-insured institutions across reporting periods (e.g., quarterly Call Report items). Filter by CERT, dates, or financial fields.","parameters":[{"name":"filters","in":"query","description":"Elastic query string filter across financial items and identifiers. Examples: CERT:3510 AND REPDTE:[2024-01-01 TO 2024-12-31]; STALP:NY AND REPDTE:2024-12-31.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of financial fields to return. Include identifiers such as CERT, REPDTE, and selected items (e.g., ASSET, DEP, NETINC).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Field to sort by (e.g., REPDTE, ASSET, NETINC).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_order","in":"query","description":"Sort direction.","style":"form","explode":true,"schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"limit","in":"query","description":"Maximum number of records to return per request.","style":"form","explode":true,"schema":{"type":"integer","default":25,"maximum":10000,"minimum":1}},{"name":"offset","in":"query","description":"Number of records to skip (zero-based).","style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"format","in":"query","description":"Response format (json or csv).","style":"form","explode":true,"schema":{"type":"string","enum":["json","csv"],"default":"json"}}],"responses":{"200":{"description":"Financial records for the specified criteria and periods.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"total":{"type":"integer","description":"Total matching rows."},"parameters":{"type":"object","description":"Echo of evaluated parameters."}}},"data":{"type":"array","items":{"type":"object","description":"Financial observation for an institution and period.","additionalProperties":true}}},"required":["meta","data"]}}}},"400":{"description":"Bad request (invalid filters/fields)."},"404":{"description":"Not found."},"406":{"description":"Not acceptable (unsupported format)."},"429":{"description":"Too Many Requests."},"500":{"description":"Server error."}}}},"/history":{"get":{"operationId":"listHistory","summary":"Retrieve institution structure history","description":"Returns historical structure change events for institutions (e.g., mergers, acquisitions, name changes, branch actions) with effective dates and change codes.","parameters":[{"name":"filters","in":"query","description":"Elastic query string filter across history fields. Examples: CERT:10781; CHANGECODE:223; EFFDATE:[2015-01-01 TO 2020-12-31]; STALP:CA AND CHANGECODE:721.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of history fields to return (e.g., CERT,CHANGECODE,CHANGECODE_DESC,EFFDATE,NAME).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records to return per request.","style":"form","explode":true,"schema":{"type":"integer","default":25,"maximum":10000,"minimum":1}},{"name":"offset","in":"query","description":"Number of records to skip for pagination (zero-based).","style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"History records for the selected criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"total":{"type":"integer"},"parameters":{"type":"object"}}},"data":{"type":"array","items":{"type":"object","description":"Structure change event","additionalProperties":true}}},"required":["meta","data"]}}}},"400":{"description":"Bad request (invalid filters/fields)."},"404":{"description":"Not found."},"429":{"description":"Too Many Requests."},"500":{"description":"Server error."}}}},"/failures":{"get":{"operationId":"listFailures","summary":"List failed FDIC-insured institutions","description":"Returns information on FDIC-insured institutions that have failed, including failure dates and resolution details.","parameters":[{"name":"filters","in":"query","description":"Elastic query string filter across failure fields. Examples: FAILYR:2023; PSTALP:CA; NAME:\"Silicon Valley Bank\"; FAILDATE:[2008-01-01 TO 2013-12-31].","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of failure fields to return.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Field to sort by (e.g., FAILDATE, NAME).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"sort_order","in":"query","description":"Sort direction.","style":"form","explode":true,"schema":{"type":"string","enum":["ASC","DESC"]}},{"name":"limit","in":"query","description":"Maximum number of records to return per request.","style":"form","explode":true,"schema":{"type":"integer","default":25,"maximum":10000,"minimum":1}},{"name":"offset","in":"query","description":"Number of records to skip for pagination (zero-based).","style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"Failures matching the criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"total":{"type":"integer"},"parameters":{"type":"object"}}},"data":{"type":"array","items":{"type":"object","description":"Failed bank record","additionalProperties":true}}},"required":["meta","data"]}}}},"400":{"description":"Bad request (invalid filters/fields)."},"404":{"description":"Not found."},"429":{"description":"Too Many Requests."},"500":{"description":"Server error."}}}},"/sod":{"get":{"operationId":"listSummaryOfDeposits","summary":"Retrieve Summary of Deposits data","description":"Returns Summary of Deposits (SOD) data by institution and office. Use to analyze branch-level deposit totals and market share.","parameters":[{"name":"filters","in":"query","description":"Elastic query string filter across SOD fields. Examples: CERT:3510 AND YEAR:2024; STALP:TX AND YEAR:2023; CBSA:41860.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated SOD fields to return (e.g., CERT,YEAR,OFFNAME,DEPDOM).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records to return per request.","style":"form","explode":true,"schema":{"type":"integer","default":25,"maximum":10000,"minimum":1}},{"name":"offset","in":"query","description":"Number of records to skip for pagination (zero-based).","style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"SOD records for the selected criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"total":{"type":"integer"},"parameters":{"type":"object"}}},"data":{"type":"array","items":{"type":"object","description":"SOD office record","additionalProperties":true}}},"required":["meta","data"]}}}},"400":{"description":"Bad request (invalid filters/fields)."},"404":{"description":"Not found."},"429":{"description":"Too Many Requests."},"500":{"description":"Server error."}}}},"/demographics":{"get":{"operationId":"listDemographics","summary":"Retrieve demographic data","description":"Returns demographic and geographic context data associated with FDIC-insured institutions and their offices (e.g., CBSA, metro status, office counts).","parameters":[{"name":"filters","in":"query","description":"Elastic query string filter across demographic fields. Examples: CERT:3510; STALP:FL; CBSA:33100; REPDTE:2024-12-31.","style":"form","explode":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated demographic fields to return (e.g., CERT,REPDTE,CBSA,CBSANAME,METRO,OFFTOT).","style":"form","explode":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records to return per request.","style":"form","explode":true,"schema":{"type":"integer","default":25,"maximum":10000,"minimum":1}},{"name":"offset","in":"query","description":"Number of records to skip for pagination (zero-based).","style":"form","explode":true,"schema":{"type":"integer","default":0,"minimum":0}}],"responses":{"200":{"description":"Demographic records for the selected criteria.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"total":{"type":"integer"},"parameters":{"type":"object"}}},"data":{"type":"array","items":{"type":"object","description":"Demographic observation","additionalProperties":true}}},"required":["meta","data"]}}}},"400":{"description":"Bad request (invalid filters/fields)."},"404":{"description":"Not found."},"429":{"description":"Too Many Requests."},"500":{"description":"Server error."}}}}}}