Skip to main content

Programmatic

The Carbon Arc Platform supports direct data access via authenticated APIs. These endpoints allow users to integrate insights into external systems, automate workflows, and enable scalable analysis.

Carbon Arc Python Package enables access for different types of consumption:

  1. $ / mb
  2. Unmetered
  3. Bulk

The Carbon Arc package is designed to deliver structured, filterable data directly into user environments. Access is secured through API keys and governed via platform-level authentication.

Step-by-Step Execution​

1. Generate API Credentials​

  • Navigate to User Portal > My Profile
  • Locate the API Settings section
  • Generate and copy your API key

2. Review API Documentation​

  • Use the API documentation to identify available endpoints
  • Reference parameter formats and query structure

3. Construct Your Query​

  • Target specific entities, insights, or time windows
  • Example: Query credit card transactions by brand and date

4. Authenticate Request​

  • Include your API key in the request header

5. Receive Data​

  • API returns data in JSON or CSV format
  • Integrate with internal tools for downstream use

Expected Outcome​

Users receive real-time or scheduled data responses aligned to their query parameters, ready for immediate ingestion or analysis.

Common Use Cases​

  • Automated reporting pipelines
  • Custom analytics builds
  • Integration with ML/AI models
  • Workflow automation based on data triggers

Best Practices​

  • Keep your API key secure and rotate periodically
  • Use filters to optimize performance and reduce payload size
  • Monitor usage through the Billing tab in the User Portal
  • Reference documentation for version updates and new parameters

Example Workflow​

  1. Query data for a specific brand and date range
  2. Authenticate using API key
  3. Receive response in JSON format
  4. Load data into reporting or analytics tools