Developer API — Teravent

API v1 · REST / JSON

Base URL & Authentication

All API requests are made over HTTPS. Public endpoints require no authentication. Authenticated endpoints require an API key passed as a Bearer token in the Authorization header.

Authentication Example (curl)

curl -H "Authorization: Bearer tv_live_xxxxxxxxxxxxxxxxxxxx" \
     -H "Accept: application/json" \
     "https://api.teravent.com/v1/credits"

🪙 Credits Endpoints

GET /v1/credits List All Issued Credits Public ▼

Returns a paginated list of all issued credit serials with project ID, vintage, pathway, tonnes, status, and issuance date. Filterable by pathway, country, status, and vintage year.

Parameter	Type	Required	Description
pathway	string	No	Filter by pathway type. Values: forest, soil, biochar, ocean, enhanced_weathering, dac
country	string	No	ISO 3166-1 alpha-2 country code (e.g. KE, IN, BR)
status	string	No	Credit status. Values: issued, retired, cancelled, suspended
vintage	integer	No	Credit vintage year (e.g. 2023)
page	integer	No	Page number for pagination. Default: 1
per_page	integer	No	Results per page. Default: 50, max: 200

Example Request

curl "https://api.teravent.com/v1/credits?pathway=biochar&country=IN&status=issued&vintage=2024"

Example Response

{
  "data": [
    {
      "id": "TRV-2024-BC-IN-00014",
      "project_id": "PRJ-00087",
      "pathway": "biochar",
      "vintage": 2024,
      "tonnes": 1200,
      "status": "issued",
      "issued_at": "2025-01-14T09:22:00Z"
    }
  ],
  "meta": { "total": 847, "page": 1, "per_page": 50 }
}

GET /v1/credits/{serial}/retire Retire a Credit (check) Auth Required ▼

Returns the retirement status and details of a specific credit serial. To initiate a retirement, use POST /v1/credits/{serial}/retire — authenticated endpoint, requires API key and account with retirement permissions.

Parameter	Type	Required	Description
serial	string	Yes	Full credit serial number (e.g. TRV-2024-BC-IN-00014)
format	string	No	Response format. Values: json (default), pdf_certificate

Example Request

curl -H "Authorization: Bearer YOUR_KEY" \
     "https://api.teravent.com/v1/credits/TRV-2024-BC-IN-00014/retire"

Example Response

{
  "serial": "TRV-2024-BC-IN-00014",
  "status": "issued",
  "retirement_eligible": true,
  "retired_by": null,
  "retired_at": null
}

📁 Project Endpoints

GET /v1/projects List Registered Projects Public ▼

Returns a paginated list of all registered projects with summary metadata including pathway, country, developer, registration date, and credit issuance totals.

Parameter	Type	Required	Description
pathway	string	No	Filter by pathway type
country	string	No	ISO 3166-1 alpha-2 country code
status	string	No	Project status: registered, suspended, deregistered
page	integer	No	Page number. Default: 1

Example Request

curl "https://api.teravent.com/v1/projects?pathway=forest&country=KE"

Example Response

{
  "data": [
    {
      "id": "PRJ-00012",
      "name": "Aberdare Forest Restoration",
      "pathway": "forest",
      "country": "KE",
      "status": "registered",
      "credits_issued": 24500
    }
  ],
  "meta": { "total": 64 }
}

GET /v1/projects/{id} Project Detail Public ▼

Returns full project metadata including verification status, credit issuance history, co-benefit scores, monitoring data history, VVB records, and document links.

Parameter	Type	Required	Description
id	string	Yes	Project ID (e.g. PRJ-00012)
include	string	No	Comma-separated extra fields: documents, monitoring_data, credit_history, vvb_reports

Example Request

curl "https://api.teravent.com/v1/projects/PRJ-00012?include=documents,credit_history"

Example Response

{
  "id": "PRJ-00012",
  "name": "Aberdare Forest Restoration",
  "pathway": "forest",
  "country": "KE",
  "developer": "Kenya Forest Trust",
  "methodology": "TM-001 v2.0",
  "registered_at": "2023-04-18",
  "co_benefit_score": 8.4,
  "credits_issued": 24500,
  "credit_history": [ ... ]
}

