{ "openapi": "3.0.1", "info": { "title": "Website Metadata Extractor(sitemap, socialLinks, robotsTxt)", "description": "A fast metadata extractor for all meta tags, robots.txt, sitemaps, 15+ social links, H1s, word count, JSON-LD data, contacts & technology detection. Now with AI business & industry classification. Pay-per-event from $1/1k domains with zero server rental.", "version": "1.0", "x-build-id": "bpaizfrJd5aythrRN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codescraper~website-metadata-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codescraper-website-metadata-extractor", "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/codescraper~website-metadata-extractor/runs": { "post": { "operationId": "runs-sync-codescraper-website-metadata-extractor", "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/codescraper~website-metadata-extractor/run-sync": { "post": { "operationId": "run-sync-codescraper-website-metadata-extractor", "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" ], "properties": { "startUrls": { "title": "Target Website URLs", "type": "array", "description": "List of website URLs or domains (e.g. 'apify.com', 'https://shopify.com', 'www.google.com'). Any format is supported.", "items": { "type": "string" } }, "disableDomainAnalysis": { "title": "Fast Mode (Skip robots.txt & Sitemaps)", "type": "boolean", "description": "If enabled, the actor will skip external robots.txt and sitemap.xml resolution, analyzing only the on-page HTML for maximum extraction speed.", "default": false }, "maxConcurrency": { "title": "Max Parallel Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of domains processed simultaneously. Optimized for high-throughput multi-domain crawling.", "default": 20 }, "extractMetaTags": { "title": "Extract Meta Tags & SEO Elements", "type": "boolean", "description": "Extracts title, description, canonical, charset, viewport, OpenGraph, Twitter Cards, theme color, icons, and verification tags.", "default": true }, "extractRobotsTxt": { "title": "Extract robots.txt Rules", "type": "boolean", "description": "Fetches and parses robots.txt into structured per-user-agent allow/disallow rules.", "default": true }, "extractSitemaps": { "title": "Discover & Validate Sitemaps", "type": "boolean", "description": "Extracts sitemap URLs from robots.txt and verifies the standard /sitemap.xml location.", "default": true }, "extractSocialLinks": { "title": "Extract Verified Social Profiles", "type": "boolean", "description": "Performs multi-engine deep scanning across DOM, headers, footers, JSON-LD, and scripts for brand social profiles.", "default": true }, "extractTechnologies": { "title": "Detect Technology Stack", "type": "boolean", "description": "Detects CMS (WordPress, Shopify, Wix), Frameworks (React, Next.js, Vue, Nuxt), Analytics, and Web Tools.", "default": true }, "extractHeadings": { "title": "Extract Content Headings (H1, H2, H3)", "type": "boolean", "description": "Extracts primary H1, all H1s, all H2s, and all H3 tags for on-page SEO content hierarchy analysis.", "default": true }, "extractJsonLd": { "title": "Extract JSON-LD Structured Data", "type": "boolean", "description": "Parses all Schema.org structured data blocks (Organization, Product, WebSite, FAQ, Article, etc.).", "default": true }, "extractHreflang": { "title": "Extract Hreflang Alternates", "type": "boolean", "description": "Extracts international alternate language and regional URL definitions.", "default": true }, "extractContentMetrics": { "title": "Extract Content Word & Char Counts", "type": "boolean", "description": "Calculates total visible body word count, character count, and language declaration.", "default": true }, "socialPlatforms": { "title": "Target Social Media Platforms", "type": "array", "description": "Select the social media networks to target for extraction.", "items": { "type": "string", "enum": [ "facebook", "twitter", "linkedin", "instagram", "youtube", "tiktok", "pinterest", "reddit", "github", "discord", "telegram", "whatsapp", "snapchat", "threads", "medium" ], "enumTitles": [ "๐Ÿ“˜ Facebook", "๐Ÿชถ Twitter (X)", "๐Ÿ’ผ LinkedIn", "๐Ÿ“ธ Instagram", "โ–ถ๏ธ YouTube", "๐ŸŽต TikTok", "๐Ÿ“Œ Pinterest", "๐Ÿค– Reddit", "๐Ÿ™ GitHub", "๐Ÿ’ฌ Discord", "โœˆ๏ธ Telegram", "๐Ÿ’ฌ WhatsApp", "๐Ÿ‘ป Snapchat", "๐Ÿงต Threads", "โœ๏ธ Medium" ] } }, "includeContactInfo": { "title": "Extract Email & Phone Numbers", "type": "boolean", "description": "If enabled, discovers mailto: email addresses and tel: phone links.", "default": false }, "enableAiClassification": { "title": "Enable AI Nature of Business & Company Intelligence", "type": "boolean", "description": "When enabled, uses high-speed Groq AI (openai/gpt-oss-120b) to extract full company intelligence (industry, summary, B2B/B2C, business model, ICP, core offerings, stage, compliance signals) into the natureOfBusiness field.", "default": false }, "groqApiKey": { "title": "Groq API Key (Optional)", "type": "string", "description": "Optional: Your Groq API key from console.groq.com. If omitted, the Actor will use the GROQ_API_KEY environment variable configured in your Apify Console." }, "customIndustries": { "title": "Custom Allowed Industries (Optional)", "type": "array", "description": "Optional: Custom list of industries for AI classification. If left empty, the standard list of 100+ global industries is used.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }