Map

Note: A new v2 version of this API is now available with improved features and performance.

OpenAPI

openapi: 3.0.0
info:
title: Firecrawl API
version: v1
description: >-
  API for interacting with Firecrawl services to perform web scraping and
  crawling tasks.
contact:
  name: Firecrawl Support
  url: https://firecrawl.dev/support
  email: support@firecrawl.dev
servers:
- url: https://api.firecrawl.dev/v1
security:
- bearerAuth: []
paths:
/map:
  post:
    tags:
      - Mapping
    summary: Map multiple URLs based on options
    operationId: mapUrls
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              url:
                type: string
                format: uri
                description: The base URL to start crawling from
              search:
                type: string
                description: >-
                  Search query to use for mapping. During the Alpha phase, the
                  'smart' part of the search functionality is limited to 500
                  search results. However, if map finds more results, there is
                  no limit applied.
              ignoreSitemap:
                type: boolean
                description: Ignore the website sitemap when crawling.
                default: true
              sitemapOnly:
                type: boolean
                description: Only return links found in the website sitemap
                default: false
              includeSubdomains:
                type: boolean
                description: Include subdomains of the website
                default: true
              limit:
                type: integer
                description: Maximum number of links to return
                default: 5000
                maximum: 30000
              timeout:
                type: integer
                description: Timeout in milliseconds. There is no timeout by default.
              location:
                type: object
                description: >-
                  Location settings for the request. When specified, this will
                  use an appropriate proxy if available and emulate the
                  corresponding language and timezone settings. Defaults to
                  'US' if not specified.
                properties:
                  country:
                    type: string
                    description: >-
                      ISO 3166-1 alpha-2 country code (e.g., 'US', 'AU', 'DE',
                      'JP')
                    pattern: ^[A-Z]{2}$
                    default: US
                  languages:
                    type: array
                    description: >-
                      Preferred languages and locales for the request in order
                      of priority. Defaults to the language of the specified
                      location. See
                      https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
                    items:
                      type: string
                      example: en-US
            required:
              - url
    responses:
      '200':
        description: Successful response
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MapResponse'
      '402':
        description: Payment required
        content:
          application/json:
            schema:
              type: object
              properties:
                error:
                  type: string
                  example: Payment required to access this resource.
      '429':
        description: Too many requests
        content:
          application/json:
            schema:
              type: object
              properties:
                error:
                  type: string
                  example: >-
                    Request rate limit exceeded. Please wait and try again
                    later.
      '500':
        description: Server error
        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: string
securitySchemes:
  bearerAuth:
    type: http
    scheme: bearer