The Climate product object
Attributes
- id string Unique identifier for the object. For convenience, Climate product IDs are human-readable strings that start with
climsku_. See carbon removal inventory for a list of available carbon removal products. - object string, value is "climate.product" String representing the object’s type. Objects of the same type share the same value.
- created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
- current _ prices _ per _ metric _ ton map Current prices for a metric ton of carbon removal in a currency’s smallest unit.
- delivery _ year nullable integer The year in which the carbon removal is expected to be delivered. If the year is in the past, this represents spot inventory with guaranteed delivery.
- livemode boolean Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - metric _ tons _ available decimal string The quantity of metric tons available for reservation.
- name string The Climate product’s name.
- suppliers array of objects The carbon removal suppliers that fulfill orders for this Climate product.
The Climate product object
Retrieve a product
GET / v1 / climate / products /:id
Retrieves the details of a Climate product with the given ID.
Parameters
No parameters.
Returns
Returns a Climate product object if a valid identifier was provided. Throws an error otherwise.
Response
List products
GET / v1 / climate / products
Lists all available Climate product objects.
Parameters
No parameters.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit products, starting after product starting_after. Each entry in the array is a separate product object. If no more products are available, the resulting array is empty.
Response