Skip to main content

Explore Data IDO API Feed

The Explore Data Feed is Carbon Arc's catalog of Initial Data Offering (IDO) assets — partner datasets you browse and evaluate in Explore Data. Use the Catalog API to list assets, inspect metadata and samples, upvote datasets, and submit access requests from code.

This API is separate from the Library API, which covers Carbon Arc datasets you already subscribe to (for example CA0056).


IDO Feed vs Library API

IDO Feed (client.catalog)Library API (client.data)
What it coversPartner IDO assets in Explore DataSubscribed Carbon Arc library datasets
Typical IDsAsset UUIDsDataset IDs like CA0056
Primary useDiscover, evaluate, and request access to new dataQuery metadata, samples, and schedules for entitled data
UI equivalentExplore DataLibrary

Available Methods

MethodDescription
client.catalog.list_assets()List approved IDO assets with filters and sort
client.catalog.get_asset(asset_id)Full asset detail — metadata, samples, data dictionary
client.catalog.toggle_vote(asset_id)Add or remove an upvote on an asset
client.catalog.get_vote_status(asset_id)Check whether the caller has voted
client.catalog.request_access(asset_id, request_type)Submit an access request for gated or locked assets

Quick Start

from carbonarc import CarbonArcClient

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

List IDO Assets

Browse the IDO catalog. Results are filtered by your plan — you only see assets your account is permitted to view.

response = client.catalog.list_assets(
search="credit card",
tier=1,
sort="popularity",
)

Filters

ParameterTypeDescription
tierint or listFilter by asset tier (1, 2, or 3)
provider_idstrFilter by provider UUID
categorystrFilter by data category / ecosystem
visibilitystrpublic, gated, or locked
searchstrCase-insensitive title search
data_typestrFilter by data type
geographystrExact match within the asset's geography field
frequencystrFilter by data refresh frequency
sortstrpopularity (vote count, descending) or newest (published date, descending)

These map to the filters in the Explore Data UI — ecosystem, tier, status, search, and sort controls.

Response Structure

{
"assets": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"title": "Consumer Transactions – US Panel",
"category": "Consumer",
"tier": 1,
"visibility": "gated",
"provider_id": "660e8400-e29b-41d4-a716-446655440001",
"geography": ["US"],
"frequency": "Weekly",
"vote_count": 42,
"published_at": "2026-05-01T00:00:00Z"
}
],
"total": 1
}

Field names and additional metadata may vary by asset. Use get_asset for the full record.

Example: Search and Display Results

import pandas as pd

response = client.catalog.list_assets(
category="Financial",
visibility="public",
sort="newest",
)

assets = response.get("assets", [])
print(f"Found {response.get('total', len(assets))} assets")

df = pd.DataFrame([{
"title": a.get("title"),
"tier": a.get("tier"),
"visibility": a.get("visibility"),
"votes": a.get("vote_count"),
} for a in assets])

print(df.to_string(index=False))

Get Asset Detail

Retrieve full metadata, data dictionary, and sample rows for a single IDO asset.

asset = client.catalog.get_asset(
asset_id="550e8400-e29b-41d4-a716-446655440000"
)

Use the asset UUID from list_assets — not a Carbon Arc dataset ID like CA0056.

The response includes the same information shown on an asset's detail page in Explore Data: overview, schema, samples, and access status.


Upvote an Asset

Upvotes work like the upvote button on asset cards in Explore Data. Calling toggle_vote adds a vote if you haven't voted yet, or removes it if you already have.

result = client.catalog.toggle_vote(
asset_id="550e8400-e29b-41d4-a716-446655440000"
)
# {"asset_id": "...", "voted": true, "vote_count": 43}

Check your current vote status without toggling:

status = client.catalog.get_vote_status(
asset_id="550e8400-e29b-41d4-a716-446655440000"
)
# {"asset_id": "...", "voted": false, "vote_count": 42}

Sort by popularity in list_assets to surface the most-upvoted assets.


Request Access

Submit a request for a gated or locked asset. Public assets do not require a request.

request = client.catalog.request_access(
asset_id="550e8400-e29b-41d4-a716-446655440000",
request_type="access",
)
# {"id": "...", "status": "pending", "routed_to": "..."}

Request Types

request_typeWhen to use
accessStandard access request (default)
diligenceDue diligence review
complianceCompliance review

If an active request already exists for the asset, the API returns 409 Conflict.


REST Endpoints

The Python SDK wraps these HTTP routes on https://api.carbonarc.co/v2/catalog:

MethodEndpointDescription
GET/assetsList assets (query params match SDK filters)
GET/assets/:idAsset detail
POST/assets/:id/voteToggle upvote
GET/assets/:id/voteVote status
POST/assets/:id/request-accessSubmit access request

All endpoints require a valid API token in the Authorization header. See API Authentication.


Typical Workflow

  1. Browse the IDO catalog with list_assets — filter by category, tier, or search term.
  2. Review promising assets with get_asset — inspect metadata, schema, and samples.
  3. Signal interest with toggle_vote or sort by popularity to see community demand.
  4. Request access with request_access for gated or locked assets.
  5. Once entitled, use the Library API or Block API to work with the data in your environment.

ResourceDescription
Explore Data (UI)Browse the IDO catalog in the platform
Library APIMetadata and samples for subscribed library datasets
API AuthenticationGet your API token
Python SDK on PyPIInstall the official Carbon Arc package