Project Details

Get detailed project and vintage data

Last updated 1 year ago

Overview

Access details about carbon offset projects and their vintages. The screenshot below is of the project detail screen which shows similar data as this endpoint returns:

Example cURL Request

curl --request GET 'https://${BASE_URL}/api/projects?project_ids[]=003q81qxjb6rru572v&project_ids[]=0037yhin9rxb2v8coh' \
--header 'Authorization: Bearer ${API_KEY}'

Endpoint Specification

Get project data

GET /api/projects

Get detailed project and vintage data for multiple projects

Query Parameters

Name

Type

Description

project_ids[]*

string[]

You may specify this query parameter multiple times to retrieve data for multiple projects.

Headers

Name

Type

Description

Authorization*

string

Bearer ${API_KEY}

{
    "projects": [
        {
            "project_id": "003s9eb104zcu2gclk",
            "project_name": "Example Hydro project",
            "type": "Hydro",
            "location": "TD",
            "registry_project_url": "https://example.com/",
            "sdgs": [
                "Life Below Water",
                "Gender Equality",
                "Infrastructure",
                "Quality Education",
                "Zero Hunger",
                "Health and Well Being",
                "No Poverty",
                "Water Benefit",
                "Economic Growth"
            ],
            "registry_id": "005h8koa2ioo0qgq3x",
            "registry_name": "BioCarbon Registry",
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "vintages": [
                {
                    "vintage_id": "004bjccxq1p4j6f954",
                    "vintage_year": 2014,
                    "registry_vintage_url": "https://example.com/"
                },
                {
                    "vintage_id": "0042g006orga6wll64",
                    "vintage_year": 2019,
                    "registry_vintage_url": "https://example.com/"
                },
                {
                    "vintage_id": "004wk8qmn51yjftw7g",
                    "vintage_year": 2020,
                    "registry_vintage_url": "https://example.com/"
                }
            ]
        }
    ]
}

{
    projects: Array<{
        project_id: string
        project_name: string
        type: string
        location: string
        registry_project_url: string
        sdgs: Array<string>
        registry_id: string
        registry_name: string
        description: string
        vintages: Array<{
            vintage_id: string
            vintage_year: number
            registry_vintage_url: string
        }>
    }>
}

{
    "statusCode": 401,
    "message": "Unauthorized"
}

{
    statusCode: number
    message: string
}

{
    "error": "Forbidden",
    "message": "Permission denied according to assigned roles.",
    "statusCode": 403
}

{
    statusCode: number
    message: string
    error: string
}

{
    "statusCode": 500,
    "message": "Internal server error"
}

{
    statusCode: number
    message: string
}

Project Data

Registry Ids and Names

Thallo will return both the registry_id and the registry_name for convenience. Please note the registry name is a label and may change, however the registry id will remain static.

Value Values

registry_id Value from API

registry_name Vale from API

005h8koa2ioo0qgq3x

BioCarbon Registry

005yuwbp97mxjnk122

Puro.earth

005a86q13pgj9c3612

Gold Standard

005y75kep1v7snof1x

American Carbon Registry

0050yd569dw0qbw5oy

VERRA

0056bnn0ernrsikdbr

UNFCCC Clean Development Mechanism

0057qpby5eqk470euc

Cercarbono / EcoRegistry

005oymz2l3624dokjf

Climate Action Reserve

005r76093fm1wjqd13

Plan Vivo

005yuwbp97mxjnklnz

Global Carbon Council

005vgugi19i1pqveb6

Centigrade

005c5sqk87b8fdjtmv

Social Carbon

Easy to copy values

005h8koa2ioo0qgq3x BioCarbon Registry
005yuwbp97mxjnk122 Puro.earth
005a86q13pgj9c3612 Gold Standard
005y75kep1v7snof1x American Carbon Registry
0050yd569dw0qbw5oy VERRA
0056bnn0ernrsikdbr UNFCCC Clean Development Mechanism
0057qpby5eqk470euc Cercarbono / EcoRegistry
005oymz2l3624dokjf Climate Action Reserve
005r76093fm1wjqd13 Plan Vivo
005yuwbp97mxjnklnz Global Carbon Council
005vgugi19i1pqveb6 Centigrade
005c5sqk87b8fdjtmv Social Carbon

