OpenCost

OpenCost Allocation API

The Allocation API from OpenCost — 1 operation(s) for allocation.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.opencost.io/docs/integrations/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opencost/refs/heads/main/openapi/opencost-allocation-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/opencost/refs/heads/main/json-schema/opencost-allocation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/opencost/refs/heads/main/json-schema/opencost-asset-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/opencost/refs/heads/main/json-schema/opencost-cloudcost-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/opencost/refs/heads/main/json-ld/opencost-context.jsonld
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/opencost/refs/heads/main/apis.yml

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/opencost-allocation-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

opencost-allocation-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: OpenCost Allocation API
  description: The OpenCost API provides real-time and historical reporting of Kubernetes workload costs and underlying cloud infrastructure spend. OpenCost is an open source CNCF specification and reference implementation for Kubernetes cost monitoring and FinOps.
  version: '1.0'
  contact:
    name: OpenCost
    url: https://www.opencost.io/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:9003
  description: Local kubectl port-forward to opencost service
tags:
- name: Allocation
paths:
  /allocation:
    get:
      operationId: getAllocation
      summary: Query Kubernetes workload cost allocations
      description: Returns costs and resources allocated to Kubernetes workloads based on on-demand list pricing.  The 'data' field is an array of sets, one per 'step'.
      tags:
      - Allocation
      parameters:
      - name: window
        in: query
        required: true
        description: Duration of time over which to query.
        schema:
          type: string
        examples:
          today:
            value: today
          lastweek:
            value: lastweek
          range:
            value: 2024-01-01T00:00:00Z,2024-01-02T00:00:00Z
      - name: aggregate
        in: query
        description: Field by which to aggregate (namespace, controller, label:app, etc.).
        schema:
          type: string
      - name: step
        in: query
        description: Duration of a single allocation set.
        schema:
          type: string
      - name: accumulate
        in: query
        schema:
          type: boolean
      - name: resolution
        in: query
        schema:
          type: string
      - name: includeIdle
        in: query
        schema:
          type: boolean
      - name: shareIdle
        in: query
        schema:
          type: boolean
      - name: idleByNode
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllocationResponse'
components:
  schemas:
    Allocation:
      type: object
      properties:
        name:
          type: string
        cpuCost:
          type: number
        cpuCoreUsageAverage:
          type: number
        ramCost:
          type: number
        ramByteUsageAverage:
          type: number
        pvCost:
          type: number
        networkCost:
          type: number
        sharedCost:
          type: number
        externalCost:
          type: number
        totalCost:
          type: number
        minutes:
          type: number
        window:
          type: object
          properties:
            start:
              type: string
              format: date-time
            end:
              type: string
              format: date-time
        properties:
          type: object
          additionalProperties:
            type: string
    AllocationResponse:
      type: object
      properties:
        code:
          type: integer
        status:
          type: string
        data:
          type: array
          items:
            type: object
            additionalProperties:
              $ref: '#/components/schemas/Allocation'
externalDocs:
  description: OpenCost API Documentation
  url: https://www.opencost.io/docs/integrations/api