> ## Documentation Index
> Fetch the complete documentation index at: https://student-213fb9fc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Map

```
```


## OpenAPI

````yaml pt-BR/api-reference/v2-openapi.json post /map
openapi: 3.0.0
info:
  title: Firecrawl API
  version: v2
  description: >-
    API para interagir com os serviços do Firecrawl e executar tarefas de web
    scraping e crawling.
  contact:
    name: Firecrawl Support
    url: https://firecrawl.dev/support
    email: support@firecrawl.dev
servers:
  - url: https://api.firecrawl.dev/v2
security:
  - bearerAuth: []
paths:
  /map:
    post:
      tags:
        - Mapping
      summary: Mapear várias URLs com base em opções
      operationId: mapUrls
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: URL base de onde o rastreamento será iniciado
                search:
                  type: string
                  description: >-
                    Especifique uma consulta de pesquisa para ordenar os
                    resultados por relevância. Exemplo: "blog" retornará URLs
                    que contenham a palavra "blog" na URL, ordenadas por
                    relevância.
                sitemap:
                  type: string
                  enum:
                    - skip
                    - include
                    - only
                  description: >-
                    Modo de uso do sitemap durante o mapeamento. Se você definir
                    como `skip`, o sitemap não será usado para encontrar URLs.
                    Se você definir como `only`, apenas URLs que estiverem no
                    sitemap serão retornadas. Por padrão (`include`), o sitemap
                    e outros métodos serão usados em conjunto para encontrar
                    URLs.
                  default: include
                includeSubdomains:
                  type: boolean
                  description: Incluir subdomínios do site
                  default: true
                ignoreQueryParameters:
                  type: boolean
                  description: Não retorne URLs com parâmetros de query
                  default: true
                ignoreCache:
                  type: boolean
                  description: >-
                    Ignora o cache do sitemap para obter URLs atualizadas. Os
                    dados do sitemap ficam em cache por até 7 dias; use este
                    parâmetro quando o seu sitemap tiver sido atualizado
                    recentemente.
                  default: false
                limit:
                  type: integer
                  description: Número máximo de links retornados
                  default: 5000
                  maximum: 100000
                timeout:
                  type: integer
                  description: >-
                    Tempo limite, em milissegundos. Não há tempo limite definido
                    por padrão.
                location:
                  type: object
                  description: >-
                    Configurações de localização para a requisição. Quando
                    especificadas, será usado um proxy apropriado, se
                    disponível, e serão emulados o idioma e o fuso horário
                    correspondentes. O padrão é 'US' caso não seja especificado.
                  properties:
                    country:
                      type: string
                      description: >-
                        Código de país alfa-2 da ISO 3166-1 (por exemplo, 'US',
                        'AU', 'DE', 'JP')
                      pattern: ^[A-Z]{2}$
                      default: US
                    languages:
                      type: array
                      description: >-
                        Idiomas e localidades preferenciais da requisição, em
                        ordem de prioridade. Por padrão, usa o idioma da
                        localidade especificada. Consulte
                        https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
                      items:
                        type: string
                        example: en-US
              required:
                - url
            examples:
              example1:
                summary: Exemplo 1
                value:
                  url: <string>
                  search: <string>
                  sitemap: include
                  includeSubdomains: true
                  ignoreQueryParameters: true
                  ignoreCache: false
                  limit: 5000
                  location:
                    country: US
                    languages:
                      - en-US
                  timeout: 60000
      responses:
        '200':
          description: Resposta bem-sucedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapResponse'
        '402':
          description: Pagamento obrigatório
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Payment required to access this resource.
        '429':
          description: Muitas requisições
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Request rate limit exceeded. Please wait and try again
                      later.
        '500':
          description: Erro do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: An unexpected error occurred on the server.
      security:
        - bearerAuth: []
components:
  schemas:
    MapResponse:
      type: object
      properties:
        success:
          type: boolean
        links:
          type: array
          items:
            type: object
            properties:
              url:
                type: string
                format: uri
              title:
                type: string
                description: O título da página, se disponível.
              description:
                type: string
                description: Descrição da página, se disponível.
            required:
              - url
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````