> ## 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.

# マップ

```
```


## OpenAPI

````yaml ja/api-reference/v2-openapi.json post /map
openapi: 3.0.0
info:
  title: Firecrawl API
  version: v2
  description: Firecrawlのサービスを利用して、Webスクレイピングやクロールを行うためのAPIです。
  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: オプションを指定して複数のURLをマップする
      operationId: mapUrls
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  description: クロールの開始地点となるベースURL
                search:
                  type: string
                  description: >-
                    検索クエリを指定すると、結果が関連度の高い順に並べ替えられます。例: 「blog」を指定すると、URL
                    内に「blog」を含むものが関連度順に返されます。
                sitemap:
                  type: string
                  enum:
                    - skip
                    - include
                    - only
                  description: >-
                    マッピング時のサイトマップモードです。`skip` に設定すると、URL
                    の検出にサイトマップは使用されません。`only` に設定すると、サイトマップ内にある URL
                    だけが返されます。デフォルトの `include` では、サイトマップとその他の手法を併用して URL を検出します。
                  default: include
                includeSubdomains:
                  type: boolean
                  description: このサイトのサブドメインを含める
                  default: true
                ignoreQueryParameters:
                  type: boolean
                  description: クエリパラメータ付きのURLを返さない
                  default: true
                ignoreCache:
                  type: boolean
                  description: >-
                    サイトマップキャッシュを無視して最新のURLを取得します。サイトマップデータは最大7日間キャッシュされるため、サイトマップを最近更新した場合はこのパラメータを指定してください。
                  default: false
                limit:
                  type: integer
                  description: 返すリンクの最大数
                  default: 5000
                  maximum: 100000
                timeout:
                  type: integer
                  description: タイムアウト（ミリ秒単位）。既定ではタイムアウトはありません。
                location:
                  type: object
                  description: >-
                    リクエストのロケーション設定です。指定すると、利用可能な場合は適切なプロキシを使用し、対応する言語およびタイムゾーン設定をエミュレートします。指定しない場合は、デフォルトで「US」が使用されます。
                  properties:
                    country:
                      type: string
                      description: 'ISO 3166-1 の alpha-2 国コード（例: 「US」「AU」「DE」「JP」）'
                      pattern: ^[A-Z]{2}$
                      default: US
                    languages:
                      type: array
                      description: >-
                        リクエストに対して優先度順に指定する言語およびロケール。指定された location
                        の言語がデフォルトになります。詳細は
                        https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
                        を参照してください。
                      items:
                        type: string
                        example: en-US
              required:
                - url
            examples:
              example1:
                summary: 例 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: 成功したレスポンス
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MapResponse'
        '402':
          description: お支払いが必要です
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Payment required to access this resource.
        '429':
          description: リクエストが多すぎます
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: >-
                      Request rate limit exceeded. Please wait and try again
                      later.
        '500':
          description: サーバーエラー
          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: （存在する場合の）ページのタイトル。
              description:
                type: string
                description: ページの説明（あれば）
            required:
              - url
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````