> ## 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.

# Limits

> See your plan, balance, rate limit and key expiry.

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

```json 200 theme={null}
{
  "success": true,
  "data": {
    "tier": "paid",
    "balanceCredits": 5000,
    "balanceUsd": 10,
    "rateLimit": {
      "limitPerMinute": 600,
      "remaining": 595,
      "resetsAt": "2026-11-17T17:49:00.000Z"
    },
    "perMinute": {
      "calls": 600,
      "jobs": 100,
      "interact": 100,
      "reads": 1500
    },
    "concurrency": {
      "limit": 10,
      "inUse": 0
    },
    "jobsAtOnce": 10,
    "queuedJobs": 20,
    "sessionsAtOnce": 10,
    "paidLimits": null,
    "keyExpiresAt": null,
    "billingUrl": "https://stophy.dev/billing"
  },
  "costUsd": 0,
  "requestId": "1fdfc555-831d-4999-84d1-8c7b028b823e"
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /v1/limits
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/limits:
    get:
      summary: See your plan, balance, rate limit and key expiry.
      description: >-
        Free. Counts as one call toward the per-minute rate limit. Needs an API
        key: without one the answer is 401, and the keyless limits are 10
        requests a minute and 50 a day per IP.
      operationId: getLimits
      responses:
        '200':
          description: Your limits.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - costUsd
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    required:
                      - tier
                      - balanceCredits
                      - balanceUsd
                      - rateLimit
                      - perMinute
                      - concurrency
                      - jobsAtOnce
                      - queuedJobs
                      - sessionsAtOnce
                      - keyExpiresAt
                      - billingUrl
                    properties:
                      tier:
                        type: string
                        enum:
                          - free
                          - paid
                        description: paid once the account has topped up, free before that.
                      balanceCredits:
                        type: number
                        description: 'Older field: the balance in $0.002 steps.'
                      balanceUsd:
                        type: number
                        description: What is left on the account, in dollars.
                      rateLimit:
                        type:
                          - object
                          - 'null'
                        description: >-
                          Calls allowed per minute with this key and how many
                          are left, counting this request. Null when the counter
                          is unavailable.
                        properties:
                          limitPerMinute:
                            type: integer
                          remaining:
                            type: integer
                          resetsAt:
                            type: string
                            format: date-time
                      perMinute:
                        type: object
                        description: >-
                          Calls allowed per minute by kind: calls for scrape,
                          search and the rest, jobs for crawl, batch, extract
                          and agent, interact for browser sessions, and reads
                          for polling a job.
                        properties:
                          calls:
                            type: integer
                          jobs:
                            type: integer
                          interact:
                            type: integer
                          reads:
                            type: integer
                      concurrency:
                        type: object
                        description: >-
                          Calls that may run at once on this account, and how
                          many run now.
                        properties:
                          limit:
                            type: integer
                          inUse:
                            type:
                              - integer
                              - 'null'
                            description: Null when the counter is unavailable.
                      jobsAtOnce:
                        type: integer
                        description: Crawls, batches and agent runs running at once.
                      queuedJobs:
                        type: integer
                        description: Jobs that may wait for a place to run.
                      sessionsAtOnce:
                        type: integer
                        description: Browser sessions open at once.
                      paidLimits:
                        type:
                          - object
                          - 'null'
                        description: >-
                          What a paid account gets, so a free account can see
                          the difference. Null on a paid account.
                        properties:
                          perMinute:
                            type: object
                            description: >-
                              Calls allowed per minute by kind: calls for
                              scrape, search and the rest, jobs for crawl,
                              batch, extract and agent, interact for browser
                              sessions, and reads for polling a job.
                            properties:
                              calls:
                                type: integer
                              jobs:
                                type: integer
                              interact:
                                type: integer
                              reads:
                                type: integer
                          concurrency:
                            type: integer
                            description: Calls that may run at once.
                          jobsAtOnce:
                            type: integer
                          queuedJobs:
                            type: integer
                          sessionsAtOnce:
                            type: integer
                      keyExpiresAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        description: >-
                          When this key stops working. Null when it does not
                          expire.
                      billingUrl:
                        type: string
                        const: https://stophy.dev/billing
                        description: Where a person adds money.
                  creditsUsed:
                    type: integer
                    const: 0
                  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
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    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.