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

# Get workspace usage

> Returns API credit consumption for the current billing period for the workspace resolved from the API key.



## OpenAPI

````yaml /api-reference/platform-api.json get /v1/workspace/usage
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.13
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
paths:
  /v1/workspace/usage:
    get:
      tags:
        - Workspace Usage
      summary: Get workspace usage
      description: >-
        Returns API credit consumption for the current billing period for the
        workspace resolved from the API key.
      operationId: getUsage
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceUsageDto'
components:
  schemas:
    WorkspaceUsageDto:
      type: object
      properties:
        credits_used:
          type: number
          description: API credits consumed in the current billing period
          example: 1204
        credits_limit:
          type: number
          description: API credit limit for the current billing period
          example: 1000000
        credits_remaining:
          type: number
          description: Credits left before requests are rate limited
          example: 998796
        reset_date:
          type: string
          description: >-
            When the credit counter resets — start of the next billing period
            (UTC, ISO 8601)
          example: '2026-08-01T00:00:00.000Z'
        by_family:
          description: Credits and request counts grouped by operation family
          type: array
          items:
            $ref: '#/components/schemas/UsageByFamilyDto'
        by_route:
          description: Credits and request counts grouped by exact route
          type: array
          items:
            $ref: '#/components/schemas/UsageByRouteDto'
      required:
        - credits_used
        - credits_limit
        - credits_remaining
        - reset_date
        - by_family
        - by_route
    UsageByFamilyDto:
      type: object
      properties:
        family:
          type: string
          example: risk
        credits:
          type: number
          example: 980
        requests:
          type: number
          example: 950
      required:
        - family
        - credits
        - requests
    UsageByRouteDto:
      type: object
      properties:
        method:
          type: string
          example: GET
        route:
          type: string
          example: /v1/risk/address
        credits:
          type: number
          example: 800
        requests:
          type: number
          example: 800
      required:
        - method
        - route
        - credits
        - requests
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````