{ "openapi": "3.0.1", "info": { "title": "GoodFirms Scraper — Global B2B Agencies API", "description": "Scrape GoodFirms.co B2B IT & agency directory listings across categories and countries into JSON. Global GoodFirms companies scraper API. CheerioCrawler. PPE $1.20/1k.", "version": "1.0", "x-build-id": "PPeGsU4CMBu3NiBMi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/umararshad2~goodfirms-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-umararshad2-goodfirms-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/umararshad2~goodfirms-scraper/runs": { "post": { "operationId": "runs-sync-umararshad2-goodfirms-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/umararshad2~goodfirms-scraper/run-sync": { "post": { "operationId": "run-sync-umararshad2-goodfirms-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": { "category": { "title": "Directory category", "type": "string", "description": "GoodFirms directory slug used when startUrls is empty. Examples: software-development, web-development, mobile-app-development, digital-marketing, web-design, it-services, artificial-intelligence, seo. Builds https://www.goodfirms.co/directory/languages/top-{category}-companies (or the matching services path).", "default": "software-development" }, "country": { "title": "Country filter", "type": "string", "description": "Optional ISO-ish country slug for directory/country/… URLs (us, gb, de, ca, au, in, pl, ua, …). Leave empty for the global category listing." }, "startUrls": { "title": "Directory / company URLs", "type": "array", "description": "Optional GoodFirms directory URLs (category, country, language, framework) or /company/{slug} profile URLs. When set, these are crawled instead of (or in addition to) category+country.", "items": { "type": "string" } }, "maxCompanies": { "title": "Max companies", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on companies written to the dataset (after dedupe). Default 100, maximum 5000.", "default": 100 }, "maxPages": { "title": "Max directory pages", "minimum": 1, "maximum": 100, "type": "integer", "description": "Max paginated directory pages to crawl per start URL (page=1,2,…). Default 5.", "default": 5 }, "includeProfileDetails": { "title": "Enrich from company profile", "type": "boolean", "description": "When true, fetch each /company/{slug} profile for website, founding year, phone, emails, social links, and employee band. When false, emit directory JSON-LD fields only (faster).", "default": true }, "useMockData": { "title": "Use mock / fixture data", "type": "boolean", "description": "Force fixture mode (no live GoodFirms calls). Useful for local CI. Auto-fallback also engages if directory pages are blocked.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Directory JSON-LD often works with datacenter; profile pages may need RESIDENTIAL if challenged. Default enables Apify Proxy (auto).", "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 }, "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 } } } } } } } } } }