> ## Documentation Index
> Fetch the complete documentation index at: https://docs.domshot.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a screenshot

> Get a screenshot of a website.



## OpenAPI

````yaml https://api.domshot.dev/openapi/json get /shot
openapi: 3.0.3
info:
  title: DomShot API
  description: DomShot API documentation
  version: 1.0.0
servers: []
security: []
paths:
  /shot:
    get:
      summary: Get a screenshot
      description: Get a screenshot of a website.
      operationId: getShot
      parameters:
        - name: key
          in: query
          required: true
          schema:
            description: Your API key
            type: string
        - name: url
          in: query
          required: true
          schema:
            description: The URL to take a screenshot of
            type: string
        - name: cacheKey
          in: query
          required: false
          schema:
            description: >-
              Custom cache key. If not provided, defaults to hash of request
              method and URL
            type: string
        - name: fresh
          in: query
          required: false
          schema:
            default: false
            type: boolean
        - name: format
          in: query
          required: false
          schema:
            default: png
            type: string
            enum:
              - png
              - jpeg
              - webp
        - name: quality
          in: query
          required: false
          schema:
            default: 100
            type: number
        - name: fullPage
          in: query
          required: false
          schema:
            default: false
            type: boolean
        - name: viewportType
          in: query
          required: false
          schema:
            default: desktop
            type: string
            enum:
              - mobile
              - tablet
              - desktop
              - custom
        - name: width
          in: query
          required: false
          schema:
            default: 1920
            description: Only used when viewportType is custom
            type: number
        - name: height
          in: query
          required: false
          schema:
            default: 1080
            description: Only used when viewportType is custom
            type: number
        - name: deviceScaleFactor
          in: query
          required: false
          schema:
            default: 1
            description: Only used when viewportType is custom
            type: number
        - name: blockAds
          in: query
          required: false
          schema:
            default: false
            type: boolean
        - name: blockBanners
          in: query
          required: false
          schema:
            default: false
            type: boolean
        - name: blockTracking
          in: query
          required: false
          schema:
            default: false
            type: boolean
        - name: waitUntil
          in: query
          required: false
          schema:
            default: networkidle2
            type: string
            enum:
              - load
              - domcontentloaded
              - networkidle0
              - networkidle2
        - name: timeout
          in: query
          required: false
          schema:
            default: 30000
            type: number
        - name: customCookies
          in: query
          required: false
          schema:
            type: string
        - name: customHeaders
          in: query
          required: false
          schema:
            type: string
        - name: background
          in: query
          required: false
          schema:
            type: string
        - name: backgroundPadding
          in: query
          required: false
          schema:
            type: number
        - name: backgroundBorderRadius
          in: query
          required: false
          schema:
            type: number
        - name: customUserAgent
          in: query
          required: false
          schema:
            type: object
            properties:
              userAgent:
                type: string
              platform:
                type: string
              userAgentMetadata:
                type: object
                required:
                  - platform
                  - platformVersion
                  - architecture
                  - model
                  - mobile
                properties:
                  brands:
                    type: array
                    items:
                      type: object
                      required:
                        - brand
                        - version
                      properties:
                        brand:
                          type: string
                        version:
                          type: string
                  fullVersionList:
                    type: array
                    items:
                      type: object
                      required:
                        - brand
                        - version
                      properties:
                        brand:
                          type: string
                        version:
                          type: string
                  platform:
                    type: string
                  platformVersion:
                    type: string
                  architecture:
                    type: string
                  model:
                    type: string
                  mobile:
                    type: boolean
                  bitness:
                    type: string
                  wow64:
                    type: boolean
                  formFactors:
                    type: array
                    items:
                      type: string
      responses:
        '200':
          description: Response for status 200
          content:
            text/plain:
              schema:
                default: File
                type: string
                format: binary
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - errorDescription
                properties:
                  error:
                    type: string
                  errorDescription:
                    type: string
        '402':
          description: Response for status 402
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - errorDescription
                properties:
                  error:
                    type: string
                  errorDescription:
                    type: string
        '404':
          description: Response for status 404
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - errorDescription
                properties:
                  error:
                    type: string
                  errorDescription:
                    type: string
        '422':
          description: Response for status 422
          content:
            application/json:
              schema:
                type: object
                required:
                  - type
                  - 'on'
                  - property
                  - message
                  - summary
                  - found
                  - errors
                properties:
                  type:
                    type: string
                  'on':
                    type: string
                  property:
                    type: string
                  message:
                    type: string
                  summary:
                    type: string
                  found:
                    type: object
                    properties: {}
                  errors:
                    type: array
                    items:
                      type: object
                      required:
                        - data
                        - path
                        - code
                        - missingValueDescription
                        - meta
                        - expected
                        - actual
                        - problem
                        - message
                      properties:
                        data:
                          type: object
                          properties: {}
                        path:
                          type: array
                          items:
                            type: string
                        code:
                          type: string
                        missingValueDescription:
                          type: string
                        meta:
                          type: object
                          properties: {}
                        expected:
                          type: string
                        actual:
                          type: string
                        problem:
                          type: string
                        message:
                          type: string
        '429':
          description: Response for status 429
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - errorDescription
                  - retryAfter
                properties:
                  error:
                    type: string
                  errorDescription:
                    type: string
                  retryAfter:
                    type: number
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - errorDescription
                properties:
                  error:
                    type: string
                  errorDescription:
                    type: string

````