# Get the status of a batch scrape job

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/crawler/scrape/batch/{id}:
    get:
      summary: Get the status of a batch scrape job
      deprecated: false
      description: ''
      operationId: getBatchScrapeStatus
      tags:
        - Crawler/Scrape
        - Scraping
      parameters:
        - name: id
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchScrapeStatusResponseObj'
          headers: {}
          x-apidog-name: OK
        '402':
          description: Payment required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    examples:
                      - Payment required to access this resource.
                x-apidog-orders:
                  - error
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: '402'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    examples:
                      - >-
                        Request rate limit exceeded. Please wait and try again
                        later.
                x-apidog-orders:
                  - error
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: '429'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    examples:
                      - An unexpected error occurred on the server.
                x-apidog-orders:
                  - error
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Server Error
      security:
        - apikey-header-x-api-token: []
      x-apidog-folder: Crawler/Scrape
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/745098/apis/api-17509004-run
components:
  schemas:
    BatchScrapeStatusResponseObj:
      type: object
      properties:
        status:
          type: string
          description: >-
            The current status of the batch scrape. Can be `scraping`,
            `completed`, or `failed`.
        total:
          type: integer
          description: The total number of pages that were attempted to be scraped.
        completed:
          type: integer
          description: The number of pages that have been successfully scraped.
        data:
          type: array
          description: The data of the batch scrape.
          items:
            type: object
            properties:
              markdown:
                type: string
              html:
                type: string
                description: HTML version of the content on page if `includeHtml`  is true
                nullable: true
              rawHtml:
                type: string
                description: Raw HTML content of the page if `includeRawHtml`  is true
                nullable: true
              links:
                type: array
                items:
                  type: string
                description: List of links on the page if `includeLinks` is true
              screenshot:
                type: string
                description: Screenshot of the page if `includeScreenshot` is true
                nullable: true
              metadata:
                type: object
                properties:
                  title:
                    type: string
                  description:
                    type: string
                  language:
                    type: string
                    nullable: true
                  sourceURL:
                    type: string
                    format: uri
                  '<any other metadata> ':
                    type: string
                  statusCode:
                    type: integer
                    description: The status code of the page
                  error:
                    type: string
                    description: The error message of the page
                    nullable: true
                x-apidog-orders:
                  - title
                  - description
                  - language
                  - sourceURL
                  - '<any other metadata> '
                  - statusCode
                  - error
                x-apidog-ignore-properties: []
            x-apidog-orders:
              - markdown
              - html
              - rawHtml
              - links
              - screenshot
              - metadata
            x-apidog-ignore-properties: []
      x-apidog-orders:
        - status
        - total
        - completed
        - data
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes:
    bearer:
      type: bearer
      scheme: bearer
      description: Bearer token authentication using your Scrapeless API key
    apikey-header-x-api-token:
      type: apiKey
      in: header
      name: x-api-token
servers:
  - url: https://api.scrapeless.com
    description: Prod Env
security:
  - apikey-header-x-api-token: []

```