UNFCCC DI API

Data access to the total greenhouse gas emissions by country reported to the United Nations Framework Convention on Climate Change (UNFCCC).
https://github.com/primap-community/unfccc_di_api

Category: Emissions
Sub Category: Emission Observation and Modeling

Keywords

climate-data unfccc

Keywords from Contributors

energy-system-modelling energy-system climate-change climate-policy accessor

Last synced: about 14 hours ago
JSON representation

Repository metadata

Python wrapper around the Flexible Query API of the UNFCCC.

• Host: GitHub
• URL: https://github.com/primap-community/unfccc_di_api
• Owner: primap-community
• License: other
• Created: 2021-01-22T09:02:57.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-04-22T08:06:38.000Z (9 days ago)
• Last Synced: 2025-04-25T10:42:22.852Z (6 days ago)
• Topics: climate-data, unfccc
• Language: Python
• Homepage: https://unfccc-di-api.readthedocs.io
• Size: 363 KB
• Stars: 8
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Releases: 12
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

README.rst

          =============
UNFCCC DI API
=============


.. image:: https://img.shields.io/pypi/v/unfccc_di_api.svg
        :target: https://pypi.python.org/pypi/unfccc_di_api
        :alt: PyPI release

.. image:: https://readthedocs.org/projects/unfccc-di-api/badge/?version=main
        :target: https://unfccc-di-api.readthedocs.io/en/main/
        :alt: Documentation

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4457483.svg
   :target: https://doi.org/10.5281/zenodo.4457483


Python wrapper around the `Flexible Query API `_ of
the UNFCCC.


* Free software: Apache Software License 2.0
* Documentation: https://unfccc-di-api.readthedocs.io.

Warning
-------

Due to a recent change in the UNFCCC's API, the UNFCCCApiReader class is
**not functional** any more in standard environments. To continue to access the data,
you have two options:

1. Use the new ZenodoReader. It provides access using the `query` function like the
   UNFCCCApiReader, but only supports querying for a full dataset with all data. It
   relies on our `data package `_, which we
   update regularly; however, the data is naturally not as recent as querying from
   the API directly.
2. Run your functions in an environment which is not blocked by the UNFCCC DI API.
   According to our tests, Azure virtual machines work, as well as github hosted
   runners, with the exception of Mac OS runners.


Features
--------

* High-level API to query all information for a given party.
* Low-level API to selectively query information with the same resolution as in the
  UNFCCC web query tool.

Citation
--------
If you use this library and want to cite it, please cite it as:

Mika Pflüger, Daniel Huppmann & Johannes Gütschow. (2024-01-08).
pik-primap/unfccc_di_api: Version 4.0.4.
Zenodo. https://doi.org/10.5281/zenodo.10471122

Data package
------------
If you just want all the data in CSV and parquet format (suitable for reading with
pandas), look at our `data package `_.

CI status and other links
-------------------------

.. image:: https://results.pre-commit.ci/badge/github/pik-primap/unfccc_di_api/main.svg
   :target: https://results.pre-commit.ci/latest/github/pik-primap/unfccc_di_api/main
   :alt: pre-commit.ci status

        

---

Owner metadata

• Name: PRIMAP
• Login: primap-community
• Email:
• Kind: organization
• Description:
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/114724539?v=4
• Repositories: 1
• Last ynced at: 2023-03-05T19:48:36.725Z
• Profile URL: https://github.com/primap-community

---

GitHub Events

Total

• Delete event: 15
• Push event: 23
• Pull request event: 36
• Fork event: 1
• Create event: 17

Last Year

• Delete event: 15
• Push event: 23
• Pull request event: 36
• Fork event: 1
• Create event: 17

---

Committers metadata

Last synced: 2 days ago

Name	Email	Commits
Mika Pflüger	m****r@p****e	133
pre-commit-ci[bot]	6****]	130
Daniel Huppmann	dh@d****t	8

Committer domains:

• dergelbesalon.at: 1
• pik-potsdam.de: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/primap-community/unfccc_di_api

---

---

---

Dependencies

Score: 3.1780538303479453