API reference
Project Filters and Search
ProjectFilter
The ProjectFilter input type allows filtering projects based on various criteria.
cmhq_project_id
List[str]
Filter projects by their unique identifier assigned by CarbonMarketsHQ.
project_id
List[str]
Filter projects by their identifier assigned by the registry.
current_registry
List[str]
Filter projects by the name of the current registry hosting the project.
registry_of_origin
List[str]
Filter projects by the name of the registry where the project was previously listed.
program
List[str]
Filter projects by the programmatic structure used by the registry.
project_name
List[str]
Filter projects by their name in the hosting registry.
project_developer
List[str]
Filter projects by the names of developers involved.
sector
List[str]
Filter projects by the industry sector(s) they target.
project_type
List[str]
Filter projects by the registry-specified descriptor(s) of the project type.
project_tags
List[str]
Filter projects by the registry-defined, searchable metadata tags.
project_status
List[str]
Filter projects by their current status.
validation_body
List[str]
Filter projects by the name of the VVB.
SearchQuery
The SearchQuery input type allows searching projects based on a search string.
search_string
str
The search string to match against project fields.
ProjectAggregate
The ProjectAggregate type represents aggregated information about projects.
count
int
The total count of projects matching the filter criteria.
facets
List[Facet]
A list of facets providing additional aggregated information.
Facet
The Facet type represents a facet of project data.
key
str
The key or name of the facet.
values
List[FacetValue]
A list of facet values associated with the facet key.
FacetValue
The FacetValue type represents a value within a facet.
value
str
The value of the facet.
count
int
The count of projects associated with the facet value.
Response Fields
Project
The Project type represents a carbon project.
cmhq_project_id
str
The unique identifier of the project assigned by CarbonMarketsHQ.
project_id
str
The identifier of the project assigned by the registry.
current_registry
Registries
The name of the current registry hosting the project.
registry_of_origin
Registries
The name of the registry where the project was previously listed.
program
str
The programmatic structure used by the registry.
project_name
str
The name of the project in the hosting registry.
project_description
str
A description of the project for external viewers.
project_link
str
The URL link to the project on the registry's website.
project_developer
str
The names of developers involved in the project.
sector
ProjectSector
The industry sector(s) that the project is targeting.
project_type
ProjectType
The registry-specified descriptor(s) of the project type.
project_tags
List[str]
A collection of registry-defined, searchable metadata tags.
covered_by_ndc
CoveredByNDC
A flag indicating whether the project is covered under the country's NDCs.
ndc_information
str
Registry-specified description of how the project falls under the country's NDC.
project_status
ProjectStatusValues
The current status of the project.
project_status_date
datetime
The calendar date when the project status was last updated.
unit_metric
UnitMetric
The metric used to assess the outcomes produced by the project.
methodology
str
The monitoring methodology used for calculating outcomes.
validation_body
str
The name of the validating organization.
validation_date
datetime
The calendar date the project was validated by the validating organization.
created_ts
datetime
The timestamp indicating when the project record was created.
updated_ts
datetime
The timestamp indicating when the project record was last updated.
compliance_program_status
str
The compliance program status of the project.
compliance_program_id
str
The identifier of the compliance program associated with the project.
related_projects
List[RelatedProject]
A list of related projects.
units
List[Unit]
A list of units associated with the project.
labels
List[Label]
A list of labels associated with the project.
co_benefits
List[CoBenefit]
A list of co-benefits associated with the project.
project_location
List[ProjectLocation]
The location(s) of the project.
project_rating
List[ProjectRating]
The rating(s) of the project.
estimations
List[Estimation]
A list of estimations associated with the project.
Unit
The Unit type represents a group of issued/retired/cancelled credits.
unit_issuance_location
str
The location where the units were issued.
unit_owner
str
The name of the legal organization/country that owns the units.
country_jurisdiction_of_owner
str
The name of the country jurisdiction that applies to the unit owner organization.
in_country_jurisdiction_of_owner
str
The regional or sub-national jurisdiction that applies to the unit owner organization.
unit_block_start
str
The first serial number in a sequential collection of unit serial numbers.
unit_block_end
str
The last serial number in a sequential collection of unit serial numbers.
unit_count
int
The count of units in the issued block.
vintage_year
int
The year (or vintage) when the units were awarded.
unit_type
str
The type of outcome achieved (e.g., reduction, removal).
marketplace
str
The exchange, token, or other location where the block of units can be purchased.
marketplace_link
str
The URL hyperlink to the marketplace hosting the units.
marketplace_identifier
str
The identifier of the units in the marketplace.
unit_tags
str
Additional attributes associated with the units.
unit_status
UnitStatus
The unit status within its lifecycle.
unit_status_reason
str
The reason for the particular unit status being used.
unit_registry_link
str
The URL hyperlink to information about the units.
corresponding_adjustment_declaration
CorrespondingAdjustmentDeclaration
The determination of whether a corresponding adjustment is needed or not.
corresponding_adjustment_status
CorrespondingAdjustmentStatus
The information on whether the unit adjustment has taken place or not.
updated_ts
datetime
The timestamp indicating when the unit record was last updated.
unit_name
str
The name of the unit.
issuance_info
IssuanceInfo
Information about the issuance of the units.
issuance_date
datetime
The date when the units were issued.
last_status_update
datetime
The date of the last status update for the units.
unit_status_time
datetime
The timestamp indicating when the unit status was last updated.
buffer_count
int
The count of units in the buffer account.
IssuanceInfo
The IssuanceInfo type represents information about the issuance of units. May be thought as similar to a monitoring period.
issuance_id
str
The unique identifier for the issuance.
issuance_start_date
datetime
The start date for the issuance period.
issuance_end_date
datetime
The end date for the issuance period.
verification_approach
str
The verification approach used for the units in the issuance period.
verification_report_date
datetime
The date when the verification was completed for the issuance.
verification_body
str
The validating body that performed the verification for the issuance.
vintage_year
int
The vintage year of the units in the issuance.
RelatedProject
The RelatedProject type represents a related project.
related_project_id
int
The identifier of the related project.
relationship_type
str
The type of relationship between the projects.
registry
str
The registry that houses the related project.
Label
The Label type represents a label associated with a project.
label_id
str
The unique identifier for the label.
label_type
LabelType
The type of label being applied(e.g., endorsement, letter of qualification, letter of authorization, letter of approval)
label
str
The name of the label being applied.
crediting_period_start_date
datetime
The start date for the period of time during which units are being credited.
crediting_period_end_date
datetime
The end date for the period of time during which units are being credited.
validity_start_date
datetime
The start date for when the label is valid.
ProjectLocation
The ProjectLocation type represents the location of a project.
country
Countries
The country in which the project is located.
project_location_id
str
The unique identifier for the project location.
in_country_region
str
The region(s) or subnational division(s) in which the project is located.
geographic_identifier
str
Additional specificity to where the project is being conducted.
state
str
The state in which the project is located.
ProjectRating
The ProjectRating type represents the rating of a project. May change at the time of launch.
rating_type
str
The name of the rating or rating module.
rating_range_lowest
int
The worst score possible on the rating module.
rating_range_highest
int
The best score possible on the rating module.
rating
int
The score received by the project on the rating module.
rating_link
str
The URL link to the rating report generated for the project.
Estimation
The Estimation type represents an estimation associated with a project.
estimation_id
str
The unique identifier for the estimation.
crediting_period_start
datetime
The start date for the estimated crediting period.
crediting_period_end
datetime
The end date for the estimated crediting period.
unit_count
int
The estimated number of outcomes produced in the specified crediting period.
validity_end_date
datetime
The end date for the validity of the estimation.
unit_quantity
int
The quantity of units associated with the estimation.
label_link
str
The URL link to the label associated with the estimation.
CoBenefit
The CoBenefit type represents a co-benefit associated with a project.
co_benefit_id
str
The unique identifier for the co-benefit.
co_benefit
SustainableDevelopmentGoals
The co-benefit achieved with the project.
Mutations
Mutation operations aren't supported
Subscriptions
Subscriptions aren't supported yet
Sample Query
Use Case
Search for "biomass" projects with registered status
POST https://api.carbonmarketshq.com/v2/graphql
Request Body
Response
Last updated