{
  "openapi": "3.0.1",
  "info": {
    "title": "BrokerCheck Scraper - Financial Advisors, Brokers & Firms",
    "description": "Scrape FINRA BrokerCheck & SEC IAPD: brokers, investment advisers and firms by name, CRD or firm roster. Full reports — employment history, Series exams/licenses, registered states, disclosures, firm AUM/address/phone. Monitoring + leads. No login, no API key, no browser.",
    "version": "0.1",
    "x-build-id": "sXXh8ATRkReGlM7ez"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~brokercheck-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-brokercheck-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~brokercheck-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-brokercheck-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~brokercheck-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-brokercheck-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",
        "required": [
          "searchType"
        ],
        "properties": {
          "searchType": {
            "title": "What to scrape",
            "enum": [
              "individuals",
              "firms"
            ],
            "type": "string",
            "description": "Scrape individuals (brokers & investment advisers) or firms (broker-dealers & RIA firms). Search terms, CRD numbers and the role/state filters apply to whichever you pick.",
            "default": "individuals"
          },
          "searchTerms": {
            "title": "Search terms (names or firm names)",
            "type": "array",
            "description": "Keywords to search FINRA/SEC for. For individuals use person names (`John Smith`); for firms use firm names (`Morgan Stanley`, `Edward Jones`). One per row. Each is paginated up to the limit below.",
            "items": {
              "type": "string"
            }
          },
          "firmCrdNumbers": {
            "title": "Firm CRD numbers — pull the full adviser/broker roster",
            "type": "array",
            "description": "List every broker & adviser registered at these firms (use the firm's CRD number, e.g. `6413` for LPL Financial). The recruiting/competitive-intel wedge. Used when scraping Individuals.",
            "items": {
              "type": "string"
            }
          },
          "crdNumbers": {
            "title": "CRD numbers — direct lookups",
            "type": "array",
            "description": "Fetch full reports for specific CRD numbers directly. Treated as individuals or firms depending on the mode above. One CRD per row.",
            "items": {
              "type": "string"
            }
          },
          "source": {
            "title": "Data source",
            "enum": [
              "auto",
              "brokercheck",
              "sec_iapd"
            ],
            "type": "string",
            "description": "Auto uses FINRA BrokerCheck for individuals and both BrokerCheck + SEC IAPD for firms (merged). Force one registry if you only want brokers (BrokerCheck) or investment advisers (SEC IAPD).",
            "default": "auto"
          },
          "maxResultsPerTerm": {
            "title": "Max results per term / roster",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Cap the number of records returned per search term or per firm roster. Results paginate automatically until this limit or the result set is exhausted.",
            "default": 50
          },
          "includeDetails": {
            "title": "Fetch full reports (recommended)",
            "type": "boolean",
            "description": "Open each record's full report: employment history, Series exams & licenses, registered states, SRO categories, disclosures, and (firms) address, phone, type, size, owners and Form ADV brochures. Off = fast lightweight records from search only.",
            "default": true
          },
          "roleFilter": {
            "title": "Role filter (individuals)",
            "enum": [
              "any",
              "brokers",
              "advisers"
            ],
            "type": "string",
            "description": "Keep only brokers, only investment advisers, or any. Applies to the Individuals mode.",
            "default": "any"
          },
          "stateFilter": {
            "title": "State filter",
            "type": "string",
            "description": "Keep only records in this US state — `NY` or `New York`. Individuals match by branch office or any registered state; firms match by office state. Leave blank for all states.",
            "default": ""
          },
          "activeOnly": {
            "title": "Active registrations only",
            "type": "boolean",
            "description": "Keep only currently-active brokers/advisers (or active firms). Off includes former/inactive registrations too.",
            "default": false
          },
          "withDisclosuresOnly": {
            "title": "With disclosures only",
            "type": "boolean",
            "description": "Keep only records that have reportable disclosures (regulatory actions, customer disputes, etc.) — for compliance, due-diligence and screening.",
            "default": false
          },
          "enrichFirmContacts": {
            "title": "Enrich firm contacts (crawl website for emails, phone, socials)",
            "type": "boolean",
            "description": "Opt-in lead enrichment for firms that publish a website: crawl the firm's own site (home + a contact/about page) for contact emails, phone numbers and social links. FINRA/SEC do not expose emails — this is the only public source.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitoring mode — only new or changed records",
            "type": "boolean",
            "description": "Remember CRDs seen in previous runs and emit ONLY records that are new — or whose disclosure count changed (a new regulatory event). Ideal for compliance monitoring. Pairs with Apify Schedules to track changes over time.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Named key-value store that holds the 'already seen' CRDs (and their disclosure counts) for monitoring mode. Use a different name per tracked target to keep histories separate.",
            "default": "brokercheck-monitor"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 12,
            "type": "integer",
            "description": "Maximum parallel requests. Lower it if you hit rate limits on very large runs.",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. FINRA BrokerCheck and SEC IAPD work fine through the default Apify datacenter proxy.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}