{
  "openapi": "3.0.1",
  "info": {
    "title": "OBI Germany Product Scraper",
    "description": "Extract OBI Germany products, prices, availability, stores, and structured product details for monitoring, analysis, and data workflows.",
    "version": "0.2",
    "x-build-id": "fjVotDXVX0Agai8cd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dromb~obi-germany/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dromb-obi-germany",
        "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/dromb~obi-germany/runs": {
      "post": {
        "operationId": "runs-sync-dromb-obi-germany",
        "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/dromb~obi-germany/run-sync": {
      "post": {
        "operationId": "run-sync-dromb-obi-germany",
        "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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "item",
              "availability",
              "store",
              "stores"
            ],
            "type": "string",
            "description": "Single logical mode per run.",
            "default": "search"
          },
          "query": {
            "title": "Query",
            "maxLength": 200,
            "type": "string",
            "description": "Product keyword for search mode."
          },
          "maxResults": {
            "title": "Max Results",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum number of product rows to return."
          },
          "maxPages": {
            "title": "Max Pages",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Maximum number of search result pages to request."
          },
          "pageStart": {
            "title": "Page Start",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "First search page to request."
          },
          "storeNumber": {
            "title": "Store Number",
            "pattern": "^[0-9]{1,6}$",
            "type": "string",
            "description": "Public OBI store number, for example 374. Internal store identifiers are output metadata only."
          },
          "includeSponsored": {
            "title": "Include Sponsored",
            "type": "boolean",
            "description": "Keep sponsored rows (always tagged via isSponsored)."
          },
          "includeFilters": {
            "title": "Include Filters",
            "type": "boolean",
            "description": "Include parsed search filter metadata when available."
          },
          "includeItemDetails": {
            "title": "Include Item Details",
            "type": "boolean",
            "description": "Enrich search results with product detail page data. This performs an additional request per product."
          },
          "includeAvailability": {
            "title": "Include Availability",
            "type": "boolean",
            "description": "Enrich rows with availability (requires postalCodes)."
          },
          "postalCodes": {
            "title": "Postal Codes",
            "maxItems": 50,
            "type": "array",
            "description": "German postcodes. At least one is required when availability enrichment is enabled; maximum 50.",
            "items": {
              "type": "string",
              "pattern": "^[0-9]{5}$"
            }
          },
          "quantity": {
            "title": "Quantity",
            "minimum": 1,
            "maximum": 999,
            "type": "integer",
            "description": "Requested product quantity for availability checks."
          },
          "products": {
            "title": "Products",
            "minItems": 1,
            "maxItems": 1000,
            "type": "array",
            "description": "Products for item or availability mode. Each entry must contain exactly one OBI article ID or OBI Germany product URL; maximum 1,000.",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "articleId": {
                  "type": "string",
                  "pattern": "^[0-9]{4,12}$",
                  "description": "OBI article number. NOT a guaranteed EAN.",
                  "title": "Article Id"
                },
                "productUrl": {
                  "type": "string",
                  "pattern": "^https://www\\.obi\\.de/p/[0-9]+/.+$",
                  "description": "Approved OBI Germany PDP host+path only.",
                  "title": "Product Url"
                }
              }
            }
          },
          "postalCode": {
            "title": "Postal Code",
            "pattern": "^[0-9]{5}$",
            "type": "string",
            "description": "Single DE postal code filter (stores mode)."
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "DE city filter (stores mode)."
          },
          "state": {
            "title": "State",
            "type": "string",
            "description": "DE state filter (stores mode)."
          },
          "latitude": {
            "title": "Latitude",
            "type": "string",
            "description": "Latitude for stores mode. Enter a decimal number as text, for example 48.1372."
          },
          "longitude": {
            "title": "Longitude",
            "type": "string",
            "description": "Longitude for stores mode. Enter a decimal number as text, for example 11.5756."
          },
          "radiusKm": {
            "title": "Radius Km",
            "type": "string",
            "description": "Search radius in kilometres. Enter a decimal number as text."
          },
          "services": {
            "title": "Services",
            "type": "array",
            "description": "Optional store service filters.",
            "items": {
              "type": "string"
            }
          },
          "activeOnly": {
            "title": "Active Only",
            "type": "boolean",
            "description": "Return only active stores."
          },
          "maxStores": {
            "title": "Max Stores",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum number of stores to return."
          },
          "includeOpeningHours": {
            "title": "Include Opening Hours",
            "type": "boolean",
            "description": "Include ordinary opening hours."
          },
          "includeSpecialOpeningHours": {
            "title": "Include Special Opening Hours",
            "type": "boolean",
            "description": "Include special opening hours."
          },
          "concurrency": {
            "title": "Concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum number of concurrent requests.",
            "default": 4
          },
          "retries": {
            "title": "Retries",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Number of retries for temporary upstream failures.",
            "default": 2
          },
          "requestTimeoutSecs": {
            "title": "Request Timeout Secs",
            "minimum": 5,
            "maximum": 60,
            "type": "integer",
            "description": "Timeout for each upstream request in seconds.",
            "default": 25
          },
          "debug": {
            "title": "Debug",
            "type": "boolean",
            "description": "Enable additional non-secret diagnostic logging.",
            "default": false
          },
          "proxy": {
            "title": "Proxy",
            "type": "object",
            "description": "Advanced access settings. Direct HTTP is used by default; Apify or custom proxy routing can be enabled when needed.",
            "properties": {
              "useApifyProxy": {
                "type": "boolean",
                "default": false,
                "title": "Use Apify Proxy",
                "description": "Route requests through Apify Proxy when direct access is unavailable."
              },
              "apifyProxyGroups": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "default": [],
                "description": "Optional Apify Proxy groups. Leave empty to use the default datacenter group.",
                "title": "Apify Proxy Groups"
              },
              "proxyCountryCode": {
                "type": "string",
                "default": "DE",
                "title": "Proxy Country Code",
                "description": "Two-letter country code used for location-aware proxy routing."
              },
              "proxyUrls": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "default": [],
                "description": "Custom proxy URLs. Credentials are redacted from logs and request summaries.",
                "title": "Proxy Urls"
              },
              "accessMethodPriority": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "DIRECT_HTTP",
                    "DATACENTER",
                    "RESIDENTIAL",
                    "CUSTOM",
                    "BROWSER_FALLBACK"
                  ]
                },
                "default": [
                  "DIRECT_HTTP",
                  "DATACENTER",
                  "RESIDENTIAL",
                  "CUSTOM"
                ],
                "title": "Access Method Priority",
                "description": "Ordered access methods to try when a request is blocked or unavailable.",
                "editor": "select"
              },
              "allowedProxyFallbacks": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "DATACENTER",
                    "RESIDENTIAL",
                    "CUSTOM",
                    "BROWSER_FALLBACK"
                  ]
                },
                "default": [
                  "DATACENTER",
                  "RESIDENTIAL",
                  "CUSTOM"
                ],
                "title": "Allowed Proxy Fallbacks",
                "description": "Proxy methods that may be used after the preferred access method fails.",
                "editor": "select"
              },
              "browserFallbackEnabled": {
                "type": "boolean",
                "default": false,
                "description": "Enable browser-based fallback for pages that cannot be retrieved through HTTP access methods.",
                "title": "Browser Fallback Enabled"
              }
            },
            "default": {},
            "additionalProperties": false
          },
          "proxyConfiguration": {
            "title": "Apify proxy configuration",
            "type": "object",
            "description": "Standard Apify proxy selector. When advanced proxy is also provided, advanced proxy takes precedence. Direct HTTP remains the default.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}