Utility

Utility functions and special permissions functions

Get internal projects

GEThttps://api.carbonregistry.com/v1/utils/internal/projects

Authorization

Query parameters

Response

Body

project*ApiProjectDto (object)

Request

const response = await fetch('https://api.carbonregistry.com/v1/utils/internal/projects', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "project": {
    "city": "New York",
    "sector": {
      "id": "13",
      "title": "Waste handling and disposal"
    },
    "num": "713",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "otherBenefits": [
      {
        "title": "SDG 13: Climate Action",
        "checked": true,
        "id": 12,
        "description": ""
      }
    ],
    "fullName": "Project 1",
    "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
    "description": "This is a project",
    "shortDescription": "This is a project",
    "proponents": [
      {
        "fullName": "John Doe",
        "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
      }
    ],
    "publicUrl": "https://www.carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
    "registry": "ICR",
    "status": "validated",
    "countryCode": "US",
    "state": "New York",
    "startDate": "2023-08-01T00:00:00.000Z",
    "creditingPeriodStartDate": "2023-08-01T00:00:00.000Z",
    "methodology": {
      "id": "VM0034",
      "title": "Canadian Forest Carbon Offset Methodology"
    },
    "type": {
      "id": "removal",
      "title": "Sequestration / Removal",
      "description": "Sequestration, removal and storage of carbondioxide (CO2) from the earth´s atmosphere."
    },
    "estimatedAnnualMitigations": [
      null
    ],
    "location": {
      "lat": 64.10944640131531,
      "lng": -21.81640625
    },
    "kmlFile": {
      "id": "",
      "uri": "http://example.com/document.pdf",
      "type": "monitoringReport",
      "name": "Document 1",
      "isPublic": false
    },
    "validators": [
      {
        "fullName": "John Doe",
        "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
      }
    ],
    "documentation": [
      {
        "id": "",
        "uri": "http://example.com/document.pdf",
        "type": "monitoringReport",
        "name": "Document 1",
        "isPublic": false
      }
    ]
  }
}

Get an internal project by ID

GEThttps://api.carbonregistry.com/v1/utils/internal/projects/{id}

Authorization

Path parameters

id*string

The ID of the internal project

Response

Body

project*ApiProjectDto (object)

Request

const response = await fetch('https://api.carbonregistry.com/v1/utils/internal/projects/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "project": {
    "city": "New York",
    "sector": {
      "id": "13",
      "title": "Waste handling and disposal"
    },
    "num": "713",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "otherBenefits": [
      {
        "title": "SDG 13: Climate Action",
        "checked": true,
        "id": 12,
        "description": ""
      }
    ],
    "fullName": "Project 1",
    "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
    "description": "This is a project",
    "shortDescription": "This is a project",
    "proponents": [
      {
        "fullName": "John Doe",
        "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
      }
    ],
    "publicUrl": "https://www.carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
    "registry": "ICR",
    "status": "validated",
    "countryCode": "US",
    "state": "New York",
    "startDate": "2023-08-01T00:00:00.000Z",
    "creditingPeriodStartDate": "2023-08-01T00:00:00.000Z",
    "methodology": {
      "id": "VM0034",
      "title": "Canadian Forest Carbon Offset Methodology"
    },
    "type": {
      "id": "removal",
      "title": "Sequestration / Removal",
      "description": "Sequestration, removal and storage of carbondioxide (CO2) from the earth´s atmosphere."
    },
    "estimatedAnnualMitigations": [
      null
    ],
    "location": {
      "lat": 64.10944640131531,
      "lng": -21.81640625
    },
    "kmlFile": {
      "id": "",
      "uri": "http://example.com/document.pdf",
      "type": "monitoringReport",
      "name": "Document 1",
      "isPublic": false
    },
    "validators": [
      {
        "fullName": "John Doe",
        "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0"
      }
    ],
    "documentation": [
      {
        "id": "",
        "uri": "http://example.com/document.pdf",
        "type": "monitoringReport",
        "name": "Document 1",
        "isPublic": false
      }
    ]
  }
}

Refresh CarbonRegistry.com's onchain transaction indexers

Pings our indexers. Could be used to speed up CarbonRegistry.com's indexing of onchain data.

POSThttps://api.carbonregistry.com/v1/utils/indexer/refresh

Authorization

Response

Body

success*boolean

Whether the indexer was successfully pinged

Request

const response = await fetch('https://api.carbonregistry.com/v1/utils/indexer/refresh', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "success": false
}

Get some credits from the friendbot

This endpoint sends 100 credits to the organization account that owns the calling api key. Only on testnet.

GEThttps://api.carbonregistry.com/v1/{id}/friendbot

Authorization

Path parameters

id*string

Response

Body

serialization*string

The serialization string representing the credit to be transfered

Example: "ICR-ALB-355-77993-2-A-0-2023"

amount*number

The amount of credits sent to your address

Example: 1000

transactionId*string

The onchain transaction hash

Example: "0xcc73d182db1f36dbadf14205de7d543cfd1343396b50d34c768529aaab46a1c0"

Request

const response = await fetch('https://api.carbonregistry.com/v1/{id}/friendbot', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "serialization": "ICR-ALB-355-77993-2-A-0-2023",
  "amount": 1000,
  "transactionId": "0xcc73d182db1f36dbadf14205de7d543cfd1343396b50d34c768529aaab46a1c0"
}

PreviousSubaccounts NextEnvironments

Last updated 1 month ago

const response = await fetch('https://api.carbonregistry.com/v1/utils/internal/projects', { method: 'GET', headers: { "Authorization": "Bearer <token>" }, }); const data = await response.json();

{ "project": { "city": "New York", "sector": { "id": "13", "title": "Waste handling and disposal" }, "num": "713", "id": "123e4567-e89b-12d3-a456-426614174000", "otherBenefits": [ { "title": "SDG 13: Climate Action", "checked": true, "id": 12, "description": "" } ], "fullName": "Project 1", "thumbnail": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU", "description": "This is a project", "shortDescription": "This is a project", "proponents": [ { "fullName": "John Doe", "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU", "id": "123e4567-e89b-12d3-a456-426614174000", "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0" } ], "publicUrl": "https://www.carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e", "registry": "ICR", "status": "validated", "countryCode": "US", "state": "New York", "startDate": "2023-08-01T00:00:00.000Z", "creditingPeriodStartDate": "2023-08-01T00:00:00.000Z", "methodology": { "id": "VM0034", "title": "Canadian Forest Carbon Offset Methodology" }, "type": { "id": "removal", "title": "Sequestration / Removal", "description": "Sequestration, removal and storage of carbondioxide (CO2) from the earth´s atmosphere." }, "estimatedAnnualMitigations": [ null ], "location": { "lat": 64.10944640131531, "lng": -21.81640625 }, "kmlFile": { "id": "", "uri": "http://example.com/document.pdf", "type": "monitoringReport", "name": "Document 1", "isPublic": false }, "validators": [ { "fullName": "John Doe", "logo": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRzKakVt-GHFNrAN9xFd8B26vYVFLyWoUds8w&usqp=CAU", "id": "123e4567-e89b-12d3-a456-426614174000", "publicUrl": "https://www.carbonregistry.com/explore/organizations/62ffdcad-bd0d-42f7-b8ff-28785a929ed0" } ], "documentation": [ { "id": "", "uri": "http://example.com/document.pdf", "type": "monitoringReport", "name": "Document 1", "isPublic": false } ] } }

const response = await fetch('https://api.carbonregistry.com/v1/utils/internal/projects/{id}', { method: 'GET', headers: { "Authorization": "Bearer <token>" }, }); const data = await response.json();