{ "openapi": "3.0.1", "info": { "title": "California Real Estate License Scraper (DRE)", "description": "Scrape California real estate license records from the DRE public license lookup by agent or broker name or license ID. Extract licensee name, license ID, type, status, expiration, responsible broker, address and disciplinary flag. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "4aDMOC7HDnrSCDNv3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~california-dre-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-california-dre-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/scrapers_lat~california-dre-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-california-dre-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/scrapers_lat~california-dre-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-california-dre-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": [ "query" ], "properties": { "maxLicensees": { "title": "Max licensees", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of licensee records to collect for the search. Optional." }, "withDetails": { "title": "Include Full License Details", "type": "boolean", "description": "When enabled, each licensee also includes the full detail record: license status, expiration and issue dates, mailing address, responsible or employing broker, licensed officers, DBAs and any disciplinary action. When disabled, only the summary fields (name, license ID, license type, city) from the search results are returned, which is much faster for large name searches.", "default": true }, "query": { "title": "Name or License ID", "type": "string", "description": "A licensee name or an 8-digit license ID. Names can be a full name (for example \"Smith, John\"), a last name, or an agency or brokerage name (for example \"Coldwell Banker\"). An 8-digit number is treated as a license ID and returns that single license." }, "city": { "title": "City", "type": "string", "description": "Optional city filter applied to the name search (for example \"Irvine\"). Leave blank to search statewide." }, "licenseType": { "title": "License Type", "enum": [ "any", "salesperson", "broker", "corporation" ], "type": "string", "description": "Optional filter to keep only one kind of license from the results.", "default": "any" }, "status": { "title": "License Status", "enum": [ "any", "licensed", "expired" ], "type": "string", "description": "Optional filter to keep only licenses in a given status. Requires Include Full License Details.", "default": "any" }, "includeSalespersons": { "title": "Include affiliated salespersons (brokers/corporations)", "type": "boolean", "description": "When enabled, broker and corporation records also include the full roster of affiliated salespersons (license ID, name and expiration date). Off by default because large brokerages can have thousands of agents. Requires Include Full License Details.", "default": false }, "maxSalespersons": { "title": "Max affiliated salespersons per record", "minimum": 1, "type": "integer", "description": "Cap how many affiliated salespersons to collect per broker/corporation. Free Apify accounts are capped at 100.", "default": 500 }, "enrichContacts": { "title": "Find contact email & name (paid add-on)", "type": "boolean", "description": "Optional paid add-on, off by default. For each result without an email, attempt to find a public business contact email and a contact person's name. Billed per attempt, plus an extra charge only when an email is found.", "default": false }, "enrichContactsMax": { "title": "Max results to enrich", "minimum": 1, "type": "integer", "description": "Cap how many results the add-on tries to enrich, to control add-on cost. Leave empty to attempt all. Free Apify accounts are capped at 3.", "default": 50 } } }, "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 } } } } } } } } } }