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 endpoint returns a paginated list of the organization's inventory requests
The amount of items to return
10
The page to return
0
The organization's Id
123e4567-e89b-12d3-a456-426614174000
API version
2023-06-16
GET /organizations/{id}/inventory/requests HTTP/1.1
Host: api.carbonregistry.com
Accept: */*
{
"pagination": {
"total": 100,
"currentPage": 1,
"pageCount": 10,
"nextPage": 2,
"prevPage": 0
},
"creditRequests": [
{
"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"
}
]
}
This endpoint returns a specific organization's inventory request
API version
2023-06-16
GET /organizations/{id}/inventory/requests/{requestId} 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"
}
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"
}
This endpoint requests a specific action on 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/requests/{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"
}
This endpoint reviews a specific organization's credit action request
API version
2023-06-16
POST /organizations/{id}/inventory/request/{requestId}/review HTTP/1.1
Host: api.carbonregistry.com
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"state": "Accepted"
}
{
"id": "text"
}
Last updated