/** * FDIC SDK — typed API client for the Federal Deposit Insurance Corporation * BankFind Suite API. * * Standalone — no MCP server required. Usage: * * import { searchInstitutions, getBankFailures, getFinancials } from "us-gov-open-data-mcp/sdk/fdic"; * * const banks = await searchInstitutions({ filters: "STNAME:\"California\"", limit: 10 }); * const failures = await getBankFailures({ limit: 25 }); * * No API key required. * Docs: https://banks.data.fdic.gov/docs/ */ /** Fdic API Response. */ export interface FdicApiResponse> { meta: { total: number; parameters: Record; index?: string; [key: string]: unknown; }; data: Array<{ data: T; score?: number; }>; totals?: Record; [key: string]: unknown; } /** Institution. */ export interface Institution { CERT?: number; REPDTE?: string; INSTNAME?: string; CITY?: string; STNAME?: string; STALP?: string; ZIP?: string; WEBADDR?: string; INSTCAT?: number; SPECGRP?: number; ASSET?: number; DEP?: number; DEPDOM?: number; NETINC?: number; ROA?: number; ROE?: number; RISESSION?: number; CHARTER_CLASS?: string; FED_RSSD?: number; ACTIVE?: number; REGAGENT?: string; FDICREGION?: string; HCTMULT?: string; OFFDOM?: number; [key: string]: unknown; } /** Bank Failure. */ export interface BankFailure { CERT?: number; INSTNAME?: string; CITY?: string; ST?: string; FAILDATE?: string; SAVR?: string; COST?: number; RESTYPE?: string; RESTYPE1?: string; QBFASSET?: number; QBFDEP?: number; PSTALP?: string; [key: string]: unknown; } /** Financial Record. */ export interface FinancialRecord { CERT?: number; REPDTE?: string; INSTNAME?: string; ASSET?: number; DEP?: number; DEPDOM?: number; NETINC?: number; INTINC?: number; EINTEXP?: number; ELNATR?: number; NITEFDS?: number; NONII?: number; ROA?: number; ROE?: number; LNLSGR?: number; LNLSNET?: number; [key: string]: unknown; } /** Sod Record. */ export interface SodRecord { CERT?: number; REPDTE?: string; INSTNAME?: string; BRNUM?: number; BRSERTYP?: number; STNAME?: string; STALP?: string; CITY?: string; COUNTY?: string; ZIPBR?: string; DEPSUMBR?: number; BKMO?: number; [key: string]: unknown; } /** History Event. */ export interface HistoryEvent { CERT?: number; INSTNAME?: string; PCITY?: string; PSTALP?: string; EFFDATE?: string; ACESSION?: string; ACT_NAME?: string; CHARTEFDS?: string; [key: string]: unknown; } /** Demographic Record. */ export interface DemographicRecord { CERT?: number; REPDTE?: string; INSTNAME?: string; STALP?: string; STNAME?: string; MSA_NO?: string; TRACT?: string; INCOME_LVL?: string; [key: string]: unknown; } /** Available FDIC API datasets/endpoints. */ export declare const DATASETS: { readonly institutions: "Currently open and insured depository institutions — filterable by state, assets, charter type"; readonly failures: "All FDIC-insured bank failures since 1934"; readonly financials: "Call report financial data (assets, deposits, income, ratios) by quarter"; readonly summary: "Aggregate banking statistics by state or charter type across time"; readonly sod: "Summary of Deposits — branch-level deposit data, annual (June 30)"; readonly history: "Institution event history — mergers, name changes, charter changes"; readonly locations: "Physical branch and office locations"; readonly demographics: "Community Reinvestment Act assessment area demographics"; }; /** Common filter field names for the institutions endpoint. */ export declare const INSTITUTION_FIELDS: { readonly STALP: "State abbreviation (CA, TX, NY)"; readonly STNAME: "State full name"; readonly INSTNAME: "Institution name"; readonly ACTIVE: "Active status (1=active)"; readonly INSTCAT: "Institution category (1=commercial bank, 2=savings, 5=state charter, 9=national bank)"; readonly ASSET: "Total assets (in thousands)"; readonly DEP: "Total deposits (in thousands)"; readonly NETINC: "Net income (in thousands)"; readonly CHARTER_CLASS: "Charter class (N=national, SM=state member, NM=state non-member, SB=savings bank, SL=savings & loan)"; readonly CITY: "City name"; readonly ZIP: "ZIP code"; }; /** Filter syntax examples. */ export declare const FILTER_EXAMPLES: { readonly "State filter": "STALP:\"CA\""; readonly "Active only": "ACTIVE:1"; readonly "Large banks": "ASSET:[1000000 TO *]"; readonly Multiple: "STALP:\"TX\" AND ACTIVE:1"; readonly "Name search": "INSTNAME:\"Wells Fargo\""; readonly "Charter type": "CHARTER_CLASS:\"N\""; readonly "Asset range": "ASSET:[100000 TO 500000]"; }; /** * Search FDIC-insured institutions (banks, savings & loans). * * Example: * const banks = await searchInstitutions({ filters: 'STALP:"CA" AND ACTIVE:1', limit: 25 }); * const large = await searchInstitutions({ filters: 'ASSET:[1000000 TO *]', sort_by: 'ASSET', sort_order: 'DESC' }); */ export declare function searchInstitutions(opts?: { filters?: string; fields?: string; search?: string; sort_by?: string; sort_order?: string; limit?: number; offset?: number; }): Promise>; /** * Get FDIC-insured bank failures since 1934. * * Example: * const recent = await getBankFailures({ limit: 20, sort_by: "FAILDATE", sort_order: "DESC" }); * const byState = await getBankFailures({ filters: 'PSTALP:"GA"' }); */ export declare function getBankFailures(opts?: { filters?: string; fields?: string; sort_by?: string; sort_order?: string; limit?: number; offset?: number; }): Promise>; /** * Get quarterly financial reports (Call Report data) for banks. * * Example: * const financials = await getFinancials({ filters: 'CERT:3511', limit: 10 }); * const stateFinancials = await getFinancials({ filters: 'STALP:"CA" AND REPDTE:20240331', limit: 50 }); */ export declare function getFinancials(opts?: { filters?: string; fields?: string; sort_by?: string; sort_order?: string; limit?: number; offset?: number; }): Promise>; /** * Get aggregate banking statistics (industry totals by state, charter type, etc.). * * Example: * const summary = await getSummary({ filters: 'STALP:"TX"', limit: 10 }); */ export declare function getSummary(opts?: { filters?: string; fields?: string; sort_by?: string; sort_order?: string; limit?: number; offset?: number; agg_by?: string; agg_term_fields?: string; agg_sum_fields?: string; agg_limit?: number; }): Promise; /** * Get Summary of Deposits — branch-level deposit data (annual, as of June 30). * * Example: * const deposits = await getDeposits({ filters: 'STALP:"NY"', sort_by: 'DEPSUMBR', sort_order: 'DESC', limit: 20 }); */ export declare function getDeposits(opts?: { filters?: string; fields?: string; sort_by?: string; sort_order?: string; limit?: number; offset?: number; }): Promise>; /** * Get institution event history (mergers, name changes, charter changes). * * Example: * const history = await getHistory({ filters: 'CERT:3511', limit: 50 }); */ export declare function getHistory(opts?: { filters?: string; fields?: string; sort_by?: string; sort_order?: string; limit?: number; offset?: number; }): Promise>; /** Clear cached responses. */ export declare function clearCache(): void; //# sourceMappingURL=sdk.d.ts.map