Skip to main content

Library for Devs

Programmatic access to explore, discover, and integrate Carbon Arc data assets into your applications and workflows.

API Reference

Library API

Complete reference for exploring data assets programmatically — list data assets, get metadata, preview samples, and track version changes.

IDO Feed API

Browse Initial Data Offering (IDO) assets — list the catalog, inspect metadata and samples, upvote assets, and request access programmatically.

Available Methods

MethodDescription
client.catalog.list_assets()Browse the IDO feed with filters and sort
client.catalog.get_asset()Get full IDO asset detail, samples, and schema
client.catalog.request_access()Request access to a gated or locked IDO asset
client.data.get_datasets()List all available data assets (paginated)
client.data.get_dataset_information()Get details for a specific data asset
client.data.get_insights_by_dataset()Retrieve all insights associated with a dataset
client.data.get_data_dictionary()Get column definitions and metadata
client.data.get_data_sample()Preview sample data rows
client.data.get_dataset_schedule()Get the update schedule for a dataset
client.data.get_library_version_changes()Check for updates and changes

Quick Start

1. Install the SDK

pip install carbonarc python-dotenv pandas

2. Initialize the Client

from carbonarc import CarbonArcClient

client = CarbonArcClient(
    host="https://api.carbonarc.co",
    token="YOUR_API_TOKEN"
)

3. Explore Datasets

# List all datasets
response = client.data.get_datasets()
datasets = response.get('datasources', [])

# Get info for a specific dataset
info = client.data.get_dataset_information(dataset_id="CA0056")

# Preview sample data
sample = client.data.get_data_sample(dataset_id="CA0056")
ResourceDescription
API AuthenticationGet your API key and authenticate
Python SDK on PyPIInstall the official Carbon Arc package
Library GuideOverview of all available data assets
Ontology for DevsExplore entities and insights programmatically

Need Help?