Product · API
The Circa Library, as an API.
Search datasets from every publisher, license the datapoints you need, and read the results from your own code. REST, mirrored as GraphQL, priced in credits like the app.
# Search processes across every publisher curl 'https://api.circa.ai/public/processes?search=aluminium&limit=10' \ -H 'x-api-key: circa_live_…' \ -H 'x-team-id: TEAM_ID' # 200 OK · impact values stay hidden until you license them { "name": "aluminium production, primary, ingot", "regionRegionalScope": "GLO", "processBoundary": "Aggregated", "impacts": [{ "method": "IPCC 2021 no LT", "value": null, "revealed": false }] }
# License a process's impact results, by method curl -X POST 'https://api.circa.ai/public/processes/PROCESS_ID/impacts/pull' \ -H 'x-api-key: circa_live_…' -H 'x-team-id: TEAM_ID' \ -H 'Content-Type: application/json' \ -d '{ "characterizationFactorIds": ["METHOD_ID"], "userCount": 1 }' # 200 OK { "processId": "PROCESS_ID", "revealedImpactCount": 4 }
# Read what your team has licensed curl 'https://api.circa.ai/public/processes/PROCESS_ID' \ -H 'x-api-key: circa_live_…' -H 'x-team-id: TEAM_ID' # 200 OK · illustrative values { "outputs": [{ "name": "aluminium, primary, ingot", "value": 1, "unit": "kg" }], "impacts": [{ "indicator": "global warming potential (GWP100) no LT", "value": 16.4, "unit": "kg CO2-Eq", "revealed": true }] }
Search, license, read.
Search
List and search processes and materials across every publisher, with region, boundary and source on every record.
License
License impact results by method, a process's full inventory, or single exchange's properties.
Read
Licensed values come back on every request, per the process's reference flow. List only what your team owns with ?pulled=true.
Versioned, keyed and logged.
- REST and JSON, mirrored as GraphQL
- Dated API versions you can pin per key
- Live and test keys
- OAuth apps, so your users connect their own Circa accounts
- Signed webhooks when your team licenses data
- Request logs, usage charts and a GraphQL playground in the Developer portal
- 300 requests a minute per key, more on request
Pricing
Credits, priced like the Library.
Each datapoint costs the credits its publisher sets, multiplied by the number of people who will use it. No subscription and no minimum.