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.20

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.20
File Size Uploaded Provenance
carbonarc-1.1.20.tar.gz 33.5 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 75.3 kB

Release files / carbonarc-1.1.20.tar.gz

Download URL carbonarc-1.1.20.tar.gz
Size 33.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f845368dee30dc42eeb828ed4d811c3ba2b1bda67e68a596f0233fdd96aa4c65
BLAKE2b-256 checksum
How to use checksums
5b1f6309688795266366148ab2e6f8a77cf5819a857869e89c8672f84d2a3b79
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.20-py2.py3-none-any.whl

Download URL carbonarc-1.1.20-py2.py3-none-any.whl
Size 41.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
8f7a5bfeeb10f8b125209d89429433a1e1708dddc24a2c4f93e06e9ca6e88f8c
BLAKE2b-256 checksum
How to use checksums
65e372c5005200d486e3099dba80c579ab6682cfbf60b0971985f52e496085e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for carbonarc 1.1.20

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.20 This release

2 release files No provenance

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