Sustainable Development Goals (SDGs)

What are SDGs?

The 17 Sustainable Development Goals (SDGs) are an urgent call for action by all countries - developed and developing - in a global partnership. They recognize that ending poverty and other deprivations must go hand-in-hand with strategies that improve health and education, reduce inequality, and spur economic growth – all while tackling climate change and working to preserve our oceans and forests. Read more.

A carbon project can satisfy none, one or multiple SDGs during its implementation, which indicates additional co-benefits beyond carbon reduction or removal.

Valid Values

Value from API

UN Link

No Poverty

Goal 1

Zero Hunger

Goal 2

Health and Well Being

Quality Education

Gender Equality

Water Benefit

Clean Energy

Economic Growth

Infrastructure

Reduced Inequalities

Goal 10

Sustainable Cities

Goal 11

Responsible Consumption and Production

Climate Action

Life Below Water

Life On Land

Peace and Justice

Partnerships for the Goals

Goal 17

Easy to copy values

No Poverty
Zero Hunger
Health and Well Being
Quality Education
Gender Equality
Water Benefit
Clean Energy
Economic Growth
Infrastructure
Reduced Inequalities
Sustainable Cities
Responsible Consumption and Production
Climate Action
Life Below Water
Life On Land
Peace and Justice
Partnerships for the Goals

Project Types

Project types are not standardized across registries, however, Thallo map these values into a single set of project types to allow you to easily filter and analyze projects regardless of which registry they originate from.

Valid Values

Value from API

Afforestation, Reforestation & Restoration

Agricultural Methane Recovery

Avoided Deforestation

Biochar

Bioenergy Carbon Capture & Storage

Biogas

Biomass

Boreholes

Brick Manufacturing

Carbonated Building Materials

Cement & Concrete

Cookstoves

Direct Air Capture

Domestic Energy Efficiency

Domestic Fuel Efficiency - Biodigesters

Domestic Fuel Efficiency - Lighting

Energy Efficiency

Enhanced Oil Recovery

Enhanced Weathering

Feed Additives

Fuel Switch

Fugitive Emissions

Geologically Stored

Geothermal

Grasslands

Hydro

Improved Forest Management

Industrial Energy Efficiency

Irrigation

Landfill Gas

Mangroves

Metal production

Methane Capture

N2O from Adipic Acid

N2O from Nitric Acid

Non-Oil Recycling

Oil Recycling

Other transport

Ozone Depleting Substances

Peatlands

REDD+

Regenerative Agriculture

Renewables

Seagrass & Seaweeds

Soil Amendment based on Carbon Storage Methodology

Solar

Sulphur Emissions

Synthetic Fuels

Waste Heat Recovery

Water

Water Filters

Wetland Restoration

Wind

Wooden Building Materials

Woody Biomass Burial

Easy to copy values

Afforestation, Reforestation & Restoration
Agricultural Methane Recovery
Avoided Deforestation
Biochar
Bioenergy Carbon Capture & Storage
Biogas
Biomass
Boreholes
Brick Manufacturing
Carbonated Building Materials
Cement & Concrete
Cookstoves
Direct Air Capture
Domestic Energy Efficiency
Domestic Fuel Efficiency - Biodigesters
Domestic Fuel Efficiency - Lighting
Energy Efficiency
Enhanced Oil Recovery
Enhanced Weathering
Feed Additives
Fuel Switch
Fugitive Emissions
Geologically Stored
Geothermal
Grasslands
Hydro
Improved Forest Management
Industrial Energy Efficiency
Irrigation
Landfill Gas
Mangroves
Metal production
Methane Capture
N2O from Adipic Acid
N2O from Nitric Acid
Non-Oil Recycling
Oil Recycling
Other transport
Ozone Depleting Substances
Peatlands
REDD+
Regenerative Agriculture
Renewables
Seagrass & Seaweeds
Soil Amendment based on Carbon Storage Methodology
Solar
Sulphur Emissions
Synthetic Fuels
Waste Heat Recovery
Water
Water Filters
Wetland Restoration
Wind
Wooden Building Materials
Woody Biomass Burial

