- Documentation
- Homepage
- Registry
- GETBeneficiaries
- GETCredit Batch
- POSTCreate Delivery
- GETDelivery
- GETDelivery Credit Batches
- GETIssuance
- GETIssuance Credit Batches
- GETOrder
- GETOrder Deliveries
- GETCurrent Organisation
- GETOrganisation
- GETOrganisation Credit Balance
- GETOrganisation Credit Batches
- GETProject
- POSTCreate Retirement
- GETRetirement
- GETRetirement Credit Batches
- GETCurrent Supplier
- GETSupplier
- GETSupplier Deliveries
- GETSupplier Issuances
- GETSupplier Orders
- GETSupplier Projects
- GETTransferees
- POSTCreate Transfer
- GETTransfer
- GETTransfer Credit Batches
Registry API
Issuance Credit Batches
An JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
A secret token identifying the client connecting to the API
curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/issuances/{id}/credit_batches \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'{
"buffer_pool_credit_batch_size_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"buffer_pool_credit_batches": [
{
"beneficiary": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"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",
"retired_at": "2023-11-07T05:31:56Z",
"retirement_id": "pfx_1H0G39139CF0DZB2",
"right_child_id": "pfx_1H0G39139CF0DZB2",
"sequestered_at": "2023-11-07T05:31:56Z",
"serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
"size": {
"credit_kgs": 125632,
"credits": 125.632
},
"status": "active"
}
],
"credit_batch_size_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"issuance_id": "pfx_1H0G39139CF0DZB2",
"supplier_credit_batch_size_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"supplier_credit_batches": [
{
"beneficiary": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"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",
"retired_at": "2023-11-07T05:31:56Z",
"retirement_id": "pfx_1H0G39139CF0DZB2",
"right_child_id": "pfx_1H0G39139CF0DZB2",
"sequestered_at": "2023-11-07T05:31:56Z",
"serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
"size": {
"credit_kgs": 125632,
"credits": 125.632
},
"status": "active"
}
]
}Authorizations
An 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
A 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.
If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.
If this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.
If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.
A 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 A 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.
A 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.
If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.
If this credit batch was created from splitting a larger batch in two, this will be set to the id of the parent credit batch.
If this credit batch has status SPLIT, it will have two child batches representing the two halves of this split.
A 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 curl --request GET \
--url https://api.sandbox.isometric.com/registry/v0/issuances/{id}/credit_batches \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>'{
"buffer_pool_credit_batch_size_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"buffer_pool_credit_batches": [
{
"beneficiary": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"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",
"retired_at": "2023-11-07T05:31:56Z",
"retirement_id": "pfx_1H0G39139CF0DZB2",
"right_child_id": "pfx_1H0G39139CF0DZB2",
"sequestered_at": "2023-11-07T05:31:56Z",
"serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
"size": {
"credit_kgs": 125632,
"credits": 125.632
},
"status": "active"
}
],
"credit_batch_size_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"issuance_id": "pfx_1H0G39139CF0DZB2",
"supplier_credit_batch_size_total": {
"credit_kgs": 125632,
"credits": 125.632
},
"supplier_credit_batches": [
{
"beneficiary": {
"domain": "isometric.com",
"id": "abc_1H0G39139CF0DZB2",
"name": "Isometric"
},
"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",
"retired_at": "2023-11-07T05:31:56Z",
"retirement_id": "pfx_1H0G39139CF0DZB2",
"right_child_id": "pfx_1H0G39139CF0DZB2",
"sequestered_at": "2023-11-07T05:31:56Z",
"serial_number": "ISO-1-BSTORE-GBR-F5X7-2024-78177-81177",
"size": {
"credit_kgs": 125632,
"credits": 125.632
},
"status": "active"
}
]
}