Skip to main content

Rows Returned (SDK)

Rows Returned is the pre-purchase row estimate—the same concept as Configure & Buy in the platform UI. In the Python SDK, the field is used_rows_count.

Use production API host https://api.carbonarc.co with a token from Profile (CARBONARC_API_TOKEN_PROD or CARBONARC_TOKEN).

Single framework quote

from carbonarc import CarbonArcClient

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

quote = client.explorer.check_framework_quote(framework)
quote["price"]
quote["used_rows_count"]  # Rows Returned (estimate)
quote["valid"]
quote["message"]

Price only (unchanged)

client.explorer.check_framework_price(framework) still returns a float (price only). It does not include row count.

Multiple frameworks

batch = client.explorer.check_frameworks_quote([fw1, fw2])
for item in batch["frameworks"]:
    item["price"]
    item["used_rows_count"]

Important notes

  • Estimate only. Final row counts after purchase may differ—the same caveat as the UI tooltip.
  • Not a post-purchase metric. Use purchase and download responses for actual rows returned, not the quote alone.