{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenSooq Scraper | Cars, Real Estate & More (20 Countries)",
    "description": "Scrape OpenSooq listings across Saudi Arabia, UAE, Jordan, Egypt and 16 more MENA countries. 55 fields per listing: price, location, seller details, structured attributes, AI tags, images. Cars, real estate, electronics, jobs. Filter by city, category, price range. No login required.",
    "version": "0.0",
    "x-build-id": "CCR3SXaTFA2f8qWUm"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zen-studio~opensooq-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zen-studio-opensooq-scraper",
        "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/zen-studio~opensooq-scraper/runs": {
      "post": {
        "operationId": "runs-sync-zen-studio-opensooq-scraper",
        "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/zen-studio~opensooq-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-zen-studio-opensooq-scraper",
        "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": [
          "site"
        ],
        "properties": {
          "site": {
            "title": "Site / Country",
            "enum": [
              "jo",
              "sa",
              "ae",
              "kw",
              "bh",
              "om",
              "qa",
              "iq",
              "eg",
              "ye",
              "ly",
              "sd",
              "lb",
              "ps",
              "sy",
              "dz",
              "ma",
              "tn",
              "tr",
              "mr"
            ],
            "type": "string",
            "description": "Which OpenSooq country site to scrape",
            "default": "sa"
          },
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Text to search for (e.g., 'iphone', 'apartment', 'bmw'). Leave empty to browse all listings."
          },
          "category": {
            "title": "Category",
            "enum": [
              "",
              "1775",
              "5505",
              "2143",
              "13741",
              "2131",
              "7713",
              "8035",
              "2181",
              "54963",
              "54965",
              "7105",
              "88",
              "15981",
              "4275",
              "15061",
              "15101",
              "5141"
            ],
            "type": "string",
            "description": "Filter by category. Leave empty for all categories.",
            "default": ""
          },
          "city": {
            "title": "City",
            "type": "string",
            "description": "City name (e.g., 'Amman', 'Riyadh', 'عمان') or numeric city ID. Leave empty for all cities. See README for full city ID list."
          },
          "neighborhood": {
            "title": "Neighborhood",
            "type": "string",
            "description": "Neighborhood name or numeric ID. Requires a city to be set. Leave empty for all neighborhoods. See README for ID reference."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "recent",
              "default",
              "price-",
              "price+"
            ],
            "type": "string",
            "description": "Sort order for results",
            "default": "recent"
          },
          "priceFrom": {
            "title": "Minimum price",
            "type": "integer",
            "description": "Minimum price filter. Optional."
          },
          "priceTo": {
            "title": "Maximum price",
            "type": "integer",
            "description": "Maximum price filter. Optional."
          },
          "hasImages": {
            "title": "Has images only",
            "type": "boolean",
            "description": "Only return listings that have images",
            "default": false
          },
          "hasPrice": {
            "title": "Has price only",
            "type": "boolean",
            "description": "Only return listings that have a listed price",
            "default": false
          },
          "isShop": {
            "title": "Shop listings only",
            "type": "boolean",
            "description": "Only return listings from shops/businesses",
            "default": false
          },
          "fetchDetails": {
            "title": "Fetch full details",
            "type": "boolean",
            "description": "Fetch detail page for each listing to get full description and all images. Slower but more complete data.",
            "default": true
          },
          "maxItems": {
            "title": "Maximum results",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Maximum number of listings to scrape",
            "default": 100
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy to use for requests. Residential proxy recommended for reliable results."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}