Skip to main content

API Reference

The AtlasCore REST API provides programmatic access to Australian government climate data, emission factors, company intelligence, and disclosure workflows.

Base URL​

https://api.atlascore.com.au/v1

Authentication​

All requests require a bearer token in the Authorization header:

curl -H "Authorization: Bearer ac_test_your_key" \
  https://api.atlascore.com.au/v1/datasets

See Authentication for key formats and error handling.

Versioning​

The API is served under the /v1 prefix. Breaking changes will be introduced under a new version prefix.

Rate limits​

Rate limits are enforced per tenant-pack-event window. When exceeded, the API returns 429 Too Many Requests.

Request format​

  • Content type: application/json for POST bodies
  • Query parameters for GET filters
  • pack_id required on most tenant-facing endpoints

Response format​

All responses are JSON. Evidence-bearing responses include:

  • evidence_hash in the response body
  • X-AtlasCore-Evidence-Hash response header

Response headers​

HeaderPurpose
X-AtlasCore-Evidence-HashSHA-256 hash of canonical inputs
X-AtlasCore-Factor-Set-SlugActive emission factor set identifier
X-AtlasCore-Factor-Set-EditionActive factor set edition
X-Request-IdCorrelation ID for request tracing

Endpoint groups​

GroupDescription
DatasetsDataset catalogue and registration
Emission FactorsNGA factor lookups (Scope 1, 2, 3), batch, search, GreenPower
Grid IntensityAEMO NEM grid emission intensity time series
CompaniesClimate profiles, risk, disclosure bundles, targets, export
EntitiesEntity resolution and NGER emissions
PortfoliosPortfolio management, runs, and reporting
QueriesSpatial AOI queries (address, polygon, route)
PacksPack lifecycle, context, framework registry, UI config
WebhooksTenant-owned outbound data-refresh integrations
ReportsReport generation and artifact download
Alert WatchesChange detection and alert monitoring
StatisticsPack-scoped ABS statistical series
GeocodingAddress geocoding proxy
Map TilesPMTiles vector tile proxy

Error responses​

StatusMeaning
400Invalid request parameters
401Missing or invalid bearer token
403Insufficient pack entitlement
404Resource not found
429Rate limit or quota exceeded
500Internal server error

See Error Codes for detailed error documentation.