{ "openapi": "3.0.1", "info": { "title": "Canadian Trade Leads with Emails", "description": "Canadian trade and home-service businesses by city and by trade, each with the contact email published on its own website. Garage doors, landscaping, plumbing, roofing, HVAC, electrical and thirty more. You are charged only for a lead that carries an address.", "version": "0.1", "x-build-id": "3iv3ffWHt0EMRG0cQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shimon_ben-el~canadian-trade-leads-with-emails/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shimon_ben-el-canadian-trade-leads-with-emails", "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/shimon_ben-el~canadian-trade-leads-with-emails/runs": { "post": { "operationId": "runs-sync-shimon_ben-el-canadian-trade-leads-with-emails", "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/shimon_ben-el~canadian-trade-leads-with-emails/run-sync": { "post": { "operationId": "run-sync-shimon_ben-el-canadian-trade-leads-with-emails", "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": [ "city", "trades" ], "properties": { "city": { "title": "City", "type": "string", "description": "A Canadian city, e.g. Calgary, Edmonton, Mississauga. Write it as \"Kelowna, BC\" if the city name is ambiguous." }, "province": { "title": "Province", "type": "string", "description": "Two-letter province code. Only needed for a city this Actor does not already know, or to settle a duplicate name." }, "trades": { "title": "Trades", "type": "array", "description": "One or more trades, e.g. garage doors, landscaping, plumbing, roofing, hvac, electrical. Anything not on the built-in list is searched as you type it.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 2000, "type": "integer", "description": "A ceiling on rows returned and charged, across all trades.", "default": 50 }, "requireEmail": { "title": "Only businesses with a published email", "type": "boolean", "description": "On: a business whose site publishes no address is skipped and never charged. Off: it is returned with an empty email field at the lower listing price.", "default": true }, "requestDelaySecs": { "title": "Delay between requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "Politeness to the sources. Lower is faster and ruder.", "default": 2 }, "concurrency": { "title": "Business sites at a time", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many different business websites are read at once. Each site still sees its own delay.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The directory sits behind a CDN that can refuse a datacenter address. If a run comes back empty, turn on Apify Proxy with residential IPs in Canada.", "default": { "useApifyProxy": 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 } } } } } } } } } }