{
  "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": "xiMFU5sRNG0FQPRz7"
  },
  "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": "What do you want to get?",
            "enum": [
              "banks",
              "complaints"
            ],
            "type": "string",
            "description": "Banks: one row per FDIC institution. Complaints only: one row per CFPB consumer complaint, no FDIC data. Example: Banks with the name Wells Fargo.",
            "default": "banks"
          },
          "bankName": {
            "title": "Bank or company name",
            "type": "string",
            "description": "Example: Wells Fargo. Banks mode: matched against FDIC institution names (optional if you use a state, class or assets filter). Complaints only: matched to the start of CFPB company names, for example Experian; empty searches all companies.",
            "default": ""
          },
          "state": {
            "title": "Headquarters 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. Use it alone to list every bank in the state, biggest first.",
            "default": ""
          },
          "charterClass": {
            "title": "Charter type",
            "enum": [
              "",
              "N",
              "SM",
              "NM",
              "SB",
              "SA",
              "OI"
            ],
            "type": "string",
            "description": "National bank (N), state commercial bank in the Federal Reserve System (SM) or not (NM), savings bank (SB), savings association (SA), other (OI). Empty means any.",
            "default": ""
          },
          "minAssetsMillions": {
            "title": "Minimum total assets (USD millions)",
            "minimum": 0,
            "type": "integer",
            "description": "Example: 1000 for banks above 1 billion dollars. 0 means no minimum.",
            "default": 0
          },
          "activeOnly": {
            "title": "Hide closed, merged and failed banks",
            "type": "boolean",
            "description": "Turn on to return only active institutions. Off keeps closed ones and their history.",
            "default": false
          },
          "sortBy": {
            "title": "Sort banks by",
            "enum": [
              "relevance",
              "ASSET",
              "DEP",
              "NAME",
              "ESTYMD",
              "OFFICES"
            ],
            "type": "string",
            "description": "Relevance (best name match), total assets, deposits, name, founding date or number of offices.",
            "default": "relevance"
          },
          "sortOrder": {
            "title": "Sort direction",
            "enum": [
              "DESC",
              "ASC"
            ],
            "type": "string",
            "description": "Descending (largest or newest first) or ascending. Ignored when sorting by relevance.",
            "default": "DESC"
          },
          "maxItems": {
            "title": "Max results (rows)",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Banks mode: institutions. Complaints only: complaints. Free plan runs are capped at 10. Paid plans: up to 1,000,000.",
            "default": 10
          },
          "includeFinancials": {
            "title": "Add quarterly financials",
            "type": "boolean",
            "description": "Net income, assets, deposits and equity by quarter. Billed per quarter (financial-record).",
            "default": false
          },
          "maxFinancialQuarters": {
            "title": "Financials: quarters per bank",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many of the latest quarters to pull when quarterly financials are on. Example: 8.",
            "default": 8
          },
          "includeHistory": {
            "title": "Add structural history",
            "type": "boolean",
            "description": "Name changes, mergers and charter changes. Billed per change (history-record).",
            "default": false
          },
          "includeLocations": {
            "title": "Add branch locations",
            "type": "boolean",
            "description": "Every branch address with coordinates. Billed per branch (location-record).",
            "default": false
          },
          "includeFailureDetail": {
            "title": "Add failure detail",
            "type": "boolean",
            "description": "For failed institutions only: resolution type, cost and acquiring bank. Billed per failure record. Returns nothing for banks that never failed.",
            "default": false
          },
          "includeDepositMarketShare": {
            "title": "Add deposit market share",
            "type": "boolean",
            "description": "Branch-level deposits by year (FDIC Summary of Deposits). Billed per branch-year record.",
            "default": false
          },
          "maxDepositRecords": {
            "title": "Deposit share: records per bank",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "How many branch-year records to pull per bank when deposit market share is on. Example: 20.",
            "default": 20
          },
          "includeDemographics": {
            "title": "Add branch demographics (quarterly)",
            "type": "boolean",
            "description": "Quarterly office counts (domestic, foreign, territories), metro area and FDIC territory. Billed per quarter returned.",
            "default": false
          },
          "maxDemographicQuarters": {
            "title": "Demographics: quarters per bank",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "How many of the latest quarters to attach per institution. Example: 8.",
            "default": 8
          },
          "includeComplaints": {
            "title": "Attach complaints to each bank (Banks mode)",
            "type": "boolean",
            "description": "Adds the CFPB consumer complaints filed against each bank: product, issue, state, ZIP, company response, timely flag. Billed per complaint (complaint-record). The filters below apply.",
            "default": false
          },
          "maxComplaints": {
            "title": "Complaints per bank (limit)",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many complaints to pull per bank when the add-on is on, newest first in pages of 100. Free plan: up to 50 per bank. Paid plans: up to 10,000.",
            "default": 20
          },
          "complaintSearchTerm": {
            "title": "Complaint keyword",
            "type": "string",
            "description": "Free-text over company, product, sub-product, issue and sub-issue. Example: identity theft, or overdraft. Keep it to one short phrase. Complaint narratives are not searchable in the public CFPB API.",
            "default": ""
          },
          "complaintDateFrom": {
            "title": "Received from (YYYY-MM-DD)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Only complaints received on or after this date. Example: 2025-01-01.",
            "default": ""
          },
          "complaintDateTo": {
            "title": "Received until (YYYY-MM-DD)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Only complaints received on or before this date (the whole day is included). Example: 2025-12-31.",
            "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": ""
          },
          "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}