{
  "openapi": "3.0.1",
  "info": {
    "title": "US Banks & Credit Unions Scraper - Financials & Leads",
    "description": "Scrape every US bank & credit union: name, address, phone/website, total assets, deposits, loans, members, net worth, ROA, branches, charter & regulator. Filter by state, asset size, type & charter. B2B leads + financial intelligence + monitoring. Official FDIC & NCUA data, no browser.",
    "version": "0.1",
    "x-build-id": "WOjmZ4p6QhENG1Pdr"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~us-banks-credit-unions-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-us-banks-credit-unions-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/scrapesage~us-banks-credit-unions-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-us-banks-credit-unions-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/scrapesage~us-banks-credit-unions-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-us-banks-credit-unions-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": {
          "institutionTypes": {
            "title": "Institution types",
            "type": "array",
            "description": "Which institutions to include: banks (FDIC-insured) and/or credit unions (NCUA-insured). The combined view is what makes this dataset unique.",
            "items": {
              "type": "string",
              "enum": [
                "bank",
                "creditUnion"
              ],
              "enumTitles": [
                "Banks (FDIC)",
                "Credit unions (NCUA)"
              ]
            },
            "default": [
              "bank",
              "creditUnion"
            ]
          },
          "states": {
            "title": "States",
            "type": "array",
            "description": "Filter by institution state — two-letter codes, e.g. [\"TX\", \"CA\"]. Empty = all states.",
            "items": {
              "type": "string"
            }
          },
          "nameQuery": {
            "title": "Name contains",
            "type": "string",
            "description": "Only institutions whose name contains this text (case-insensitive), e.g. \"Navy\" or \"Community\"."
          },
          "assetMin": {
            "title": "Min total assets ($)",
            "type": "integer",
            "description": "Only institutions with at least this much in total assets (in dollars), e.g. 1000000000 for $1B+."
          },
          "assetMax": {
            "title": "Max total assets ($)",
            "type": "integer",
            "description": "Only institutions with at most this much in total assets."
          },
          "minMembers": {
            "title": "Min members (credit unions)",
            "type": "integer",
            "description": "Only credit unions with at least this many members. (Banks have no members and are excluded by this filter when set.)"
          },
          "minBranches": {
            "title": "Min branches / offices",
            "type": "integer",
            "description": "Only institutions with at least this many branches / offices."
          },
          "charterTypes": {
            "title": "Charter class",
            "type": "array",
            "description": "Filter by charter class code. Banks: N (national), NM (state nonmember), SM (state member), SA/SB (savings). Credit unions: 1 (federal), 2/3 (state).",
            "items": {
              "type": "string"
            }
          },
          "activeOnly": {
            "title": "Active institutions only",
            "type": "boolean",
            "description": "Exclude closed/merged banks. Credit-union Call Report data is current-period (active) by nature.",
            "default": true
          },
          "withContactOnly": {
            "title": "Only with a phone or website",
            "type": "boolean",
            "description": "Keep only institutions that have a phone (credit unions) or website (banks).",
            "default": false
          },
          "ncuaQuarter": {
            "title": "NCUA quarter (advanced)",
            "type": "string",
            "description": "Force a specific NCUA Call Report quarter as YYYY-MM (e.g. \"2025-12\"). Leave empty to auto-use the most recent published quarter."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "assets",
              "leadScore",
              "members",
              "branches",
              "name"
            ],
            "type": "string",
            "description": "Order of the returned institutions.",
            "default": "assets"
          },
          "maxResults": {
            "title": "Max results",
            "type": "integer",
            "description": "Maximum number of institution records to return.",
            "default": 1000
          },
          "deduplicateResults": {
            "title": "Deduplicate",
            "type": "boolean",
            "description": "Drop duplicate institutions within a run.",
            "default": true
          },
          "monitorMode": {
            "title": "Monitoring mode (only new institutions)",
            "type": "boolean",
            "description": "Remember which institutions were already returned and, on the next run with the same monitor key, emit only institutions new since then — e.g. newly chartered banks/credit unions or ones that newly match your filters. Works alongside Apify Schedules.",
            "default": false
          },
          "monitorKey": {
            "title": "Monitor key",
            "type": "string",
            "description": "A label for this saved watch (e.g. \"tx-banks\"). Use a distinct key per saved search.",
            "default": "default"
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. FDIC and NCUA are public sources reachable without a proxy (the default).",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}