Organizations
Information
Metadata for an organization.
This endpoint returns an organization
API version
2023-06-16
GET /organizations/{id} HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"fullName": "Organization 1",
"countryCode": "US",
"city": "New York",
"zip": "10001",
"physicalAddress": "123 Main St",
"registrationNumber": "123456",
"website": "http://example.com",
"logo": "logo.png",
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationIndustries": {
"code": "IND1",
"name": "Industry 1"
},
"type": "projectProponent",
"isPublic": true,
"url": "https://api.carbonregistry.com/app/organizations/123e4567-e89b-12d3-a456-426614174000"
}
Gets base information on a specific organization.
Callable by any access token with permissions "organization_info:read".
curl -X 'GET' \
'https://api.carbonregistry.com/organizations/{ORG_ID}' \
-H 'accept: application/json' \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
-H 'x-icr-api-version: 2023-06-16'
Organization's Inventory Accounts
Returns the inventory accounts that this organization owns. Default and subaccounts.
This endpoint returns an organization's public evm addresses
API version
2023-06-16
GET /organizations/{id}/addresses HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"fullName": "Organization 1",
"countryCode": "US",
"city": "New York",
"zip": "10001",
"physicalAddress": "123 Main St",
"registrationNumber": "123456",
"website": "http://example.com",
"logo": "logo.png",
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationIndustries": {
"code": "IND1",
"name": "Industry 1"
},
"type": "projectProponent",
"isPublic": true,
"url": "https://api.carbonregistry.com/app/organizations/123e4567-e89b-12d3-a456-426614174000"
}
Gets the public wallet addresses of an organization. Mainly used for getting addresses to deposit credits into or to get inventory data for subaccounts.
Callable by any access token with permissions "organization_info:read".
curl -X 'GET' \
'https://api.carbonregistry.com/organizations/{ORG_ID}/addresses' \
-H 'accept: application/json' \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
-H 'x-icr-api-version: 2023-06-16'
Organization Inventory
This is the main inventory of an organization. Currently only "read" and "read and request" access are available for the inventory. The "read and request" access gives an app the permission to make transfer / retirement requests toward the credits in the organization's inventory.
This endpoint returns a list of the organization's inventory
If defined returns the development inventory
API version
2023-06-16
GET /organizations/{id}/inventory HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"credits": [
{
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"id": "exPost-2-0x1234567890abcdef",
"tokenId": "abcdef",
"tokenAddress": "0x1234567890abcdef",
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"fullName": "Project 1",
"url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
"publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
"num": "713"
},
"serialization": "ICR-ISL-354-78040-14-R-0-2021",
"vintage": "2020",
"supply": 1000,
"unit": "tonne",
"amount": 100,
"type": "exAnte"
}
],
"organizationId": "123e4567-e89b-12d3-a456-426614174000"
}
This returns all the credits in an organization's inventory.
Callable by any access token with permissions "organization_inventory:read".
curl -X 'GET' \
'https://api.carbonregistry.com/organizations/{ORG_ID}/inventory' \
-H 'accept: application/json' \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
-H 'x-icr-api-version: 2023-06-16'
This endpoint creates a transaction for credits in the organization's inventory
The action to perform on the token credit, one of transfer, retire, transfer_retire, cancel
The ID of the organization
123e4567-e89b-12d3-a456-426614174000
API version
2023-06-16
The ID of the token credit
exPost-2-0x1234567890abcdef
The amount of the token credit
100
The ID of the organization receiving the token credit - if not provided, toAddress must be provided
123e4567-e89b-12d3-a456-426614174000
The address of the organization receiving the token credit - if not provided, toOrganizationId must be provided
0x1234567890abcdef
The retirement data associated with the token credit - only required for retirements
POST /organizations/{id}/inventory/action/{action} HTTP/1.1
Host: api.carbonregistry.com
Content-Type: application/json
Accept: */*
Content-Length: 253
{
"creditId": "exPost-2-0x1234567890abcdef",
"amount": 100,
"toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"toAddress": "0x1234567890abcdef",
"retirementData": {
"reason": "Retirement reason",
"beneficiaryName": "John Doe",
"comment": "This is a comment"
}
}
{
"action": "transfer",
"type": "exAnte",
"id": "123e4567-e89b-12d3-a456-426614174000",
"toAddress": "0x1234567890abcdef",
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"tokenId": "123e4567-e89b-12d3-a456-426614174000",
"tokenAddress": "0x1234567890abcdef",
"creditId": "exPost-2-0x1234567890abcdef",
"serialization": "serialization",
"vintage": "2020",
"amount": 1000,
"fromOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"fullName": "Project 1",
"url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
"publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
"num": "713"
},
"txId": "0x1234567890abcdef",
"state": "processed",
"transactionData": {
"creditId": "text",
"tokenId": "text",
"amount": 1,
"serialization": "text"
},
"retirementId": "1",
"retirementReason": "reason",
"retirementComment": "comment",
"beneficiaryName": "John Doe"
}
Creates a "transfer" / "retire" / "transfer_retire" transaction and puts it in the processing queue. To monitor the state of the transaction you can query the transaction endpoint.
Callable by any access token with permissions "organization_inventory:read_write".
curl -X 'POST' \
'https://api.carbonregistry.com/organizations/{ORG_ID}/inventory/action/{REQUEST_ACTION}' \
-H 'accept: application/json' \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
-H 'x-icr-api-version: 2023-06-16' \
-H 'Content-Type: application/json' \
-d '{
"creditId": "exPost-2-0x1234567890abcdef",
"amount": 100,
"toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"toAddress": "0x1234567890abcdef",
"retirementData": {
"reason": "Retirement reason",
"beneficiaryName": "John Doe",
"comment": "This is a comment"
}
}'
This endpoint returns an organization's transaction
API version
2023-06-16
GET /organizations/{id}/transactions/{transactionId} HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"action": "transfer",
"type": "exAnte",
"id": "123e4567-e89b-12d3-a456-426614174000",
"toAddress": "0x1234567890abcdef",
"createdAt": "2022-01-01T00:00:00Z",
"updatedAt": "2022-01-01T00:00:00Z",
"tokenId": "123e4567-e89b-12d3-a456-426614174000",
"tokenAddress": "0x1234567890abcdef",
"creditId": "exPost-2-0x1234567890abcdef",
"serialization": "serialization",
"vintage": "2020",
"amount": 1000,
"fromOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"toOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
"project": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"fullName": "Project 1",
"url": "https://api.carbonregistry.com/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
"publicUrl": "https://carbonregistry.com/explore/projects/47abd663-fb35-4b2e-ad08-c347e761649e",
"num": "713"
},
"txId": "0x1234567890abcdef",
"state": "processed",
"transactionData": {
"creditId": "text",
"tokenId": "text",
"amount": 1,
"serialization": "text"
},
"retirementId": "1",
"retirementReason": "reason",
"retirementComment": "comment",
"beneficiaryName": "John Doe"
}
Gets a specific transaction.
Callable by any access token with permissions "organization_inventory:read".
curl -X 'GET' \
'https://api.carbonregistry.com/organizations/{ORG_ID}/inventory/transactions/{TRANSACTION_ID}' \
-H 'accept: application/json' \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
-H 'x-icr-api-version: 2023-06-16'
Testing endpoints
friendbot - test credits
This endpoint sends 100 credits to the organization account that owns the calling api key. Only on testnet.
API version
2023-06-16
GET /organizations/{id}/friendbot HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"serialization": "ICR-ALB-355-77993-2-A-0-2023",
"amount": 1000,
"transactionId": "0xcc73d182db1f36dbadf14205de7d543cfd1343396b50d34c768529aaab46a1c0"
}
To get some test credits into your organization on the sandbox you can use this endpoint with and organization Id that you control. It will deposit a 100 credits into your organization.
Callable by any access token regardless of permissions.
curl -X 'GET' \
'https://api.carbonregistry.com/organizations/{ORG_ID}/friendbot' \
-H 'accept: application/json' \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
-H 'x-icr-api-version: 2023-06-16'
Last updated