{ "openapi": "3.0.1", "info": { "title": "OSM Local Business Lead Finder", "description": "Vertical-specific, contact-enriched lead lists from OpenStreetMap instead of Google Maps. No per-listing scraping fees.", "version": "1.0", "x-build-id": "WtX1zRbGyqu39gS1e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hereditary_model~osm-lead-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hereditary_model-osm-lead-finder", "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/hereditary_model~osm-lead-finder/runs": { "post": { "operationId": "runs-sync-hereditary_model-osm-lead-finder", "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/hereditary_model~osm-lead-finder/run-sync": { "post": { "operationId": "run-sync-hereditary_model-osm-lead-finder", "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": [ "locations" ], "properties": { "vertical": { "title": "Trade vertical", "enum": [ "contractors", "dental", "real_estate", "legal", "medspa", "auto", "fitness", "home_services" ], "type": "string", "description": "Which kind of business to search for. Ignored if you supply your own OSM tags.", "default": "contractors" }, "customTags": { "title": "Custom OSM tags", "type": "array", "description": "Overrides the vertical preset. Each entry is key=value, for example shop=bakery. Uses OpenStreetMap's tagging scheme.", "default": [], "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Coordinates to search around, one per line, as \"lat,lon\" — for example 35.5951,-82.5515 for Asheville, NC. Right-click any point on openstreetmap.org or Google Maps to copy coordinates.", "items": { "type": "string" } }, "radiusMeters": { "title": "Search radius (meters)", "minimum": 200, "maximum": 25000, "type": "integer", "description": "How far from each location's center point to search.", "default": 6000 }, "maxLeads": { "title": "Maximum qualified leads", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard ceiling on billable rows returned.", "default": 200 }, "enrichContacts": { "title": "Enrich from business websites", "type": "boolean", "description": "Visits each business site to pull email addresses and social profiles.", "default": true }, "enrichmentActorId": { "title": "Enrichment actor", "type": "string", "description": "Actor used for website contact extraction.", "default": "vdrmota/contact-info-scraper" }, "requirePhone": { "title": "Require a phone number", "type": "boolean", "description": "Drop any row that doesn't have a phone number, before billing.", "default": false }, "requireWebsite": { "title": "Require a website", "type": "boolean", "description": "Drop any row that doesn't have a website, before billing.", "default": false }, "requireEmail": { "title": "Require an email address", "type": "boolean", "description": "Drop any row that doesn't have an enriched email address, before billing.", "default": false }, "minQualityScore": { "title": "Minimum quality score", "minimum": 0, "maximum": 100, "type": "integer", "description": "0 to 100. Rows below this are dropped and never billed.", "default": 0 }, "requesterEmail": { "title": "Your contact email", "type": "string", "description": "OpenStreetMap's Overpass service requests a real contact in the request User-Agent for automated access. Used only in that header, never stored or shared.", "default": "" } } }, "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 } } } } } } } } } }