Getting Started
Public Registry Data
- Issuances
- Deliveries
- Retirements
- Transfers
- Suppliers
- Projects
Buyer Account Management
- GETCurrent Organisation
- GETOrganisation Credit Balance
- GETOrganisation Credit Batches
- Orders
- Retirements
- Transfers
Supplier Account Management
- GETCurrent Supplier
- GETOrganisation Credit Batches
- Issuances
- Orders
- Deliveries
Transfer Credit Batches
List of credit batches in a given transfer.
curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/transfers/{id}/credit_batches \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'{
"nodes": [
{
"beneficiary": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"carbon_removal_data": {
"counterfactuals_kg": 123,
"emissions_kg": 123,
"gross_carbon_removed_kg": 123,
"losses_kg": 123,
"net_carbon_removed_kg": 123
},
"ccp_approved": true,
"country_of_issue": "GBR",
"id": "abc_1H0G39139CF0DZB2",
"issuance_id": "pfx_1H0G39139CF0DZB2",
"issued_at": "2023-11-07T05:31:56Z",
"left_child_id": "pfx_1H0G39139CF0DZB2",
"owner": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"parent_id": "pfx_1H0G39139CF0DZB2",
"project_id": "pfx_1H0G39139CF0DZB2",
"removal_id": "pfx_1H0G39139CF0DZB2",
"removal_location": {
"country_code": "<string>",
"country_name": "<string>"
},
"retired_at": "2023-11-07T05:31:56Z",
"retirement_id": "pfx_1H0G39139CF0DZB2",
"right_child_id": "pfx_1H0G39139CF0DZB2",
"sequestered_on": "2023-12-25",
"serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
"size": {
"credit_kgs": 125632,
"credits": 125.632
},
"status": "active",
"supplier_id": "pfx_1H0G39139CF0DZB2"
}
],
"total_count": 123
}Authorizations
A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
Headers
A secret token identifying the client connecting to the API
Path Parameters
Response
Carbon removal data for this credit batch
Whether this credit batch has been issued as part of a ICVCM Core Carbon Principles (CCP) approved project
320 - 3620 - 36If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.
20 - 36If this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.
20 - 3620 - 3620 - 3620 - 36If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.
20 - 36A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.
A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.
active, split, retired 20 - 36curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/transfers/{id}/credit_batches \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'{
"nodes": [
{
"beneficiary": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"carbon_removal_data": {
"counterfactuals_kg": 123,
"emissions_kg": 123,
"gross_carbon_removed_kg": 123,
"losses_kg": 123,
"net_carbon_removed_kg": 123
},
"ccp_approved": true,
"country_of_issue": "GBR",
"id": "abc_1H0G39139CF0DZB2",
"issuance_id": "pfx_1H0G39139CF0DZB2",
"issued_at": "2023-11-07T05:31:56Z",
"left_child_id": "pfx_1H0G39139CF0DZB2",
"owner": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"parent_id": "pfx_1H0G39139CF0DZB2",
"project_id": "pfx_1H0G39139CF0DZB2",
"removal_id": "pfx_1H0G39139CF0DZB2",
"removal_location": {
"country_code": "<string>",
"country_name": "<string>"
},
"retired_at": "2023-11-07T05:31:56Z",
"retirement_id": "pfx_1H0G39139CF0DZB2",
"right_child_id": "pfx_1H0G39139CF0DZB2",
"sequestered_on": "2023-12-25",
"serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
"size": {
"credit_kgs": 125632,
"credits": 125.632
},
"status": "active",
"supplier_id": "pfx_1H0G39139CF0DZB2"
}
],
"total_count": 123
}