Inventory

Get organization inventory

This endpoint returns a list of the organization's inventory

GEThttps://api.carbonregistry.com/organizations/{id}/inventory

Path parameters

id*string

Query parameters

Header parameters

Response

200

Body

application/json

credits*array of ApiInventoryCreditDto (object)

organizationId*string

The ID of the organization

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

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/organizations/{id}/inventory', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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

GEThttps://api.carbonregistry.com/organizations/{id}/inventory/requests

Path parameters

limit*number

The amount of items to return

Example: 10

page*number

The page to return

Example: 0

id*string

The organization's Id

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

states*array of enum

Header parameters

Response

200

Body

application/json

pagination*ApiPaginationDto (object)

creditRequests*array of ApiCreditRequestDto (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/organizations/{id}/inventory/requests', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": 0,
        "serialization": "text"
      },
      "retirementId": "1",
      "retirementReason": "reason",
      "retirementComment": "comment",
      "beneficiaryName": "John Doe"
    }
  ]
}

Get organization inventory request

This endpoint returns a specific organization's inventory request

GEThttps://api.carbonregistry.com/organizations/{id}/inventory/requests/{requestId}

Path parameters

id*string

requestId*string

Header parameters

Response

200

Body

application/json

action*enum

Action of the credit request

transferretiretransfer_retirecancelissuancereceiveclaimcreate_projectcreate_vintages

type*enum

Type of the credit request

exAnteexPostretirementCertificate

id*string

ID of the credit request

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

toAddressstring

Address of the recipient of the credit request

Example: "0x1234567890abcdef"

createdAt*string (date-time)

Timestamp of when the credit request was created

Example: "2022-01-01T00:00:00Z"

updatedAt*string (date-time)

Timestamp of when the credit request was last updated

Example: "2022-01-01T00:00:00Z"

tokenId*string

ID of the token associated with the credit request

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

tokenAddress*string

Address of the token associated with the credit request

Example: "0x1234567890abcdef"

creditId*string

ID of the credit associated with the credit request

Example: "exPost-2-0x1234567890abcdef"

serialization*string

Serialization of the credit request

Example: "serialization"

vintage*string

The vintage year of the credit

Example: "2020"

amount*number

Amount of the credit request

Example: 1000

fromOrganizationId*string

ID of the organization sending the credit request

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

toOrganizationIdstring

ID of the organization receiving the credit request

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

project*all of

Project information associated with the credit request

txIdstring

ID of the transaction associated with the credit request

Example: "0x1234567890abcdef"

state*enum

State of the credit request: cancelled | failed | pending_onchain | pending_queue | pending_request | pending_reserved | processed | rejected

processedfailedpending_queuepending_onchainpending_requestrejectedpending_reservedcancelled

transactionDataall of

The data for this transaction

retirementIdstring

The retirement ID of the reservation

Example: "1"

retirementReasonstring

Reason for retirement of the credit request

Example: "reason"

retirementCommentstring

Comment for retirement of the credit request

Example: "comment"

beneficiaryNamestring

Name of the beneficiary of the credit request

Example: "John Doe"

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/organizations/{id}/inventory/requests/{requestId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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": 0,
    "serialization": "text"
  },
  "retirementId": "1",
  "retirementReason": "reason",
  "retirementComment": "comment",
  "beneficiaryName": "John Doe"
}

Transact with credits in inventory

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

POSThttps://api.carbonregistry.com/organizations/{id}/inventory/action/{action}

Path parameters

action*enum

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

transferretiretransfer_retirecancelissuancereceiveclaimcreate_projectcreate_vintages

id*string

The ID of the organization

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

Header parameters

Body

application/json

creditId*string

The ID of the token credit

Example: "exPost-2-0x1234567890abcdef"

amount*number

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

Response

200

Body

application/json

action*enum

Action of the credit request

transferretiretransfer_retirecancelissuancereceiveclaimcreate_projectcreate_vintages

type*enum

Type of the credit request

exAnteexPostretirementCertificate

id*string

ID of the credit request

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

toAddressstring

Address of the recipient of the credit request

Example: "0x1234567890abcdef"

createdAt*string (date-time)

Timestamp of when the credit request was created

Example: "2022-01-01T00:00:00Z"

updatedAt*string (date-time)

Timestamp of when the credit request was last updated

Example: "2022-01-01T00:00:00Z"

tokenId*string

ID of the token associated with the credit request

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

tokenAddress*string

Address of the token associated with the credit request

Example: "0x1234567890abcdef"

creditId*string

ID of the credit associated with the credit request

