{ "openapi": "3.0.1", "info": { "title": "Goodfirms Agency Scraper - B2B Leads, Emails & Reviews", "description": "Extracts CRM-ready B2B agency leads from GoodFirms directory, category, country, and company profile pages. It can collect firmographics (hourly rate, team size, founding year, location), ratings and reviews, service focus, phone numbers, contact emails, and social profiles", "version": "0.0", "x-build-id": "C0erDvnPbGKSbhc7Y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hypebridge~goodfirms-agency-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hypebridge-goodfirms-agency-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/hypebridge~goodfirms-agency-scraper/runs": { "post": { "operationId": "runs-sync-hypebridge-goodfirms-agency-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/hypebridge~goodfirms-agency-scraper/run-sync": { "post": { "operationId": "run-sync-hypebridge-goodfirms-agency-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": [ "startUrls", "maxItems" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Goodfirms directory, country, filtered, paginated, or company profile URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max agency leads", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of agency records to return.", "default": 100 }, "getAgencyDetails": { "title": "Get agency details", "type": "boolean", "description": "Visit each Goodfirms profile for phone, email, address, socials, services, and richer reviews. Direct profile URLs always return detail records.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Fetch each agency's profile to collect recent reviews, even when Get agency details is off. Reviews live on profile pages, so this prices the row as a detailed lead. Detail runs always include reviews; set Max reviews per agency to 0 to skip them.", "default": false }, "enrichEmails": { "title": "Find emails on agency websites", "type": "boolean", "description": "If Goodfirms does not expose an email, run the Contact Details Scraper on the agency website. That scraper's pay-per-event usage is billed to your account on top of this actor's per-lead price.", "default": false }, "maxReviewsPerAgency": { "title": "Max reviews per agency", "minimum": 0, "maximum": 25, "type": "integer", "description": "Maximum reviews to collect for each agency when reviews are enabled.", "default": 3 }, "outputFormat": { "title": "Output format", "enum": [ "full", "flat", "hubspot", "salesforce" ], "type": "string", "description": "Full keeps nested JSON. Flat, HubSpot, and Salesforce produce CRM-friendly columns.", "default": "full" }, "sortBy": { "title": "Sort by", "enum": [ "default", "reviews", "rating", "matrix" ], "type": "string", "description": "Only applied when the actor builds the default Goodfirms category URL.", "default": "default" }, "maxPages": { "title": "Max listing pages", "minimum": 1, "maximum": 200, "type": "integer", "description": "Safety cap for listing pagination. The actor also stops when max agency leads is reached.", "default": 25 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum concurrent Goodfirms HTTP requests.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is enabled by default and required. Goodfirms blocks Apify datacenter IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "debugMode": { "title": "Debug mode", "type": "boolean", "description": "Save failed HTML responses and extra diagnostics to the key-value store.", "default": 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 } } } } } } } } } }