{ "openapi": "3.0.1", "info": { "title": "Local Schema Generator", "description": "Generate Schema.org JSON-LD structured data to improve search visibility & enable rich results. Structured data helps search engines understand your business. Stars, hours & contact info in search results, improved business information display, better answers for voice assistants, enhanced local SEO", "version": "1.1", "x-build-id": "Xicd6KAxQcQWPjj7A" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~local-schema-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-local-schema-generator", "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~local-schema-generator/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-local-schema-generator", "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~local-schema-generator/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-local-schema-generator", "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": { "businessName": { "title": "Business Name", "type": "string", "description": "Your official business name" }, "businessType": { "title": "Business Type", "type": "string", "description": "Type of business (e.g., 'Plumber', 'Restaurant', 'Dentist') - auto-mapped to schema.org type" }, "streetAddress": { "title": "Street Address", "type": "string", "description": "Business street address" }, "city": { "title": "City", "type": "string", "description": "City name" }, "state": { "title": "State", "type": "string", "description": "State/region code" }, "zipCode": { "title": "ZIP/Postal Code", "type": "string", "description": "ZIP or postal code" }, "country": { "title": "Country", "type": "string", "description": "Country code (default: US)", "default": "US" }, "phone": { "title": "Phone Number", "type": "string", "description": "Primary business phone" }, "website": { "title": "Website URL", "type": "string", "description": "Your business website" }, "email": { "title": "Email", "type": "string", "description": "Business email address" }, "description": { "title": "Business Description", "type": "string", "description": "Brief description of your business (recommended: 150-300 characters)" }, "latitude": { "title": "Latitude", "type": "number", "description": "GPS latitude coordinate" }, "longitude": { "title": "Longitude", "type": "number", "description": "GPS longitude coordinate" }, "hours": { "title": "Business Hours", "type": "object", "description": "Operating hours for each day (e.g., '9am-5pm' or '09:00-17:00')" }, "priceRange": { "title": "Price Range", "type": "string", "description": "Price range indicator (e.g., '$', '$$', '$$$')" }, "aggregateRating": { "title": "Aggregate Rating", "type": "object", "description": "Overall business rating" }, "logoUrl": { "title": "Logo URL", "type": "string", "description": "URL to your business logo (min 112x112px)" }, "imageUrl": { "title": "Main Image URL", "type": "string", "description": "URL to your main business image" }, "facebookUrl": { "title": "Facebook URL", "type": "string", "description": "Facebook business page URL" }, "twitterUrl": { "title": "Twitter/X URL", "type": "string", "description": "Twitter/X profile URL" }, "instagramUrl": { "title": "Instagram URL", "type": "string", "description": "Instagram profile URL" }, "linkedinUrl": { "title": "LinkedIn URL", "type": "string", "description": "LinkedIn company page URL" }, "yelpUrl": { "title": "Yelp URL", "type": "string", "description": "Yelp business page URL" }, "includeOrganization": { "title": "Include Organization Schema", "type": "boolean", "description": "Generate Organization schema in addition to LocalBusiness", "default": true }, "includeLocalBusiness": { "title": "Include LocalBusiness Schema", "type": "boolean", "description": "Generate LocalBusiness schema (recommended)", "default": true }, "includeWebSite": { "title": "Include WebSite Schema", "type": "boolean", "description": "Generate WebSite schema with search action", "default": true }, "includeBreadcrumb": { "title": "Include Breadcrumb Schema", "type": "boolean", "description": "Generate BreadcrumbList schema", "default": false }, "includeFAQPage": { "title": "Include FAQ Schema", "type": "boolean", "description": "Generate FAQPage schema (requires FAQs)", "default": false }, "faqs": { "title": "FAQs", "type": "array", "description": "Questions and answers for FAQ schema" }, "includeService": { "title": "Include Service Schema", "type": "boolean", "description": "Generate Service/OfferCatalog schema (requires services)", "default": false }, "services": { "title": "Services Offered", "type": "array", "description": "List of services for Service schema" }, "outputFormat": { "title": "Output Format", "enum": [ "script_tag", "json", "both" ], "type": "string", "description": "How to format the output", "default": "both" }, "minify": { "title": "Minify Output", "type": "boolean", "description": "Remove whitespace from JSON output", "default": false }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run in demo mode without real credentials. Returns mock success response for testing.", "default": true }, "webhookUrl": { "title": "Webhook URL", "pattern": "^https?://.*", "type": "string", "description": "Optional URL to receive results via POST request when actor completes" } } }, "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 } } } } } } } } } }