Inventory | ICR Program

ICR Program

Home Projects Credits Transactions Insights

Get organization inventory

get

This endpoint returns a list of the organization's inventory

Path parameters

idstringRequired

Query parameters

developmentstringOptional

If defined returns the development inventory

Header parameters

x-icr-api-versionstringOptional

API version

Default: 2023-06-16

Responses

get

GET /organizations/{id}/inventory HTTP/1.1
Host: api.carbonregistry.com
Accept: */*

200Success

{
  "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"
}

Get organization inventory requests

get

This endpoint returns a paginated list of the organization's 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

Header parameters

x-icr-api-versionstringOptional

API version

Default: 2023-06-16

Responses

get

GET /organizations/{id}/inventory/requests HTTP/1.1
Host: api.carbonregistry.com
Accept: */*

200Success

{
  "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"
    }
  ]
}

Get organization inventory request

get

This endpoint returns a specific organization's inventory request

Path parameters

idstringRequired

requestIdstringRequired

Header parameters

x-icr-api-versionstringOptional

API version

Default: 2023-06-16

Responses

get

GET /organizations/{id}/inventory/requests/{requestId} HTTP/1.1
Host: api.carbonregistry.com
Accept: */*

200Success

{
  "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"
}

Transact with credits in inventory

post

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

Path parameters

actionstring · enumRequired

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

Possible values:

idstringRequired

The ID of the organization

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

Header parameters

x-icr-api-versionstringOptional

API version

Default: 2023-06-16

Body

creditIdstringRequired

The ID of the token credit

Example: exPost-2-0x1234567890abcdef

amountnumberRequired

The amount of the token credit

Example: 100

toOrganizationIdstringOptional

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

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

toAddressstringOptional

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

Example: 0x1234567890abcdef

retirementDataall ofOptional

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

Responses

post

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"
  }
}

200Success

{
  "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"
}

Request movements of credits in inventory

post

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

Path parameters

actionstring · enumRequired

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

Possible values:

idstringRequired

The ID of the organization

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

Header parameters

x-icr-api-versionstringOptional

API version

Default: 2023-06-16

Body

creditIdstringRequired

The ID of the token credit

Example: exPost-2-0x1234567890abcdef

amountnumberRequired

The amount of the token credit

Example: 100

toOrganizationIdstringOptional

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

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

toAddressstringOptional

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

Example: 0x1234567890abcdef

retirementDataall ofOptional

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

Responses

post

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"
  }
}

200Success

{
  "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"
}

Review a credit action request

post

This endpoint reviews a specific organization's credit action request

Path parameters

idstringRequired

requestIdstringRequired

Header parameters

x-icr-api-versionstringOptional

API version

Default: 2023-06-16

Body

statestring · enumRequiredPossible values:

Responses

post

POST /organizations/{id}/inventory/request/{requestId}/review HTTP/1.1
Host: api.carbonregistry.com
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "state": "Accepted"
}

200Success

{
  "id": "text"
}