Project Locations

Thallo follow the ISO 3166-1 alpha-2 standard for 2 letter country codes.

Valid Values

Value from API

Country

Andorra

United Arab Emirates

Afghanistan

Antigua and Barbuda

Anguilla

Albania

Armenia

Angola

Argentina

American Samoa

Austria

Australia

Aruba

Åland Islands

Azerbaijan

Bosnia and Herzegovina

Barbados

Bangladesh

Belgium

Burkina Faso

Bulgaria

Bahrain

Burundi

Benin

Saint Barthélemy

Bermuda

Brunei Darussalam

Bolivia

Bonaire, Sint Eustatius and Saba

Brazil

Bahamas

Bhutan

Botswana

Belarus

Belize

Canada

Cocos (Keeling) Islands

Democratic Republic of the Congo

Central African Republic

Congo

Switzerland

Cook Islands

Chile

Cameroon

China

Colombia

Costa Rica

Cuba

Curaçao

Christmas Island

Cyprus

Czechia

Germany

Djibouti

Denmark

Dominica

Dominican Republic

Algeria

Ecuador

Estonia

Egypt

Western Sahara

Eritrea

Spain

Ethiopia

Finland

Fiji

Falkland Islands

Micronesia

Faroe Islands

France

Gabon

United Kingdom

Grenada

Georgia

Guernsey

Ghana

Gibraltar

Greenland

Gambia

Guinea

Equatorial Guinea

Greece

Guatemala

Guam

Guinea-Bissau

Guyana

Hong Kong

Honduras

Croatia

Haiti

Hungary

Indonesia

Ireland

Israel

Isle of Man

India

British Indian Ocean Territory

Iraq

Iran

Iceland

Italy

Jersey

Jamaica

Jordan

Japan

Kenya

Kyrgyzstan

Cambodia

Kiribati

Comoros

Saint Kitts and Nevis

North Korea

South Korea

Kuwait

Cayman Islands

Kazakhstan

Lao People's Democratic Republic

Lebanon

Saint Lucia

Liechtenstein

Sri Lanka

Liberia

Lesotho

Lithuania

Luxembourg

Latvia

Libya

Morocco

Monaco

Moldova

Montenegro

Madagascar

Marshall Islands

North Macedonia

Mali

Myanmar

Mongolia

Macao

Northern Mariana Islands

Martinique

Mauritania

Montserrat

Malta

Mauritius

Maldives

Malawi

Mexico

Malaysia

Mozambique

Namibia

Niger

Norfolk Island

Nigeria

Nicaragua

Netherlands

Norway

Nepal

Nauru

Niue

New Zealand

Oman

Panama

Peru

French Polynesia

Papua New Guinea

Philippines

Pakistan

Poland

Pitcairn

Puerto Rico

Palestine, State of

Portugal

Palau

Paraguay

Qatar

Romania

Serbia

Russian Federation

Rwanda

Saudi Arabia

Solomon Islands

Seychelles

Sudan

Sweden

Singapore

Slovenia

Slovakia

Sierra Leone

San Marino

Senegal

Somalia

Suriname

South Sudan

Sao Tome and Principe

El Salvador

Sint Maarten

Eswatini

Chad

Timor-Leste

Tunisia

Türkiye

Trinidad and Tobago

Uganda

Ukraine

United States of America

Uruguay

Saint Vincent and the Grenadines

Venezuela

Virgin Islands (British)

Virgin Islands (U.S.)

Viet Nam

Vanuatu

Samoa

Yemen

South Africa

Zambia

Zimbabwe

Easy to copy values

