Map a website's URLs

{
  "operationId": "map",
  "method": "post",
  "path": "/map",
  "summary": "Map a website's URLs",
  "description": "Returns a list of URLs found on a website, quickly. Useful for discovering the structure of a site before scraping specific pages. Optionally order results by relevance to a `search` term.",
  "parameters": [],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "url"
          ],
          "properties": {
            "url": {
              "type": "string",
              "format": "uri",
              "description": "The base URL of the site to map."
            },
            "search": {
              "type": "string",
              "description": "Order returned URLs by relevance to this query."
            },
            "sitemap": {
              "type": "string",
              "enum": [
                "skip",
                "include",
                "only"
              ],
              "description": "How to use the site's sitemap. Default 'include'.",
              "default": "include"
            },
            "includeSubdomains": {
              "type": "boolean",
              "description": "Include URLs on subdomains.",
              "default": true
            },
            "ignoreQueryParameters": {
              "type": "boolean",
              "description": "Treat URLs that differ only by query string as the same URL.",
              "default": true
            },
            "limit": {
              "type": "integer",
              "description": "Maximum number of URLs to return. Default 5000, max 100000.",
              "minimum": 1,
              "maximum": 100000,
              "default": 5000
            },
            "timeout": {
              "type": "integer",
              "description": "Request timeout in milliseconds.",
              "minimum": 1000
            },
            "location": {
              "type": "object",
              "description": "Geographic proxy location and language settings.",
              "properties": {
                "country": {
                  "type": "string",
                  "description": "ISO 3166-1 alpha-2 country code."
                },
                "languages": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "example": {
          "url": "https://example.com"
        }
      }
    }
  },
  "responses": [
    {
      "statusCode": "200",
      "description": "The list of URLs discovered on the site.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object"
          }
        }
      }
    },
    {
      "statusCode": "400",
      "description": "Bad request — missing `url` or invalid parameter."
    },
    {
      "statusCode": "401",
      "description": "Unauthorized."
    },
    {
      "statusCode": "402",
      "description": "Insufficient balance."
    },
    {
      "statusCode": "429",
      "description": "Too many requests."
    },
    {
      "statusCode": "5XX",
      "description": "Upstream error."
    }
  ]
}