{ "openapi": "3.0.1", "info": { "title": "Citysearch Real-Time Data Scraper", "description": "Live Citysearch business directory data: keyword + city search across US local businesses, full profiles, reviews & ratings, and lead enrichment with phones, websites, emails, and socials. Checkbox features stream structured JSON to your dataset in real time.", "version": "0.0", "x-build-id": "CMQIiPQOA8MKtDhPJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~Citysearch-Real-Time-Data-Scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-Citysearch-Real-Time-Data-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/b2b_leads~Citysearch-Real-Time-Data-Scraper/runs": { "post": { "operationId": "runs-sync-b2b_leads-Citysearch-Real-Time-Data-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/b2b_leads~Citysearch-Real-Time-Data-Scraper/run-sync": { "post": { "operationId": "run-sync-b2b_leads-Citysearch-Real-Time-Data-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": { "enableBusinessSearch": { "title": "Business Search", "type": "boolean", "description": "Live keyword + city search across the US Citysearch directory — local services, contractors, clinics, retail, and more. On by default and prefilled so you can click Start and get results in seconds.", "default": true }, "searchTerms": { "title": "Search terms", "type": "array", "description": "What to look for, e.g. \"plumber\", \"roofing contractor\", \"dentist\", \"auto repair\", \"med spa\". Required when Business Search is on. Each term is combined with every location below.", "default": [ "plumber", "roofing contractor" ], "items": { "type": "string" } }, "searchLocations": { "title": "Locations", "type": "array", "description": "US cities or areas to search, e.g. \"New York, NY\", \"Austin, TX\", \"Chicago, IL\". Required when Business Search is on.", "default": [ "New York, NY" ], "items": { "type": "string" } }, "searchMaxResults": { "title": "Max results per term + location", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum businesses collected for each term/location pair (1–200). Default 10 — perfect for instant demo runs.", "default": 10 }, "searchFetchFullDetails": { "title": "Enrich with full business details", "type": "boolean", "description": "When on, each search result stays ONE row (featureType business_search, detailsFetched=true) but is enriched with the business's full profile: opening hours, payment options, extra phone numbers, social profiles, coordinates, and full categories. Adds a little extra time per record. Every discovered business is always saved — never filtered out.", "default": false }, "enrichLeadDetails": { "title": "Add lead details (emails & socials)", "type": "boolean", "description": "When on, each business keeps ONE row (leadEnriched=true) and gains public contact details from the business's own website — email addresses and social profiles (Facebook, Instagram, LinkedIn, X, YouTube, TikTok). Phone and website from the directory are always kept. Adds a little extra time per record. Every business is saved whether or not extra details are found.", "default": false }, "leadDetailsSiteLookups": { "title": "Extra pages checked per business website", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many additional pages (contact, about, team) to check on a business's own website when the homepage carries no email. 1–6, default 3.", "default": 3 }, "enableBusinessDetails": { "title": "Business Details", "type": "boolean", "description": "Fetch the full profile for specific Citysearch businesses by URL — description, hours, payment options, extra phones, social profiles, coordinates, and ratings.", "default": false }, "businessUrls": { "title": "Business URLs", "type": "array", "description": "Full Citysearch business page URLs, e.g. https://www.citysearch.com/profile/18581644", "default": [], "items": { "type": "string" } }, "enableReviews": { "title": "Reviews & Ratings", "type": "boolean", "description": "Collect public customer reviews and star ratings for specific businesses — reviewer name, rating, date, review text, and source.", "default": false }, "reviewBusinessUrls": { "title": "Business URLs", "type": "array", "description": "Citysearch business page URLs to collect reviews for, e.g. https://www.citysearch.com/profile/18581644", "default": [], "items": { "type": "string" } }, "maxReviewsPerBusiness": { "title": "Max reviews per business", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum reviews to collect for each business (1–100). Default 10.", "default": 10 }, "enableScrapeByUrl": { "title": "Scrape By URL", "type": "boolean", "description": "Paste any Citysearch URL — a business page, a search results page, or a city/category page.", "default": false }, "scrapeUrls": { "title": "Citysearch URLs", "type": "array", "description": "Any Citysearch business, search, or city/category URL.", "default": [], "items": { "type": "string" } }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Every record is always saved to the run dataset — this webhook is an ADDITIONAL real-time push. Each new row is also POSTed to this URL (Slack, Discord, Zapier, Make, n8n, or your CRM).", "default": "" }, "webhookFormat": { "title": "Webhook format", "enum": [ "json", "slack" ], "type": "string", "description": "json = full record object; slack = Slack-friendly message payload.", "default": "json" }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Residential proxy recommended for the most reliable US local-business results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }