Public API Documentation

Access BCB Connect data programmatically for research, analysis, and integration

API Overview

Base URL

https://bcbconnect.vercel.app/api/public

Authentication

No authentication required. All endpoints are public and open for access.

Rate Limiting

Currently no rate limits. Please be respectful and cache responses when possible.

Response Format

All responses are in JSON format with the following structure:

{
  "success": true | false,
  "data": { ... },
  "error": "error message" // only if success = false
}

API Endpoints

GET /api/public/projects

Get all public projects with optional filters

Query Parameters

Name	Type	Required	Description
province	string	Optional	Filter by province
status	string	Optional	Filter by project status
minCarbon	number	Optional	Minimum carbon sequestered
minScore	number	Optional	Minimum Octagem score
search	string	Optional	Search in name/description

Example Request

/api/public/projects?province=Quezon&minScore=60

GET /api/public/projects/:id

Get detailed information about a specific project

Example Request

/api/public/projects/123e4567-e89b-12d3-a456-426614174000

GET /api/public/verify

Verify a BCB certificate by NFT ID

Query Parameters

Name	Type	Required	Description
nftId	string	Required	NFT ID in format tokenId@serialNumber

Example Request

/api/public/verify?nftId=0.0.12345@67890

GET /api/public/impact

Get aggregate impact metrics

Query Parameters

Name	Type	Required	Description
trend	boolean	Optional	Include carbon sequestration trend data

Example Request

/api/public/impact?trend=true

GET /api/public/data

Export public data in JSON or CSV format

Query Parameters

Name	Type	Required	Description
format	string	Optional	Export format: json or csv

Example Request

/api/public/data?format=csv

Response Examples

{
  "success": true,
  "data": {
    "projects": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Quezon Biochar Initiative",
        "description": "Community-based biochar production...",
        "cooperative_name": "Quezon Farmers Cooperative",
        "cooperative_province": "Quezon",
        "cooperative_municipality": "Lucena",
        "status": "certified",
        "actual_carbon_sequestered": 125.5,
        "octagem_score": 72.5,
        "octagem_grade": "AA"
      }
    ],
    "provinces": ["Quezon", "Laguna", "Batangas"]
  }
}

{
  "success": true,
  "data": {
    "valid": true,
    "certificate": {
      "nft_id": "0.0.12345@67890",
      "project_name": "Quezon Biochar Initiative",
      "cooperative_name": "Quezon Farmers Cooperative",
      "vintage": "2025",
      "carbon_sequestered": 125.5,
      "octagem_score": 72.5,
      "octagem_grade": "AA",
      "status": "minted",
      "minted_at": "2025-11-30T10:00:00Z"
    },
    "verifications": {
      "technical": {
        "verifier_type": "control_union",
        "status": "completed",
        "timestamp": "2025-11-29T14:00:00Z"
      },
      "financial": {
        "verifier_type": "pwc",
        "status": "completed",
        "timestamp": "2025-11-29T16:00:00Z"
      }
    }
  }
}

{
  "success": true,
  "data": {
    "metrics": {
      "totalCarbonSequestered": 1250.75,
      "totalFarmers": 450,
      "totalHectares": 875.5,
      "totalBiocharProduced": 25000,
      "totalProjects": 15,
      "totalCooperatives": 8,
      "provinceBreakdown": [
        {
          "province": "Quezon",
          "projects": 6,
          "carbon": 625.3
        }
      ],
      "gradeDistribution": [
        { "grade": "AAA", "count": 2 },
        { "grade": "AA", "count": 5 },
        { "grade": "A", "count": 8 }
      ]
    }
  }
}

Use Cases

• Research & Analysis: Access aggregate data for academic research on carbon markets and biochar sequestration
• Third-Party Integrations: Build applications that verify BCB certificates or display project information
• Data Journalism: Export data for creating visualizations and stories about climate action
• Carbon Market Platforms: Integrate BCB Connect data into broader carbon credit marketplaces

Support & Feedback

Have questions or need help integrating our API? We're here to help!

Email: api@bcbconnect.ph

Documentation: https://docs.bcbconnect.ph