# Get the status of a scrape

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/crawler/scrape/{id}:
    get:
      summary: Get the status of a scrape
      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/ScrapeStatusResponseObj'
              example:
                success: false
                status: completed
                data:
                  markdown: qui
                  html: sunt
                  rawHtml: null
                  screenshot: null
                  links:
                    - https://sticky-pantyhose.org/
                  metadata:
                    title: questionably buck over esteemed whether into
                    description: >-
                      Toties amicitia thesis. Adsidue tam viduo armarium condico
                      tui verbera solitudo. Arcesso cariosus aggredior teneo
                      supplanto contabesco voluntarius decretum cupressus.
                      Speciosus cado advoco adinventitias labore dolores casso
                      creta ver consequuntur. At claustrum verumtamen varietas
                      viscus illo surculus ustilo. Aqua ratione quis cras.
                    language: null
                    sourceURL: https://turbulent-offset.biz/
                    '<any other metadata> ': in
                    statusCode: 68
                    error: null
                error: sint ut nisi
          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-17644667-run
components:
  schemas:
    ScrapeStatusResponseObj:
      type: object
      properties:
        success:
          type: boolean
        status:
          type: string
          description: >-
            The current status of the crawl. Can be `scraping`, `completed`, or
            `failed`.
        data:
          type: object
          properties:
            markdown:
              type: string
            html:
              type: string
              description: HTML version of the content on page if `html` is in `formats`
              nullable: true
            rawHtml:
              type: string
              description: Raw HTML content of the page if `rawHtml` is in `formats`
              nullable: true
            screenshot:
              type: string
              description: Screenshot of the page if `screenshot` is in `formats`
              nullable: true
            links:
              type: array
              items:
                type: string
              description: List of links on the page if `links` is in `formats`
            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
            - screenshot
            - links
            - metadata
          description: The data of the scrape.
          x-apidog-ignore-properties: []
        error:
          type: string
          description: Error message
      x-apidog-orders:
        - success
        - status
        - data
        - error
      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: []

```
