Home Projects Credits Transactions Insights

Inventory

PreviousOrganizations NextProjects

Last updated 1 month ago

Get organization inventory

This endpoint returns a list of the organization's inventory

get

/organizations/{id}/inventory

Path parameters

idstringrequired

Query parameters

developmentstring

If defined returns the development inventory

Header parameters

x-icr-api-versionstring · default: 2023-06-16

API version

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.carbonregistry.com/organizations/{id}/inventory'

200

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "credits": [
    {
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "id": "exPost-2-0x1234567890abcdef",
      "tokenId": "abcdef",
      "tokenAddress": "0x1234567890abcdef",
      "serialization": "ICR-ISL-354-78040-14-R-0-2021",
      "vintage": "2020",
      "supply": 1000,
      "unit": "tonne",
      "amount": 100,
      "type": "exAnte",
      "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"
      }
    }
  ]
}

Get organization inventory requests

This endpoint returns a paginated list of the organization's inventory requests

get

/organizations/{id}/inventory/requests

Path parameters

limitnumberrequired

The amount of items to return

Example: 10

pagenumberrequired

The page to return

Example: 0

idstringrequired

The organization's Id

Example: 123e4567-e89b-12d3-a456-426614174000

statesstring · enum[]required

Header parameters

x-icr-api-versionstring · default: 2023-06-16

API version

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.carbonregistry.com/organizations/{id}/inventory/requests'

200

{
  "pagination": {
    "total": 100,
    "currentPage": 1,
    "pageCount": 10,
    "nextPage": 2,
    "prevPage": 0
  },
  "creditRequests": [
    {
      "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",
      "txId": "0x1234567890abcdef",
      "retirementId": "1",
      "retirementReason": "reason",
      "retirementComment": "comment",
      "beneficiaryName": "John Doe",
      "action": "transfer",
      "type": "exAnte",
      "state": "processed",
      "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"
      },
      "transactionData": {
        "creditId": "text",
        "tokenId": "text",
        "amount": 1,
        "serialization": "text"
      }
    }
  ]
}

Get organization inventory request

This endpoint returns a specific organization's inventory request

get

/organizations/{id}/inventory/requests/{requestId}

Path parameters

idstringrequired

requestIdstringrequired

Header parameters

x-icr-api-versionstring · default: 2023-06-16

API version

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.carbonregistry.com/organizations/{id}/inventory/requests/{requestId}'

200

{
  "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",
  "txId": "0x1234567890abcdef",
  "retirementId": "1",
  "retirementReason": "reason",
  "retirementComment": "comment",
  "beneficiaryName": "John Doe",
  "action": "transfer",
  "type": "exAnte",
  "state": "processed",
  "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"
  },
  "transactionData": {
    "creditId": "text",
    "tokenId": "text",
    "amount": 1,
    "serialization": "text"
  }
}

Transact with credits in inventory

This endpoint creates a transaction for credits in the organization's inventory

post

/organizations/{id}/inventory/action/{action}

Path parameters

actionstring · enumrequired

The action to perform on the token credit, one of transfer, retire, transfer_retire, cancel

Options: transfer, retire, transfer_retire, cancel, issuance, receive, claim, create_project, create_vintages

idstringrequired

The ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-icr-api-versionstring · default: 2023-06-16

API version

Body

creditIdstringrequired

The ID of the token credit

Example: exPost-2-0x1234567890abcdef

amountnumberrequired

The amount of the token credit

Example: 100

toOrganizationIdstring

The ID of the organization receiving the token credit - if not provided, toAddress must be provided

Example: 123e4567-e89b-12d3-a456-426614174000

toAddressstring

The address of the organization receiving the token credit - if not provided, toOrganizationId must be provided

Example: 0x1234567890abcdef

retirementDataall of

The retirement data associated with the token credit - only required for retirements

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.carbonregistry.com/organizations/{id}/inventory/action/{action}' \
  --header 'Content-Type: application/json' \
  --data '{"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"}}'

200

{
  "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",
  "txId": "0x1234567890abcdef",
  "retirementId": "1",
  "retirementReason": "reason",
  "retirementComment": "comment",
  "beneficiaryName": "John Doe",
  "action": "transfer",
  "type": "exAnte",
  "state": "processed",
  "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"
  },
  "transactionData": {
    "creditId": "text",
    "tokenId": "text",
    "amount": 1,
    "serialization": "text"
  }
}

Request movements of credits in inventory

This endpoint requests a specific action on credits in the organization's inventory

post

/organizations/{id}/inventory/requests/{action}

Path parameters

actionstring · enumrequired

The action to perform on the token credit, one of transfer, retire, transfer_retire, cancel

Options: transfer, retire, transfer_retire, cancel, issuance, receive, claim, create_project, create_vintages

idstringrequired

The ID of the organization

Example: 123e4567-e89b-12d3-a456-426614174000

Header parameters

x-icr-api-versionstring · default: 2023-06-16

API version

Body

creditIdstringrequired

The ID of the token credit

Example: exPost-2-0x1234567890abcdef

amountnumberrequired

The amount of the token credit

Example: 100

toOrganizationIdstring

The ID of the organization receiving the token credit - if not provided, toAddress must be provided

Example: 123e4567-e89b-12d3-a456-426614174000

toAddressstring

The address of the organization receiving the token credit - if not provided, toOrganizationId must be provided

Example: 0x1234567890abcdef

retirementDataall of

The retirement data associated with the token credit - only required for retirements

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.carbonregistry.com/organizations/{id}/inventory/requests/{action}' \
  --header 'Content-Type: application/json' \
  --data '{"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"}}'

200

{
  "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",
  "txId": "0x1234567890abcdef",
  "retirementId": "1",
  "retirementReason": "reason",
  "retirementComment": "comment",
  "beneficiaryName": "John Doe",
  "action": "transfer",
  "type": "exAnte",
  "state": "processed",
  "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"
  },
  "transactionData": {
    "creditId": "text",
    "tokenId": "text",
    "amount": 1,
    "serialization": "text"
  }
}

Review a credit action request

This endpoint reviews a specific organization's credit action request

post

/organizations/{id}/inventory/request/{requestId}/review

Path parameters

idstringrequired

requestIdstringrequired

Header parameters

x-icr-api-versionstring · default: 2023-06-16

API version

Body

statestring · enumrequired

Options: Accepted, Pending, Rejected

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.carbonregistry.com/organizations/{id}/inventory/request/{requestId}/review' \
  --header 'Content-Type: application/json' \
  --data '{"state":"Accepted"}'

200

{
  "id": "text"
}