Documentation

Authorizations

Authorization

string

header

required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret

string

required

A secret token identifying the client connecting to the API

Path Parameters

string

required

Response

200 - application/json

project_balances

object[]

required

project_balances.project_id

string

required

Required string length: 20 - 36

project_balances.total

object

required

project_balances.total.active_credits_total

object

required

project_balances.total.active_credits_total.credit_kgs

integer

required

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.

project_balances.total.active_credits_total.credits

number

required

A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.

project_balances.total.retired_credits_total

object

required

project_balances.total.retired_credits_total.credit_kgs

integer

required

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.

project_balances.total.retired_credits_total.credits

number

required

A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.

supplier_balances

object[]

required

supplier_balances.supplier_id

string

required

Required string length: 20 - 36

supplier_balances.total

object

required

supplier_balances.total.active_credits_total

object

required

supplier_balances.total.active_credits_total.credit_kgs

integer

required

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.

supplier_balances.total.active_credits_total.credits

number

required

A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.

supplier_balances.total.retired_credits_total

object

required

supplier_balances.total.retired_credits_total.credit_kgs

integer

required

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.

supplier_balances.total.retired_credits_total.credits

number

required

A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.

total

object

required

total.active_credits_total

object

required

total.active_credits_total.credit_kgs

integer

required

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.

total.active_credits_total.credits

number

required

A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.

total.retired_credits_total

object

required

total.retired_credits_total.credit_kgs

integer

required

A representation of the credit quantity as an integer kilogram amount. Where 1 unit represents 0.001 credits and 1 kilogram of CO₂e.

total.retired_credits_total.credits

number

required

A representation of the credit quantity as a fractional amount, to 3 decimal places. Where 1 unit represents 1 credit and 1 ton of CO₂e.

Getting Started

Public Registry Data

Buyer Account Management

Supplier Account Management

Organisation Credit Balance

Authorizations

Headers

Path Parameters

Response