Skip to main content

Getting Started with the Carbon Arc API

Welcome to the Carbon Arc developer experience. This guide is your launchpad for working with our API to access insights, ontology, and bulk data — all with the power of Python.

Whether you're a data scientist, analyst, or engineer, Carbon Arc gives you direct access to structured economic and behavioral data via API. This guide shows how to set up your environment and authenticate — the foundation for all future interactions with our platform.

Every interaction with Carbon Arc begins with the carbonarc Python package. From there, you can:

  • Authenticate securely using a personal API token
  • Retrieve data from insights, brand performance, or receipt feeds
  • Explore the Ontology to understand how entities are structured
  • Pull and manage bulk data from S3 or local downloads

What You’ll Learn​

This Getting Started section includes:

Who This Is For​

If you're building repeatable workflows around Carbon Arc data — whether for insight delivery, research, modeling, or dashboards — this is your starting point.

If you're looking for a quick reference to endpoints and schemas, jump to the Reference section in the sidebar.