klimapi-python

This API offers you the possibility to calculate and offset emissions, create checkout links, get statistics and much more.

API version: v2
Package version: 1.1.29

For more information, please visit https://klimapi.com/resources/docs

Requirements

Python 3.7+

Installation

pip install

If the python package is hosted on a repository, you can install directly using:

pip install klimapi-python

(you may need to run pip with root permission: sudo pip install klimapi-python)

Then import the package:

import klimapi_python

Setup new API Instance

import klimapi_python

klimapi = klimapi_python.KlimApi('your-private-api-key')

Methods

Method	HTTP request	Description
add_webhook	POST /webhooks/add	Add Webhook
calculate	POST /calculate	Calculate
calculate_cart	POST /stores/{store_ident}/cart	Calculate
get_categories	GET /categories	Get all Categories
get_certification_authorities	GET /certification_authorities	Get all Certification Authorities
get_metrics	POST /metrics	Order Metrics
get_order	GET /orders/{order_id}	Get Order
get_orders	POST /orders	Get Orders
get_payment_link	GET /orders/link/{payment_link_id}	Get Checkout Link
get_project	GET /projects/{project_id}	Get Project
get_projects	GET /projects	Get all supported Projects
link_by_calculation	POST /orders/link/calculate	By Calculation
link_by_carbon	POST /orders/link/carbon	By Carbon
link_by_price	POST /orders/link/price	By Price
me	GET /me	Get Authenticated User
order_by_calculation	POST /orders/process/calculate	By Calculation
order_by_carbon	POST /orders/process/carbon	By Carbon
order_by_price	POST /orders/process/price	By Price
pending_by_calculation	POST /orders/pending/calculate	By Calculation
pending_by_carbon	POST /orders/pending/carbon	By Carbon
pending_by_price	POST /orders/pending/price	By Price
process	POST /orders/{order_id}/process	Process Pending Order
process_cart	POST /stores/{store_ident}/cart/{order_id}/process	Process Cart
refund	DELETE /orders/{order_id}/refund	Refund Order
remove_webhook	DELETE /webhooks/remove	Remove Webhook
sync_bulk_store	POST /stores/{store_ident}/sync/bulk	Sync multiple Products
sync_store	POST /stores/{store_ident}/sync	Sync a single Product