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

# Read workspace usage and limits

> Requires tokens scope. Shows the active workspace plan, rolling swap-preparation allowance and per-minute request limits. Limited to 60 usage reads per minute.

[Authentication](/api-reference/authentication) · [Builder integration](/builders)


## OpenAPI

````yaml openapi.json GET /api/v2/builders/usage
openapi: 3.1.0
info:
  title: route
  version: 2.15.0
  description: >-
    Route compares swap paths offchain and executes swaps on Robinhood Chain.
    The API returns quotes and unsigned transactions. It does not sign or submit
    for you. V2 deducts a disclosed pair-dependent output fee up to 0.50%; pool
    fees, provider charges and gas may still apply. Contracts are experimental
    and unaudited. Public routing and data endpoints require no API key. Use the
    documented /api/v2 endpoints for integrations. Builder endpoints require a
    scoped x-api-key from build.route.fun. Public quote, swap and data endpoints
    remain keyless.
servers:
  - url: https://api.route.fun
security: []
paths:
  /api/v2/builders/usage:
    get:
      tags:
        - Builder API
      summary: Read workspace usage and limits
      description: >-
        Requires tokens scope. Shows the active workspace plan, rolling
        swap-preparation allowance and per-minute request limits. Limited to 60
        usage reads per minute.
      operationId: builderUsage
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace:
                    type: string
                  swapAllowance:
                    type: object
                    properties:
                      plan:
                        enum:
                          - Free
                          - Developer
                          - Launch
                          - Pro
                      limit:
                        type: integer
                      used:
                        type: integer
                      remaining:
                        type: integer
                      windowSeconds:
                        const: 3600
                        type: integer
                      resetsAt:
                        type:
                          - integer
                          - 'null'
                      requiredPlan:
                        type:
                          - string
                          - 'null'
                      monthlyPriceUSDG:
                        type: number
                  requestLimits:
                    type: object
                    additionalProperties:
                      type: integer
        '400':
          description: Invalid request or fee above cap
        '401':
          description: Missing, invalid, expired or revoked key
        '403':
          description: Key scope, builder identity or access denied
        '409':
          description: Expired quote, changed policy, price or receipt conflict
        '429':
          description: Workspace or global capacity limit; obey Retry-After
        '503':
          description: Network unavailable or builder settlement not commissioned
      security:
        - BuilderKey: []
components:
  securitySchemes:
    BuilderKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Server-side key created in an authenticated developer workspace. Builder
        codes are public attribution, not credentials.

````