AD Andorra
AE United Arab Emirates
AF Afghanistan
AG Antigua and Barbuda
AI Anguilla
AL Albania
AM Armenia
AO Angola
AR Argentina
AS American Samoa
AT Austria
AU Australia
AW Aruba
AX Åland Islands
AZ Azerbaijan
BA Bosnia and Herzegovina
BB Barbados
BD Bangladesh
BE Belgium
BF Burkina Faso
BG Bulgaria
BH Bahrain
BI Burundi
BJ Benin
BL Saint Barthélemy
BM Bermuda
BN Brunei Darussalam
BO Bolivia
BQ Bonaire, Sint Eustatius and Saba
BR Brazil
BS Bahamas
BT Bhutan
BW Botswana
BY Belarus
BZ Belize
CA Canada
CC Cocos (Keeling) Islands
CD Democratic Republic of the Congo
CF Central African Republic
CG Congo
CH Switzerland
CK Cook Islands
CL Chile
CM Cameroon
CN China
CO Colombia
CR Costa Rica
CU Cuba
CW Curaçao
CX Christmas Island
CY Cyprus
CZ Czechia
DE Germany
DJ Djibouti
DK Denmark
DM Dominica
DO Dominican Republic
DZ Algeria
EC Ecuador
EE Estonia
EG Egypt
EH Western Sahara
ER Eritrea
ES Spain
ET Ethiopia
FI Finland
FJ Fiji
FK Falkland Islands
FM Micronesia
FO Faroe Islands
FR France
GA Gabon
GB United Kingdom
GD Grenada
GE Georgia
GG Guernsey
GH Ghana
GI Gibraltar
GL Greenland
GM Gambia
GN Guinea
GQ Equatorial Guinea
GR Greece
GT Guatemala
GU Guam
GW Guinea-Bissau
GY Guyana
HK Hong Kong
HN Honduras
HR Croatia
HT Haiti
HU Hungary
ID Indonesia
IE Ireland
IL Israel
IM Isle of Man
IN India
IO British Indian Ocean Territory
IQ Iraq
IR Iran
IS Iceland
IT Italy
JE Jersey
JM Jamaica
JO Jordan
JP Japan
KE Kenya
KG Kyrgyzstan
KH Cambodia
KI Kiribati
KM Comoros
KN Saint Kitts and Nevis
KP North Korea
KR South Korea
KW Kuwait
KY Cayman Islands
KZ Kazakhstan
LA Lao People's Democratic Republic
LB Lebanon
LC Saint Lucia
LI Liechtenstein
LK Sri Lanka
LR Liberia
LS Lesotho
LT Lithuania
LU Luxembourg
LV Latvia
LY Libya
MA Morocco
MC Monaco
MD Moldova
ME Montenegro
MG Madagascar
MH Marshall Islands
MK North Macedonia
ML Mali
MM Myanmar
MN Mongolia
MO Macao
MP Northern Mariana Islands
MQ Martinique
MR Mauritania
MS Montserrat
MT Malta
MU Mauritius
MV Maldives
MW Malawi
MX Mexico
MY Malaysia
MZ Mozambique
NA Namibia
NE Niger
NF Norfolk Island
NG Nigeria
NI Nicaragua
NL Netherlands
NO Norway
NP Nepal
NR Nauru
NU Niue
NZ New Zealand
OM Oman
PA Panama
PE Peru
PF French Polynesia
PG Papua New Guinea
PH Philippines
PK Pakistan
PL Poland
PN Pitcairn
PR Puerto Rico
PS Palestine, State of
PT Portugal
PW Palau
PY Paraguay
QA Qatar
RO Romania
RS Serbia
RU Russian Federation
RW Rwanda
SA Saudi Arabia
SB Solomon Islands
SC Seychelles
SD Sudan
SE Sweden
SG Singapore
SI Slovenia
SK Slovakia
SL Sierra Leone
SM San Marino
SN Senegal
SO Somalia
SR Suriname
SS South Sudan
ST Sao Tome and Principe
SV El Salvador
SX Sint Maarten
SZ Eswatini
TD Chad
TL Timor-Leste
TN Tunisia
TR Türkiye
TT Trinidad and Tobago
UA Ukraine
US United States of America
UY Uruguay
VC Saint Vincent and the Grenadines
VE Venezuela
VG Virgin Islands (British)
VI Virgin Islands (U.S.)
VN Viet Nam
VU Vanuatu
WS Samoa
YE Yemen
ZA South Africa
ZM Zambia
ZW Zimbabwe