📐 Methodology Endpoints

GET /v1/methodologies Approved Methodology Catalogue Public ▼

Returns all approved Teravent methodologies with version history, Science Board vote records, public consultation summaries, and associated guidance documents.

Parameter	Type	Required	Description
status	string	No	Methodology status: active, suspended, deprecated
pathway	string	No	Filter by pathway type

Example Request

curl "https://api.teravent.com/v1/methodologies?status=active"

Example Response

{
  "data": [
    {
      "id": "TM-001",
      "version": "2.0",
      "name": "Afforestation and Reforestation in Tropical Regions",
      "pathway": "forest",
      "status": "active",
      "approved_at": "2022-09-01",
      "board_vote": "9-0-0"
    }
  ]
}

💰 Price Data Endpoints

GET /v1/prices Indicative Price Data Auth Required ▼

Returns aggregated indicative transaction price data by pathway, vintage, and attribute tier — aggregated from Teravent registry transactions. Authenticated endpoint — requires API key. Rate limited to 1,000 calls per day on the free tier.

Parameter	Type	Required	Description
pathway	string	No	Filter by pathway type
vintage	integer	No	Filter by vintage year
attributes	string	No	Comma-separated attributes: ccp_approved, article6, adaptation_fund, sdg_verified
period	string	No	Aggregation period: daily, weekly, monthly. Default: monthly

Example Request

curl -H "Authorization: Bearer YOUR_KEY" \
     "https://api.teravent.com/v1/prices?pathway=forest&vintage=2024&period=monthly"

Example Response

{
  "pathway": "forest",
  "vintage": 2024,
  "currency": "USD",
  "data": [
    {
      "period": "2025-01",
      "price_min": 8.50,
      "price_max": 14.20,
      "price_median": 11.30,
      "volume_tonnes": 12400
    }
  ]
}

🗄️ Registry & Statistics

GET /v1/registry/stats Registry-wide Statistics Public ▼

Returns high-level registry statistics including total projects, total credits issued, credits by pathway, total credits retired, and active projects by country.

Example Request

curl "https://api.teravent.com/v1/registry/stats"

Example Response

{
  "total_projects": 64,
  "total_credits_issued": 1842600,
  "total_credits_retired": 622100,
  "credits_by_pathway": {
    "forest": 980000,
    "soil": 240000,
    "biochar": 180000,
    "ocean": 82600,
    "enhanced_weathering": 360000
  }
}

GET /v1/registry/vvbs Approved VVB List Public ▼

Returns the public list of all Teravent-approved Validation and Verification Bodies, their accreditation details, approved pathways, and current status.

Parameter	Type	Required	Description
pathway	string	No	Filter VVBs approved for a specific pathway
status	string	No	VVB status: active, suspended

Example Request

curl "https://api.teravent.com/v1/registry/vvbs?status=active"

Example Response

{
  "data": [
    {
      "id": "VVB-014",
      "name": "African Climate Verification Services",
      "accreditation": "ISO 14065 — SANAS",
      "pathways": ["forest", "soil", "enhanced_weathering"],
      "status": "active"
    }
  ]
}

📦 Client Libraries & SDKs

Python

● Stable v1.2.0

pip install teravent-api GitHub →

JavaScript / Node

● Stable v1.1.4

npm install @teravent/api GitHub →

Go

● Stable v1.0.2

go get teravent.com/api-go GitHub →

⚡ Rate Limits & Error Codes

Tier	Requests / Day	Requests / Minute	Notes
Public (no key)	200	20	Public endpoints only
Free (API key)	1,000	60	All endpoints incl. prices
Commercial	50,000	500	Contact sales@teravent.com
Partner	Unlimited	Custom	By agreement

Standard Error Response

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Daily rate limit reached. Resets at 00:00 UTC.",
    "status": 429,
    "retry_after": 14400
  }
}