{
  "openapi": "3.0.1",
  "info": {
    "title": "Angi Scraper | Contractors, Reviews & Public Contacts",
    "description": "Extract public Angi contractor listings, ratings, available addresses and reviews by US ZIP, plus supported HomeStars and European profiles. Pay per delivered row plus a start fee; US contractor phones are usually unavailable.",
    "version": "0.2",
    "x-build-id": "dK2Xw3ARaKyCGqMcg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lentic_clockss~angi-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lentic_clockss-angi-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/lentic_clockss~angi-scraper/runs": {
      "post": {
        "operationId": "runs-sync-lentic_clockss-angi-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/lentic_clockss~angi-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-lentic_clockss-angi-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",
        "properties": {
          "searchType": {
            "title": "Search type",
            "enum": [
              "nearme",
              "search",
              "detail",
              "contact",
              "about",
              "intl-list",
              "intl-catalog",
              "intl-service-pro",
              "intl-detail",
              "homestars",
              "catalog",
              "sitemap",
              "map",
              "city-hub",
              "leads-funnel",
              "fake-tld"
            ],
            "type": "string",
            "description": "Choose near-me listings, US category search, supported profiles, company pages, catalogs or sitemaps. Map, city hub, quote request and other Angi country-domain modes are not available.",
            "default": "nearme"
          },
          "detailUrls": {
            "title": "Detail URLs",
            "type": "array",
            "description": "Supported Angi or international marketplace page URLs, including profiles and company pages. URLs take priority over search settings; a US profile can produce a contractor row plus separate review rows within the row limit."
          },
          "slice": {
            "title": "Built-in service or city choice",
            "type": "string",
            "description": "Built-in service or city choice such as us/plumbing or ca/toronto; a bare name uses the selected market. It replaces the US category or international city, but does not change searchType."
          },
          "category": {
            "title": "Near-me service category",
            "type": "string",
            "description": "Service slug from an Angi near-me URL, such as hvac, roofing or plumbing. For US search, set the correct categoryId as well; 107 is plumbing."
          },
          "categoryId": {
            "title": "US search category ID",
            "type": "integer",
            "description": "Numeric category for US search, such as 107 for plumbing. Set it for your trade and choose searchType=search; entering this field alone does not select that mode."
          },
          "postalCode": {
            "title": "US postal code",
            "pattern": "^(\\d{5}(-\\d{4})?)?$",
            "type": "string",
            "description": "US ZIP or ZIP+4; an explicit ZIP takes priority over city and region, while postalCode omitted or empty with a city uses one representative ZIP rather than covering the whole city. The form is prefilled with 10001: clear it for a city search; 10001 is used when no location is supplied."
          },
          "city": {
            "title": "City / international city slug",
            "type": "string",
            "description": "US city used with optional region when postalCode is omitted or empty, or the source site city slug for intl-list. An explicit postalCode takes priority for US searches."
          },
          "region": {
            "title": "US state / region",
            "type": "string",
            "description": "US state code or name, such as WA, used with city when postalCode is empty. A region without a city or ZIP is not accepted."
          },
          "query": {
            "title": "Search query",
            "type": "string",
            "description": "Text for selecting category catalog entries when searchType=catalog. For US contractor search, use categoryId and postalCode rather than relying on this text as a filter."
          },
          "serviceProSlug": {
            "title": "ServicePro slug",
            "type": "string",
            "description": "Single merchant slug for searchType=intl-service-pro (e.g. 217845-new-canadian-drain-plumbing-ltd). Leave empty to enumerate the market's ServicePro directory instead of fetching one merchant."
          },
          "market": {
            "title": "Market",
            "enum": [
              "us",
              "ca",
              "uk",
              "de",
              "at",
              "fr",
              "nl",
              "it"
            ],
            "type": "string",
            "description": "Select the marketplace: Angi in the US; HomeStars in Canada; MyBuilder in the UK; MyHammer in Germany or Austria; Travaux in France; Werkspot in the Netherlands; Instapro in Italy.",
            "default": "us"
          },
          "maxResults": {
            "title": "Max results per search or detail URL",
            "minimum": 1,
            "maximum": 70,
            "type": "integer",
            "description": "Maximum rows for each category/ZIP search or detail URL, from 1 to 70. Default 70; contractor and review rows share this allowance. The whole run also stops at your maximum total charge. Free Apify plan users have developer-set limits of 200 rows per run and 10 runs of this Actor.",
            "default": 70
          },
          "maxPages": {
            "title": "Max pages",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "No longer used. Delivered rows follow maxResults only."
          },
          "wantsPhone": {
            "title": "Request phone disclosure",
            "type": "boolean",
            "description": "For US search, ask the gateway for its contact field block. On requests large enough to cover a full result page the gateway returns a shared call-tracking number per business (not a direct line). Off by default; only applies to US category search.",
            "default": false
          },
          "ssaFilter": {
            "title": "Super Service Award filter",
            "type": "boolean",
            "description": "Limit US category search to businesses with the Super Service Award. This filter does not apply to other modes.",
            "default": false
          },
          "enrichDetails": {
            "title": "Enrich details",
            "type": "boolean",
            "description": "Add available public profile fields to listing rows. Off by default; inaccessible profiles can leave the original listing unchanged.",
            "default": false
          },
          "mergeNearmeStreets": {
            "title": "Merge nearme streets onto search",
            "type": "boolean",
            "description": "For US search, add published street addresses from matching near-me listings using the category slug. Enabled by default; an unavailable near-me page can leave the street empty.",
            "default": true
          },
          "catalogKind": {
            "title": "Catalog kind",
            "enum": [
              "categories",
              "businessHighlights",
              "featureflags",
              "platformConfig",
              "category-sitemap",
              "pro-pool"
            ],
            "type": "string",
            "description": "For catalog, select categories, businessHighlights, featureflags or platformConfig. For sitemap, select category-sitemap or pro-pool; pro-pool returns profile URLs, not profile content."
          },
          "sitemapShard": {
            "title": "Sitemap shard",
            "minimum": 1,
            "maximum": 71,
            "type": "integer",
            "description": "Provider sitemap part from 1 to 71, used with searchType=sitemap and catalogKind=pro-pool. The first part is used when omitted."
          },
          "harvestSeeds": {
            "title": "Save discovered service and city choices",
            "type": "boolean",
            "description": "Save service slugs, cities and category IDs discovered during the run for later reuse. Off by default; this does not guarantee additional output rows.",
            "default": false
          },
          "workerBaseUrl": {
            "title": "Developer testing",
            "type": "string",
            "description": "Leave empty. Used only by the developer for testing."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}