{
  "openapi": "3.0.1",
  "info": {
    "title": "Yello UAE Scraper - UAE Business Directory",
    "description": "Scrape Yello UAE (yello.ae), the UAE's largest business directory with 224,000+ companies. Search by category and/or emirate/city, or fetch full business profiles by URL. Get names, addresses, phone numbers, categories, ratings, working hours, and websites.",
    "version": "1.0",
    "x-build-id": "xvNl5nE5UoXzbHBP4"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/crawlerbros~yello-uae-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-crawlerbros-yello-uae-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/crawlerbros~yello-uae-scraper/runs": {
      "post": {
        "operationId": "runs-sync-crawlerbros-yello-uae-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/crawlerbros~yello-uae-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-crawlerbros-yello-uae-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": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "detail"
            ],
            "type": "string",
            "description": "What to fetch: search a category and/or city, or fetch full business profiles from direct yello.ae URLs.",
            "default": "search"
          },
          "category": {
            "title": "Category",
            "enum": [
              "custom",
              "",
              "others",
              "trading",
              "clothing-and-accessories",
              "food-retailers",
              "electrical-goods",
              "building-materials",
              "general-office-services",
              "restaurants",
              "advertising",
              "small-business",
              "vehicle-services",
              "home-and-garden",
              "construction-services",
              "estate-agents",
              "professional-services",
              "jewellery",
              "contractors",
              "car-parts-and-accessories",
              "gifts",
              "logistics",
              "industrial-equipment",
              "beauty-products",
              "building-maintenance",
              "textile",
              "transport-companies",
              "furniture",
              "overseas-business",
              "doctors-and-clinics",
              "chemicals",
              "communications",
              "car-rental",
              "industrial-services",
              "vehicle-sales",
              "travel-agents",
              "mobile-phone-shops",
              "computer-software",
              "handbagsleather-products",
              "carpentryflooring",
              "brokers",
              "plumbing-sanitary",
              "interior-design",
              "metal-products",
              "event-equipment",
              "roofing-materials-accessories",
              "web-development",
              "financial-activity",
              "hotels",
              "computer-services",
              "computer-equipment",
              "business-management-consulting",
              "construction-equipment",
              "farming",
              "online-content",
              "retail-services",
              "event-services",
              "web-design",
              "film-television-and-video",
              "secretarial-services",
              "procurement",
              "human-resources",
              "ships-boats",
              "electrical-fitting",
              "aluminium-openings",
              "beauty-professionals",
              "cleaning",
              "marketing",
              "cafes",
              "information-technology",
              "removals-and-relocation",
              "oil-natural-gas",
              "schools",
              "tour-operators",
              "arts-and-crafts",
              "software",
              "pharmacies",
              "electromechanical-equipment-installation",
              "architectural-services",
              "supermarkets",
              "chemicals-trading",
              "security",
              "medical-equipment",
              "computer-hardware",
              "banks-credit-unions",
              "management-consultants",
              "engineering",
              "decoration-materialspartitions",
              "industrial-supplies",
              "kids",
              "printing",
              "education",
              "consulting",
              "audit-and-accounting",
              "surveyors",
              "property-management-services",
              "investment-companies",
              "engineers",
              "marine-services",
              "hardware-stores-in-emirates",
              "handling-loadinglifting",
              "web-services",
              "networking",
              "photography",
              "dentists",
              "buses-rental",
              "real-estate-developers",
              "hairdressers",
              "sports",
              "shopping-centres",
              "auto-batteries",
              "lawyers"
            ],
            "type": "string",
            "description": "Business category to search for. Pick a common category, or choose 'Custom category' and type your own below (mode=search). Leave 'No category filter' + set a city to browse all businesses in that city.",
            "default": "restaurants"
          },
          "customCategory": {
            "title": "Custom category (overrides selection above)",
            "type": "string",
            "description": "Free-text category slug not in the curated list above, e.g. 'locksmiths' or 'it-services' (mode=search). Takes priority over 'Category' when set. Use the slug shown in a yello.ae category URL (lowercase, hyphenated)."
          },
          "city": {
            "title": "Emirate / city",
            "enum": [
              "",
              "dubai",
              "abu-dhabi",
              "sharjah",
              "al-ain",
              "ajman",
              "ras-al-khaimah",
              "jebel-ali-free-zone",
              "fujairah",
              "um-al-quwain",
              "dibba",
              "khor-fakkan"
            ],
            "type": "string",
            "description": "UAE emirate or city to search in. Combine with 'Category' to search a category within one city, or leave category empty to browse all businesses in the city (mode=search).",
            "default": ""
          },
          "customCity": {
            "title": "Custom city (overrides selection above)",
            "type": "string",
            "description": "Free-text city slug not in the curated list above (mode=search). Takes priority over 'Emirate / city' when set."
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "relevance",
              "rating",
              "name"
            ],
            "type": "string",
            "description": "How to order search results after fetching (mode=search). yello.ae itself only returns relevance order, so 'rating' and 'name' are applied client-side across the fetched batch.",
            "default": "relevance"
          },
          "verifiedOnly": {
            "title": "Verified businesses only",
            "type": "boolean",
            "description": "Only return businesses with yello.ae's own 'Verified' badge (mode=search).",
            "default": false
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Only return businesses rated at least this many stars, e.g. 4 for 4.0+ (mode=search). 0 means no minimum. Businesses with no rating are excluded once this is set above 0.",
            "default": 0
          },
          "fetchDetails": {
            "title": "Fetch full business profiles",
            "type": "boolean",
            "description": "For each search result, also visit its business profile page to collect full address, website, working hours, manager, establishment year, employee count, registration code, categories/tags, description, and photos. Slower -- one extra request per result (mode=search).",
            "default": false
          },
          "businessUrls": {
            "title": "Business profile URLs (mode=detail)",
            "type": "array",
            "description": "Direct yello.ae business profile URLs to fetch, e.g. https://www.yello.ae/company/344843/cafe-torino. Use the 'sourceUrl' field from search results.",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "title": "URL",
                  "type": "string",
                  "description": "yello.ae business profile URL."
                }
              }
            },
            "default": []
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Hard cap on the number of business records to return.",
            "default": 20
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}