CarbonGuru Service API

Health and the API contract.

Operations 2

GET /v1/health Whether this API process is serving #
GET /v1/openapi.json This document #

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/carbonguru-io:carbonguru-io-service-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

carbonguru-io-service-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: CarbonGuru Service API
  version: 0.1.0
  summary: Carbon footprint analysis, history and reference data for a developer's own server.
  description: 'One API over the CarbonGuru platform: carbon-footprint analysis of products, carts, text, structured items and files; the sessions, exports and history those analyses produce; reference data; offsets for the account itself; and, for an account with a connected store, catalog footprints, the live footprint read, offset ordering and webhooks. Authenticate with `Authorization: Bearer `. A test key, made in the same place, connects the same way and records every order it posts as a preview: nothing is bought. Errors are RFC 9457 problem documents. Every response carries `X-Request-ID`. Writes accept an `Idempotency-Key`. Lists page with an opaque `next_cursor`. No route accepts terms, saves a payment method or starts automatic offsetting: a signed-in person does those in the account.'
  contact:
    name: CarbonGuru
    url: https://carbonguru.io
servers:
- url: https://carbonguru.io
  description: Production
security:
- bearerAuth: []
tags:
- name: Service
  description: Health and the API contract.
paths:
  /v1/health:
    get:
      tags:
      - Service
      operationId: getHealth
      summary: Whether this API process is serving
      security: []
      responses:
        '200':
          description: The process is serving.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/XRequestID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
  /v1/openapi.json:
    get:
      tags:
      - Service
      operationId: getOpenapi
      summary: This document
      security: []
      responses:
        '200':
          description: The OpenAPI 3.1 document.
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    Health:
      type: object
      properties:
        status:
          type: string
        service:
          type: string
        version:
          type: string
        environment:
          type: string
  headers:
    XRequestID:
      description: The request id, echoed from the caller when it is a sane token, else minted. On every response and in every log line.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from /my-account/api/ (`sk_merchant_…`), or a CarbonGuru OAuth access token. A test key (`sk_merchant_test_…`) connects like a live key; every order it posts is recorded as a preview and nothing is bought. Auth runs before body validation, and every failure returns the same 401.