{
  "openapi": "3.0.1",
  "info": {
    "title": "Bank Regulatory Intelligence Scraper - FDIC & CFPB",
    "description": "Scrape FDIC bank profiles, quarterly financials, structural history, branches, failures and deposit market share, matched to real CFPB consumer complaints. Search 35 Wells Fargo entities by name. Export CSV, Excel, JSON. No login or API key needed. Pay only for records found.",
    "version": "0.1",
    "x-build-id": "X96dBD69JvfZLb9nb"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/recordsdata~bank-regulatory-intelligence-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-recordsdata-bank-regulatory-intelligence-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/recordsdata~bank-regulatory-intelligence-scraper/runs": {
      "post": {
        "operationId": "runs-sync-recordsdata-bank-regulatory-intelligence-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/recordsdata~bank-regulatory-intelligence-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-recordsdata-bank-regulatory-intelligence-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "banks",
              "complaints"
            ],
            "type": "string",
            "description": "Banks: search FDIC institutions (by name or filters) and optionally attach CFPB complaints to each bank. Complaints only: search the CFPB consumer complaint database directly, one row per complaint, with no FDIC data.",
            "default": "banks"
          },
          "bankName": {
            "title": "Bank name",
            "type": "string",
            "description": "Banks mode: bank or institution name to search (e.g. \"Wells Fargo\"), matched against FDIC institution names; optional when you use a state, charter class, assets or active-only filter. Complaints-only mode: company name, matched to the start of CFPB registered company names (for example \"Wells Fargo\" or \"Experian\"); leave empty to search all companies.",
            "default": ""
          },
          "state": {
            "title": "State",
            "enum": [
              "",
              "AK",
              "AL",
              "AR",
              "AS",
              "AZ",
              "CA",
              "CO",
              "CT",
              "DC",
              "DE",
              "FL",
              "GA",
              "GU",
              "HI",
              "IA",
              "ID",
              "IL",
              "IN",
              "KS",
              "KY",
              "LA",
              "MA",
              "MD",
              "ME",
              "MI",
              "MN",
              "MO",
              "MP",
              "MS",
              "MT",
              "NC",
              "ND",
              "NE",
              "NH",
              "NJ",
              "NM",
              "NV",
              "NY",
              "OH",
              "OK",
              "OR",
              "PA",
              "PR",
              "RI",
              "SC",
              "SD",
              "TN",
              "TX",
              "UT",
              "VA",
              "VI",
              "VT",
              "WA",
              "WI",
              "WV",
              "WY"
            ],
            "type": "string",
            "description": "Only institutions headquartered in this state or territory. Combine with Bank name, or use it alone to list every bank in the state (sorted by assets with Sort by).",
            "default": ""
          },
          "activeOnly": {
            "title": "Active institutions only",
            "type": "boolean",
            "description": "Skip closed, merged and failed institutions. Leave off to include their history.",
            "default": false
          },
          "charterClass": {
            "title": "Charter class",
            "enum": [
              "",
              "N",
              "SM",
              "NM",
              "SB",
              "SA",
              "OI"
            ],
            "type": "string",
            "description": "FDIC charter class: national banks (N), state commercial banks in the Federal Reserve System (SM) or not in it (NM), federal and state savings banks (SB) and associations (SA), and other institutions (OI).",
            "default": ""
          },
          "minAssetsMillions": {
            "title": "Minimum total assets (USD millions)",
            "minimum": 0,
            "type": "integer",
            "description": "Only institutions with at least this many millions of dollars in total assets, for example 1000 for banks above 1 billion dollars. 0 means no minimum.",
            "default": 0
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "ASSET",
              "DEP",
              "NAME",
              "ESTYMD",
              "OFFICES"
            ],
            "type": "string",
            "description": "Order of the institution list: relevance (best name match), or by total assets, deposits, name, founding date or number of offices.",
            "default": "relevance"
          },
          "sortOrder": {
            "title": "Sort order",
            "enum": [
              "DESC",
              "ASC"
            ],
            "type": "string",
            "description": "Descending (largest or newest first) or ascending. Ignored when Sort by is relevance.",
            "default": "DESC"
          },
          "maxItems": {
            "title": "Max Items",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Maximum number of rows to deliver: institutions in banks mode, complaints in complaints-only mode. Free users: limited to 10 (preview). Paid users: optional, max 1,000,000.",
            "default": 10
          },
          "includeFinancials": {
            "title": "Quarterly financials",
            "type": "boolean",
            "description": "Financial reports by quarter (net income, assets, deposits, equity). Billed per quarter as financial-record.",
            "default": false
          },
          "maxFinancialQuarters": {
            "title": "Max financial quarters per bank",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many of the most recent quarters to pull when Quarterly financials is on.",
            "default": 8
          },
          "includeHistory": {
            "title": "Structural history",
            "type": "boolean",
            "description": "Name changes, mergers, and charter changes over the bank's history. Billed per change record as history-record.",
            "default": false
          },
          "includeLocations": {
            "title": "Branch locations",
            "type": "boolean",
            "description": "Every branch address with coordinates. Billed per branch as location-record.",
            "default": false
          },
          "includeFailureDetail": {
            "title": "Failure detail",
            "type": "boolean",
            "description": "If the institution failed, the resolution type, cost, and acquiring bank. Billed per failure record as failure-record. Most banks never failed — this returns nothing for them.",
            "default": false
          },
          "includeDepositMarketShare": {
            "title": "Deposit market share",
            "type": "boolean",
            "description": "Branch-level deposit totals by year (FDIC Summary of Deposits). Billed per branch-year record as deposit-market-share-record.",
            "default": false
          },
          "includeDemographics": {
            "title": "Branch demographics (quarterly)",
            "type": "boolean",
            "description": "Quarterly office counts (domestic, foreign, territories), metro area and FDIC territory per institution. Billed per quarter returned.",
            "default": false
          },
          "maxDemographicQuarters": {
            "title": "Max demographic quarters",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many of the latest quarters of branch demographics to attach per institution.",
            "default": 8
          },
          "maxDepositRecords": {
            "title": "Max deposit records per bank",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many branch-year deposit records to pull per bank when Deposit market share is on.",
            "default": 20
          },
          "includeComplaints": {
            "title": "Consumer complaints (CFPB)",
            "type": "boolean",
            "description": "Banks mode only. Consumer complaints filed against this company with the CFPB: product, issue, state, ZIP, company response, timely flag. The complaint filters below apply. Billed per complaint as complaint-record.",
            "default": false
          },
          "maxComplaints": {
            "title": "Max complaints per bank",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many complaints to pull per bank when Consumer complaints is on (newest first by default, in pages of 100). Free users: limited to 50 per bank (preview). Paid users: up to 10,000 per bank.",
            "default": 20
          },
          "complaintDateFrom": {
            "title": "Received from (date)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Only complaints received on or after this date, format YYYY-MM-DD (for example 2025-01-01). Applies to Complaints-only mode and to the Consumer complaints add-on.",
            "default": ""
          },
          "complaintDateTo": {
            "title": "Received until (date)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Only complaints received on or before this date (the whole day is included), format YYYY-MM-DD. Combine with Received from to take one window, for example one month.",
            "default": ""
          },
          "complaintProduct": {
            "title": "Complaint product",
            "enum": [
              "",
              "Credit reporting or other personal consumer reports",
              "Credit reporting, credit repair services, or other personal consumer reports",
              "Debt collection",
              "Mortgage",
              "Checking or savings account",
              "Credit card",
              "Credit card or prepaid card",
              "Money transfer, virtual currency, or money service",
              "Credit reporting",
              "Student loan",
              "Vehicle loan or lease",
              "Bank account or service",
              "Payday loan, title loan, personal loan, or advance loan",
              "Consumer Loan",
              "Payday loan, title loan, or personal loan",
              "Prepaid card",
              "Debt or credit management",
              "Payday loan",
              "Money transfers",
              "Other financial service",
              "Virtual currency"
            ],
            "type": "string",
            "description": "Only complaints about this product category, exactly as the CFPB names it. Older categories (for example \"Credit reporting\" or \"Bank account or service\") exist for complaints filed before the CFPB renamed them.",
            "default": ""
          },
          "complaintSubProduct": {
            "title": "Complaint sub-product",
            "type": "string",
            "description": "Optional. A sub-product of the chosen Complaint product, exactly as the CFPB names it, for example \"Federal student loan servicing\" with product \"Student loan\". Needs Complaint product.",
            "default": ""
          },
          "complaintIssue": {
            "title": "Complaint issue",
            "type": "string",
            "description": "Only complaints with this issue, exactly as the CFPB names it and case sensitive, for example \"Incorrect information on your report\" or \"Dealing with your lender or servicer\". A wrong spelling returns no complaints.",
            "default": ""
          },
          "complaintSubIssue": {
            "title": "Complaint sub-issue",
            "type": "string",
            "description": "Optional. A sub-issue of the chosen Complaint issue, exactly as the CFPB names it, for example \"Trouble with how payments are being handled\" with issue \"Dealing with your lender or servicer\". Needs Complaint issue.",
            "default": ""
          },
          "complaintState": {
            "title": "Complaint state",
            "enum": [
              "",
              "AA",
              "AE",
              "AK",
              "AL",
              "AP",
              "AR",
              "AS",
              "AZ",
              "CA",
              "CO",
              "CT",
              "DC",
              "DE",
              "FL",
              "FM",
              "GA",
              "GU",
              "HI",
              "IA",
              "ID",
              "IL",
              "IN",
              "KS",
              "KY",
              "LA",
              "MA",
              "MD",
              "ME",
              "MH",
              "MI",
              "MN",
              "MO",
              "MP",
              "MS",
              "MT",
              "NC",
              "ND",
              "NE",
              "NH",
              "NJ",
              "NM",
              "NV",
              "NY",
              "OH",
              "OK",
              "OR",
              "PA",
              "PR",
              "PW",
              "RI",
              "SC",
              "SD",
              "TN",
              "TX",
              "UT",
              "VA",
              "VI",
              "VT",
              "WA",
              "WI",
              "WV",
              "WY"
            ],
            "type": "string",
            "description": "Only complaints from consumers in this state or territory (the state the consumer reported, two-letter code).",
            "default": ""
          },
          "complaintZip": {
            "title": "Complaint ZIP code",
            "pattern": "^(\\d{5}|\\d{3}[Xx]{2})?$",
            "type": "string",
            "description": "Only complaints from this ZIP code: 5 digits (for example 75001), or 3 digits plus XX (for example 750XX) for the ZIPs the CFPB masks. Exact match, no ranges.",
            "default": ""
          },
          "complaintResponse": {
            "title": "Company response to consumer",
            "enum": [
              "",
              "Closed with explanation",
              "Closed with non-monetary relief",
              "In progress",
              "Closed with monetary relief",
              "Untimely response",
              "Closed without relief",
              "Closed",
              "Closed with relief"
            ],
            "type": "string",
            "description": "Only complaints whose company response is this value.",
            "default": ""
          },
          "complaintPublicResponse": {
            "title": "Company public response",
            "enum": [
              "",
              "Company has responded to the consumer and the CFPB and chooses not to provide a public response",
              "Company believes it acted appropriately as authorized by contract or law",
              "Company chooses not to provide a public response",
              "Company disputes the facts presented in the complaint",
              "Company believes the complaint is the result of a misunderstanding",
              "Company believes complaint caused principally by actions of third party outside the control or direction of the company",
              "Company believes the complaint provided an opportunity to answer consumer's questions",
              "Company can't verify or dispute the facts in the complaint",
              "Company believes complaint is the result of an isolated error",
              "Company believes complaint represents an opportunity for improvement to better serve consumers"
            ],
            "type": "string",
            "description": "Only complaints where the company chose this public response.",
            "default": ""
          },
          "complaintTimely": {
            "title": "Timely response",
            "enum": [
              "",
              "Yes",
              "No"
            ],
            "type": "string",
            "description": "Yes: the company answered within the CFPB deadline. No: it did not. Empty: both.",
            "default": ""
          },
          "complaintSubmittedVia": {
            "title": "Submitted via",
            "enum": [
              "",
              "Web",
              "Referral",
              "Phone",
              "Postal mail",
              "Fax",
              "Email"
            ],
            "type": "string",
            "description": "Only complaints the consumer submitted through this channel.",
            "default": ""
          },
          "complaintTags": {
            "title": "Consumer tag",
            "enum": [
              "",
              "Servicemember",
              "Older American",
              "Older American, Servicemember"
            ],
            "type": "string",
            "description": "Only complaints carrying this CFPB tag (older Americans, servicemembers and their families).",
            "default": ""
          },
          "complaintSearchTerm": {
            "title": "Search term",
            "type": "string",
            "description": "Free-text search over the complaint fields the CFPB indexes: company, product, sub-product, issue and sub-issue (for example \"identity theft\" or \"overdraft\"). Several words must appear together in the same field, so keep it to one short phrase. The public CFPB API does not index complaint narratives.",
            "default": ""
          },
          "complaintSort": {
            "title": "Complaint sort",
            "enum": [
              "created_date_desc",
              "created_date_asc",
              "relevance_desc"
            ],
            "type": "string",
            "description": "Newest first (default), oldest first, or best match for the search term.",
            "default": "created_date_desc"
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}