Example: "exPost-2-0x1234567890abcdef"

serialization*string

Serialization of the credit request

Example: "serialization"

vintage*string

The vintage year of the credit

Example: "2020"

amount*number

Amount of the credit request

Example: 1000

fromOrganizationId*string

ID of the organization sending the credit request

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

toOrganizationIdstring

ID of the organization receiving the credit request

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

project*all of

Project information associated with the credit request

txIdstring

ID of the transaction associated with the credit request

Example: "0x1234567890abcdef"

state*enum

State of the credit request: cancelled | failed | pending_onchain | pending_queue | pending_request | pending_reserved | processed | rejected

processedfailedpending_queuepending_onchainpending_requestrejectedpending_reservedcancelled

transactionDataall of

The data for this transaction

retirementIdstring

The retirement ID of the reservation

Example: "1"

retirementReasonstring

Reason for retirement of the credit request

Example: "reason"

retirementCommentstring

Comment for retirement of the credit request

Example: "comment"

beneficiaryNamestring

Name of the beneficiary of the credit request

Example: "John Doe"

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/organizations/{id}/inventory/action/{action}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "creditId": "exPost-2-0x1234567890abcdef",
      "amount": 100
    }),
});
const data = await response.json();

Response

200

{
  "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": 0,
    "serialization": "text"
  },
  "retirementId": "1",
  "retirementReason": "reason",
  "retirementComment": "comment",
  "beneficiaryName": "John Doe"
}

Request movements of credits in inventory

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

POSThttps://api.carbonregistry.com/organizations/{id}/inventory/requests/{action}

Path parameters

action*enum

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

transferretiretransfer_retirecancelissuancereceiveclaimcreate_projectcreate_vintages

id*string

The ID of the organization

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

Header parameters

Body

application/json

creditId*string

The ID of the token credit

Example: "exPost-2-0x1234567890abcdef"

amount*number

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

Response

200

Body

application/json

action*enum

Action of the credit request

transferretiretransfer_retirecancelissuancereceiveclaimcreate_projectcreate_vintages

type*enum

Type of the credit request

exAnteexPostretirementCertificate

id*string

ID of the credit request

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

toAddressstring

Address of the recipient of the credit request

Example: "0x1234567890abcdef"

createdAt*string (date-time)

Timestamp of when the credit request was created

Example: "2022-01-01T00:00:00Z"

updatedAt*string (date-time)

Timestamp of when the credit request was last updated

Example: "2022-01-01T00:00:00Z"

tokenId*string

ID of the token associated with the credit request

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

tokenAddress*string

Address of the token associated with the credit request

Example: "0x1234567890abcdef"

creditId*string

ID of the credit associated with the credit request

Example: "exPost-2-0x1234567890abcdef"

serialization*string

Serialization of the credit request

Example: "serialization"

vintage*string

The vintage year of the credit

Example: "2020"

amount*number

Amount of the credit request

Example: 1000

fromOrganizationId*string

ID of the organization sending the credit request

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

toOrganizationIdstring

ID of the organization receiving the credit request

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

project*all of

Project information associated with the credit request

txIdstring

ID of the transaction associated with the credit request

Example: "0x1234567890abcdef"

state*enum

State of the credit request: cancelled | failed | pending_onchain | pending_queue | pending_request | pending_reserved | processed | rejected

processedfailedpending_queuepending_onchainpending_requestrejectedpending_reservedcancelled

transactionDataall of

The data for this transaction

retirementIdstring

The retirement ID of the reservation

Example: "1"

retirementReasonstring

Reason for retirement of the credit request

Example: "reason"

retirementCommentstring

Comment for retirement of the credit request

Example: "comment"

beneficiaryNamestring

Name of the beneficiary of the credit request

Example: "John Doe"

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/organizations/{id}/inventory/requests/{action}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "creditId": "exPost-2-0x1234567890abcdef",
      "amount": 100
    }),
});
const data = await response.json();

Response

200

{
  "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": 0,
    "serialization": "text"
  },
  "retirementId": "1",
  "retirementReason": "reason",
  "retirementComment": "comment",
  "beneficiaryName": "John Doe"
}

Review a credit action request

This endpoint reviews a specific organization's credit action request

POSThttps://api.carbonregistry.com/organizations/{id}/inventory/request/{requestId}/review

Path parameters

id*string

requestId*string

Header parameters

Body

application/json

state*enum

AcceptedPendingRejected

Response

200

Body

application/json

id*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.carbonregistry.com/organizations/{id}/inventory/request/{requestId}/review', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "state": "Accepted"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text"
}