Endpoints available for access tokens

These are endpoints that need no special permissions, only a valid access token. Can be an app access token or some installation access token.

Who can use these endpoints

You can use any access token to access these endpoints.

Projects

list projects

Returns a paginated list of all public projects on ICR.

Callable by any access token regardless of permissions.

curl -X 'GET' \
  'https://api.carbonregistry.com/projects?limit=10&page=0' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

list internal projects

Returns a paginated list of all projects on ICR.

Callable by any access token with permissions "examiner:read".

curl -X 'GET' \
  'https://api.carbonregistry.com/projects/internal?limit=10&page=0' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

get project based on credit serialization / creditId

If you have a creditId or a serialization for a credit you can use this endpoint to get the project that issued the credits.

Callable by any access token regardless of permissions.

curl -X 'GET' \
  'https://api.carbonregistry.com/projects/find/project?serialization=ICR-ISL-354-78040-14-R-0-2021&creditId=exPost-2-0x51298f2f1142ecb129a2db5e6afd24f34f2e53f1' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

specific project

This endpoint returns the project given the projectId.

Callable by any access token regardless of permissions.

curl -X 'GET' \
  'https://api.carbonregistry.com/projects/{PROJECT_ID}' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Retirements

Get retirement

Callable by any access token regardless of permissions. This endpoint returns the data connected to a particular retirement.

Get retirement pdf

Given an id of the retirement this is an endpoint that downloads the certificate.

Callable by any access token regardless of permissions.

Documents

Given the id of a project document (gotten from one of the project endpoints) you can supply that to this endpoint to get a link where you can download the document.

Callable by any access token regardless of permissions - unless the document is marked as private then only callable by access token with permissions "examiner:read".

curl -X 'GET' \
  'https://api.carbonregistry.com/projects/{PROJECT_ID}' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"\
  -H 'x-icr-api-version: 2023-06-16'

Last updated