Piloterr Usage API

The Usage API from Piloterr — 1 operation(s) for usage.

GitHub OpenAPI

Operations 1

GET /v2/usage Usage #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-usage-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

piloterr-com-usage-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Piloterr API Reference Usage API
  description: Complete API reference documentation.
  version: 1.0.0
servers:
- url: https://api.piloterr.com
  description: API Server
tags:
- name: Usage
paths:
  /v2/usage:
    get:
      summary: Usage
      description: Retrieve real-time usage statistics and credit balance for your Piloterr account.
      operationId: usage
      security:
      - ApiKeyAuth: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  packs:
                    nullable: true
                  period:
                    type: object
                    properties:
                      end:
                        type: string
                      start:
                        type: string
                  account:
                    type: object
                    properties:
                      name:
                        type: string
                      slug:
                        type: string
                  api_key:
                    type: object
                    properties:
                      alias:
                        type: string
                      active:
                        type: boolean
                      quotas:
                        type: object
                        properties:
                          daily:
                            nullable: true
                          total:
                            nullable: true
                          weekly:
                            nullable: true
                          monthly:
                            nullable: true
                      expires:
                        nullable: true
                      category:
                        type: string
                  credits:
                    type: object
                    properties:
                      given:
                        type: integer
                      consumed:
                        type: integer
                      remaining:
                        type: integer
                      percent_used:
                        type: integer
                  remaining:
                    type: integer
                  rate_limit:
                    type: object
                    properties:
                      per_minute:
                        nullable: true
                      per_second:
                        nullable: true
                  total_used:
                    type: integer
                  renewal_date:
                    type: string
                  subscription:
                    type: object
                    properties:
                      used:
                        type: integer
                      total:
                        type: integer
                      remaining:
                        type: integer
                      percent_used:
                        type: integer
              examples:
                Account usage overview:
                  value:
                    packs: null
                    period:
                      end: '2026-04-25'
                      start: '2026-03-25'
                    account:
                      name: Microsoft
                      slug: microsoft
                    api_key:
                      alias: my-api-key
                      active: true
                      quotas:
                        daily: null
                        total: null
                        weekly: null
                        monthly: null
                      expires: null
                      category: development
                    credits:
                      given: 0
                      consumed: 0
                      remaining: 0
                      percent_used: 0
                    remaining: 0
                    rate_limit:
                      per_minute: null
                      per_second: null
                    total_used: 15871
                    renewal_date: '2026-04-25'
                    subscription:
                      used: 15871
                      total: 50
                      remaining: 0
                      percent_used: 31742
                Account with one-time packs:
                  value:
                    packs:
                      used: 15200000
                      count: 2
                      items:
                      - id: cmhtn…
                        used: 12500000
                        title: Ultimate
                        total: 12500000
                        exhausted: true
                        remaining: 0
                        percent_used: 100
                        purchased_at: '2025-11-10'
                      - id: cmlc9…
                        used: 2700000
                        title: Ultimate
                        total: 12500000
                        exhausted: false
                        remaining: 9800000
                        percent_used: 21.6
                        purchased_at: '2026-02-07'
                      total: 25000000
                      current:
                        id: cmlc9…
                        used: 2700000
                        title: Ultimate
                        total: 12500000
                        exhausted: false
                        remaining: 9800000
                        percent_used: 21.6
                        purchased_at: '2026-02-07'
                      remaining: 9800000
                      percent_used: 60.8
                      all_exhausted: false
                      current_index: 2
                      exhausted_count: 1
                    period:
                      end: '2026-10-01'
                      start: '2026-09-01'
                    account:
                      name: Microsoft
                      slug: microsoft
                    api_key:
                      alias: my-api-key
                      active: true
                      quotas:
                        daily: null
                        total: null
                        weekly: null
                        monthly: null
                      expires: null
                      category: development
                    credits:
                      given: 0
                      consumed: 0
                      remaining: 0
                      percent_used: 0
                    remaining: 9800000
                    rate_limit:
                      per_minute: null
                      per_second: null
                    total_used: 15200000
                    renewal_date: '2026-10-01'
                    subscription:
                      used: 15200000
                      total: 25000000
                      remaining: 9800000
                      percent_used: 60.8
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Usage
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key. Include it in the x-api-key header for every request.