Skip to main content

Carbon Arc - Python Package

Client for Carbon Arc, an Insights Exchange Platform.

Usage

Installation

pip install carbonarc

Quick Start

Initialize the API client with authentication.

from carbonarc import CarbonArcClient

client = CarbonArcClient(token="<token>") # retrieve token from account

Prisms

Daily reference data: the same prisms and Arrays as the public Prisms page, read with your API token. Values are relative only (YoY index levels and shares).

from carbonarc.prisms import array_to_dataframe, prism_to_dataframe

catalog = client.prisms.list_prisms()          # every live prism and Array, plus `tou`
prism = client.prisms.get_prism(catalog["prisms"][0]["prism_id"])  # one prism, with its `framework`
matches = client.prisms.list_prisms(insight_id=775)  # filter by insight_id and/or entity_id

arrays = client.prisms.list_arrays()["arrays"]
array = client.prisms.get_array(arrays[0]["array_id"])

prism_to_dataframe(prism)   # one row per entity, series and period
array_to_dataframe(array)   # one row per month

An unknown id raises a 404 error and an invalid token a 401.

Resources

Metadata

Release files for carbonarc 1.1.19

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for carbonarc 1.1.19
File Size Uploaded
carbonarc-1.1.19.tar.gz 33.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for carbonarc 1.1.19
File Interpreter ABI Platform
carbonarc-1.1.19-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 74.5 kB

Release files / carbonarc-1.1.19.tar.gz

Download URL carbonarc-1.1.19.tar.gz
Size 33.1 kB
Tags Source
SHA-256 checksum
How to use checksums
6be292e8f55cb1c57b538892b96f21e3f9db5b17351d9c7d904e1a2dbd079dda
BLAKE2b-256 checksum
How to use checksums
3ee1c0b7bd04d0defeb75a932bf16ba2ab550acca52f4be8a3fc3151ab46d33d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / carbonarc-1.1.19-py2.py3-none-any.whl

Download URL carbonarc-1.1.19-py2.py3-none-any.whl
Size 41.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
49e1135d17f8717e8cf92397c5abf4164f8da80e3af0682a5e14cf152d7d21fb
BLAKE2b-256 checksum
How to use checksums
0c59c409ceda4721296d3d2cba9807acb5e2dd2f0a7a5c13740da0576d7d1c00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page