---
updatedAt: 2025-04-24T20:27:55.000Z
agentTools:
  projectIndex: https://api-docs.shippedsuite.com/llms.txt
---

# /v1/carbon_credits/stats

Returns Carbon Credit summary statistics

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipped Suite API",
    "description": "API provides access to Shipped Suite functions",
    "contact": {
      "name": "Steven Ou",
      "email": "steven@invisiblecommerce.com"
    },
    "version": "v1"
  },
  "servers": [
    {
      "url": "//api.shippedsuite.com/"
    }
  ],
  "security": [
    {
      "secretKey": []
    }
  ],
  "tags": [
    {
      "name": "Carbon Credits",
      "description": "Operations about Carbon Credits"
    }
  ],
  "paths": {
    "/v1/carbon_credits/stats": {
      "get": {
        "tags": [
          "Carbon Credits"
        ],
        "description": "Returns Carbon Credit summary statistics",
        "operationId": "getV1CarbonCreditsStats",
        "responses": {
          "200": {
            "description": "Returns Carbon Credit summary statistics",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CarbonCreditSummaryStatistics"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CarbonCreditSummaryStatistics": {
        "required": [
          "total_carbon_kg",
          "total_distance_mi",
          "total_purchases",
          "total_shipments"
        ],
        "type": "object",
        "properties": {
          "total_carbon_kg": {
            "type": "number",
            "description": "Total amount of carbon offset in kilograms"
          },
          "total_purchases": {
            "type": "number",
            "description": "Total number of orders which opted in to carbon neutral shipments"
          },
          "total_distance_mi": {
            "type": "number",
            "description": "Total shipment distance offset in miles"
          },
          "total_shipments": {
            "type": "number",
            "description": "Total number of shipments offset"
          }
        },
        "description": "CarbonCreditSummaryStatistics model"
      }
    },
    "securitySchemes": {
      "secretKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```