API

Every cdrplatform.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Cdr

price

cdr.price Calculate CO2 removal pricing for a method portfolio. Risk: read

await corsair.cdrplatform.api.cdr.price({});

Input

Name	Type	Required	Description
`weight_unit`	`g \| kg \| t`	Yes	—
`currency`	`usd \| eur \| gbp \| chf`	Yes	—
`items`	`object[]`	Yes	—

items full type

{
  method_type: string,
  cdr_amount: number
}[]

Output

Name	Type	Required	Description
`cost`	`object`	Yes	—
`currency`	`usd \| eur \| gbp \| chf`	Yes	—
`weight_unit`	`g \| kg \| t`	Yes	—

cost full type

{
  items: {
    method_type: string,
    cdr_amount: number,
    cost: number
  }[],
  removal: number,
  variable_fees: number,
  total: number
}

purchase

cdr.purchase Create a CO2 removal purchase request and return its transaction UUID. Risk: write

await corsair.cdrplatform.api.cdr.purchase({});

Input

Name	Type	Required	Description
`weight_unit`	`g \| kg \| t`	Yes	—
`currency`	`usd \| eur \| gbp \| chf`	Yes	—
`items`	`object[]`	Yes	—
`client_reference_id`	`string`	No	—
`certificate_display_name`	`string`	No	—

items full type

{
  method_type: string,
  cdr_amount: number
}[]

Output

Name	Type	Required	Description
`transaction_uuid`	`string`	Yes	—

Certificate

get

certificate.get Retrieve a removal certificate by certificate ID. Risk: read

await corsair.cdrplatform.api.certificate.get({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`certificate_id`	`string`	Yes	—
`display_name`	`string`	Yes	—
`issued_date`	`string`	Yes	—
`removal_amount_kg`	`number`	Yes	—

Health

check

health.check Check CDR Platform API health status. Risk: read

await corsair.cdrplatform.api.health.check({});

Input: empty object Output

Name	Type	Required	Description
`db_up`	`object`	Yes	—

db_up full type

{
}

Overview

Plugins

Cdr

price

purchase

Certificate

get

Health

check

​Cdr

​price

​purchase

​Certificate

​get

​Health

​check

Cdr

price

purchase

Certificate

get

Health

check