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

# Query Usage

> getAccountUsage - This endpoint retrieves account usage statistics with optional grouping by time, endpoint, user, or organization.



## OpenAPI

````yaml GET /api/v1/tracker/account/usage
openapi: 3.0.3
info:
  title: Bitrace AML API
  description: >-
    Bitrace AML API provides comprehensive blockchain and crypto compliance
    tools for real-time risk detection capabilities. The API enables scrutiny of
    crypto transactions, wallet addresses, and crypto tokens with precision and
    efficiency.
  version: 1.0.0
  contact:
    name: Bitrace Support
    email: support@bitrace.io
servers:
  - url: https://api.bitrace.io
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: KYA (Know Your Address)
    description: Address risk assessment and entity identification
  - name: KYT (Know Your Transaction)
    description: Transaction monitoring and compliance
  - name: Account API
    description: Account usage and management APIs
  - name: Address Management
    description: Address management on the blacklist and whitelist
paths:
  /api/v1/tracker/account/usage:
    get:
      tags:
        - Account API
      summary: Query Account Usage
      description: >-
        getAccountUsage - This endpoint retrieves account usage statistics with
        optional grouping by time, endpoint, user, or organization.
      parameters:
        - name: granularity
          in: query
          required: false
          schema:
            type: string
            enum:
              - day
              - month
            default: day
          description: 'Time granularity: day or month'
        - name: startTime
          in: query
          required: false
          schema:
            type: string
            format: date
            example: '2026-06-01'
          description: 'Start date (format: yyyy-MM-dd)'
        - name: endTime
          in: query
          required: false
          schema:
            type: string
            format: date
            example: '2026-06-16'
          description: 'End date (format: yyyy-MM-dd)'
        - name: groupBy
          in: query
          required: false
          schema:
            type: string
            enum:
              - endpoint
              - user
              - org
            default: org
            example: endpoint,user
          description: 'Group by fields (comma-separated): endpoint, user, or org'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountUsageGetResponse'
              example:
                code: 200
                message: success
                data:
                  - time: '2026-06-16'
                    methodName: getAddressRisk
                    methodUrl: /api/v1/tracker/kya/risks
                    totalCalls: 150
                    useCredits: 45
                  - time: '2026-06-15'
                    methodName: getAddressEntity
                    methodUrl: /api/v1/tracker/kya/entities
                    totalCalls: 200
                    useCredits: 60
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimit'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    AccountUsageGetResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            data:
              type: array
              description: Array of account usage data
              items:
                type: object
                properties:
                  time:
                    type: string
                    description: >-
                      Time period (date for day granularity, month for month
                      granularity)
                    example: 2026-06-16 or 2026-06
                  userName:
                    type: string
                    description: User name (populated when groupBy=user)
                    example: john.doe
                  methodName:
                    type: string
                    description: API method name (populated when groupBy=endpoint)
                    example: getAddressRisk
                  methodUrl:
                    type: string
                    description: API endpoint URL (populated when groupBy=endpoint)
                    example: /api/v1/tracker/kya/risks
                  totalCalls:
                    type: integer
                    description: Total API call count
                    example: 150
                  useCredits:
                    type: integer
                    description: API credits used
                    example: 45
    BaseResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Request success or not
        code:
          type: integer
          description: Response code (1 for success, other numbers for errors)
        msg:
          type: string
          description: SUCCESS or error message
    Error:
      type: object
      properties:
        success:
          type: boolean
          description: Request success or not
          default: false
        code:
          type: integer
        msg:
          type: string
        status:
          type: string
  responses:
    BadRequest:
      description: Bad Request - Your request is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized - Incorrect API key provided
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimit:
      description: Too Many Requests - Rate limit reached or quota exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error - We had a problem with our server
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Access-Key
      description: API key authentication

````