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

# List monitors

> List your monitors, newest first.

```bash cURL theme={null}
curl https://api.stophy.dev/v1/monitor \
  -H "Authorization: Bearer $STOPHY_API_KEY"
```

```json 200 theme={null}
{
  "success": true,
  "data": [
    {
      "id": "mon_gYdxFOZnpRdWHJUN",
      "name": "Docs example, renamed",
      "status": "active",
      "schedule": {
        "cron": "0 0 * * *",
        "timezone": "UTC",
        "everySeconds": null
      },
      "nextRunAt": "2026-11-18T00:00:00.000Z",
      "lastRunAt": "2026-11-17T17:53:54.066Z",
      "currentCheckId": null,
      "targets": [
        "…"
      ],
      "goal": null,
      "judgeEnabled": false,
      "retentionDays": 30,
      "estimatedCreditsPerMonth": 15,
      "estimatedCostUsdPerMonth": 0.03,
      "notification": {
        "email": "…"
      },
      "emailRecipientSubscriptions": [],
      "webhook": {
        "url": "https://example.com/stophy-hook",
        "events": "…",
        "metadata": "…"
      },
      "createdAt": "2026-11-17T17:53:00.141Z",
      "updatedAt": "2026-11-17T17:53:25.062Z",
      "urls": [
        "https://bun.com/docs/runtime/bunfig"
      ],
      "interval": null,
      "formats": [
        "markdown"
      ],
      "changeTracking": {
        "modes": "…"
      },
      "nextCheckAt": "2026-11-18T00:00:00.000Z",
      "lastCheckAt": "2026-11-17T17:53:54.066Z",
      "checks": 1,
      "costUsd": 0.001
    }
  ],
  "next": null,
  "costUsd": 0,
  "requestId": "6fdc0db3-14ae-48ea-8fa3-3c68c1866017"
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /v1/monitor
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Each operation shows its method and its input: a JSON object body, path and
    query parameters, or a file upload.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    Text comes back whole. To get shorter responses, add
    ?maxTextLength=<characters> to the URL. Every text value longer than that is
    cut and ends with …. A screenshot is never cut, and a page whose text was
    cut has isTruncated set to true.


    The x-cost-usd response header is what the request cost in dollars. An
    operation's description gives its pricing units and add-ons. The OpenAPI
    fields x-cost-usd and x-cost-usd-max are list-price estimates, not receipts
    or spending limits. When a call starts a job, check the job result for its
    total cost.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/monitor:
    get:
      summary: List your monitors, newest first.
      operationId: monitorList
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Your monitors.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - costUsd
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  id:
                    type: string
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        status:
                          type: string
                          enum:
                            - active
                            - paused
                        pausedReason:
                          type: string
                        schedule:
                          type: object
                          properties:
                            cron:
                              type:
                                - string
                                - 'null'
                            timezone:
                              type: string
                            everySeconds:
                              type:
                                - integer
                                - 'null'
                        nextRunAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        lastRunAt:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        currentCheckId:
                          type:
                            - string
                            - 'null'
                        targets:
                          type: array
                          items:
                            type: object
                        retentionDays:
                          type: integer
                        estimatedCreditsPerMonth:
                          type: integer
                          description: >-
                            Older field: the estimated cost over 30 days, in
                            $0.002 steps.
                        estimatedCostUsdPerMonth:
                          type: number
                          description: >-
                            Estimated cost of scheduled checks over 30 days,
                            including search, watched JSON and judging, in
                            dollars.
                        webhook:
                          type:
                            - object
                            - 'null'
                        createdAt:
                          type: string
                          format: date-time
                        urls:
                          type: array
                          items:
                            type: string
                          description: 'Older field: every page watched.'
                        interval:
                          type:
                            - integer
                            - 'null'
                          description: 'Older field: seconds between checks.'
                        checks:
                          type: integer
                        creditsUsed:
                          type: integer
                        costUsd:
                          type: number
                          description: >-
                            Cost recorded in this monitor's page history, in
                            dollars. It excludes search targets. For each
                            check's charge, see actualCostUsd on the check.
                  next:
                    type:
                      - string
                      - 'null'
                  creditsUsed:
                    type: integer
                  costUsd:
                    type: number
                    description: What this call cost, in dollars.
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. Retry-After says when trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: What went wrong and what to do next.
        code:
          type: string
          enum:
            - apiKeyRequired
            - busy
            - checkRunning
            - cliSessionCompleted
            - cliSessionExists
            - cliSessionNotFound
            - forbidden
            - freeLimit
            - insufficientCredits
            - internalError
            - inviteClaimed
            - inviteDisabled
            - inviteExpired
            - inviteUsedUp
            - invalidCliSession
            - invalidCliVerifier
            - invalidRequest
            - jobFinished
            - methodNotAllowed
            - notFound
            - payloadTooLarge
            - profileBusy
            - profileTooLarge
            - prohibitedPermission
            - promptInjectionDetected
            - rateLimited
            - sourceChanged
            - sourceRefused
            - siteNotRead
            - sourceTimeout
            - sourceUnavailable
            - unauthorized
            - unsupportedMediaType
        retryable:
          type: boolean
          description: true when trying again can help.
        retryAfterSeconds:
          type: integer
        requestId:
          type: string
        requiredCredits:
          type: number
          description: >-
            Older field: the most the call can cost, in $0.002 steps. Sent when
            the balance is too low.
        availableCredits:
          type: number
          description: 'Older field: the balance in $0.002 steps. Sent with requiredCredits.'
        requiredUsd:
          type: number
          description: >-
            The most the call can cost, in dollars. Sent when the balance is too
            low.
        availableUsd:
          type: number
          description: What is left on the account, in dollars. Sent with requiredUsd.
        billingUrl:
          type: string
          description: Where to add money. Sent with requiredUsd.
        signupUrl:
          type: string
          const: https://stophy.dev/signup
          description: >-
            Where a person gets a key. Sent with apiKeyRequired, freeLimit and
            an invalid key.
        signup:
          type: string
          const: POST https://api.stophy.dev/v1/signup
          description: >-
            The call that gets an agent a key with no human. Sent next to
            signupUrl.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.