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

# Get Cursor Position

> Gets the current position of the mouse cursor on the screen.



## OpenAPI

````yaml api-reference/openapi.json get /api/mouse/position
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: http://localhost:4242/{computer_name}
    description: Local development server
    variables:
      computer_name:
        default: your-computer-name
        description: Computer name
security: []
paths:
  /api/mouse/position:
    get:
      tags:
        - mouse
      summary: Get Cursor Position
      description: Gets the current position of the mouse cursor on the screen.
      operationId: getMousePosition
      parameters:
        - name: display_num
          in: query
          required: false
          schema:
            type: integer
            default: 1
            title: Display Num
      responses:
        '200':
          description: Successfully retrieved cursor position
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: integer
                title: Response Getmouseposition
              example:
                x: 500
                'y': 300
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal server error
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````