{ "openapi": "3.0.1", "info": { "title": "Industry Research Suite - Market Intelligence API", "description": "Comprehensive industry research combining Google Trends, US Census Bureau, SBA.gov, IBISWorld & Statista. Get market size, growth rates, competitor analysis & AI-powered executive summaries for any industry or NAICS code.", "version": "1.0", "x-build-id": "Dtx1TAvsQb1cMryVG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~industry-research-suite/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-industry-research-suite", "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/alizarin_refrigerator-owner~industry-research-suite/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-industry-research-suite", "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/alizarin_refrigerator-owner~industry-research-suite/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-industry-research-suite", "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": { "industry": { "title": "Industry/Business Type", "type": "string", "description": "The industry or business category to research (e.g., 'Plumbing Services', 'Coffee Shops', 'Digital Marketing Agencies')" }, "naicsCode": { "title": "NAICS Code (optional)", "type": "string", "description": "North American Industry Classification System code for precise industry targeting" }, "location": { "title": "Geographic Location", "type": "string", "description": "City, state, or region to focus research on (e.g., 'Miami, FL', 'California', 'United States')", "default": "United States" }, "keywords": { "title": "Research Keywords", "type": "array", "description": "Additional keywords to include in trend analysis", "items": { "type": "string" } }, "dataSources": { "title": "Data Sources", "type": "object", "description": "Configure which data sources to include", "default": { "googleTrends": true, "censusBureau": true, "sba": true, "ibisworld": false, "statista": false } }, "googleTrendsTimeframe": { "title": "Google Trends Timeframe", "enum": [ "past_hour", "past_day", "past_week", "past_month", "past_year", "past_5_years" ], "type": "string", "description": "Time range for Google Trends data", "default": "past_year" }, "ibisWorldApiKey": { "title": "IBISWorld API Key (BYOK)", "type": "string", "description": "Your IBISWorld API key for premium industry reports. Get one at ibisworld.com/access/api/" }, "statistaApiKey": { "title": "Statista API Key (BYOK)", "type": "string", "description": "Your Statista API key for market data and statistics" }, "aiSummary": { "title": "Generate AI Summary", "type": "boolean", "description": "Generate an AI-powered executive summary of the research", "default": true }, "aiProvider": { "title": "AI Provider", "enum": [ "claude", "openai", "gemini" ], "type": "string", "description": "Which AI model to use for generating summaries", "default": "claude" }, "anthropicApiKey": { "title": "Anthropic API Key (Claude)", "type": "string", "description": "Your Anthropic API key for Claude AI summaries" }, "openaiApiKey": { "title": "OpenAI API Key (GPT-4)", "type": "string", "description": "Your OpenAI API key for GPT-4 summaries" }, "googleApiKey": { "title": "Google AI API Key (Gemini)", "type": "string", "description": "Your Google AI API key for Gemini summaries" }, "outputFormat": { "title": "Output Format", "enum": [ "json", "markdown", "html" ], "type": "string", "description": "Format for the research output", "default": "json" }, "reportType": { "title": "Report Type", "enum": [ "executive_summary", "full_report" ], "type": "string", "description": "Choose between a concise executive summary or comprehensive full report. Both options combine all selected data sources into one unified AI-powered report.", "default": "full_report" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Send the completed report to this webhook URL. Works seamlessly with Zapier, Make (Integromat), n8n, or any custom endpoint." }, "webhookPlatform": { "title": "Webhook Platform", "enum": [ "zapier", "make", "n8n", "custom" ], "type": "string", "description": "Which platform is receiving the webhook (helps format the payload correctly)", "default": "custom" }, "webhookHeaders": { "title": "Custom Webhook Headers", "type": "object", "description": "Optional custom headers to include with webhook request (e.g., API keys, authentication tokens)" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data to test the actor without API keys", "default": 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 } } }, "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 } } } } } } } } } }