Skip to main content

API Maturity Model & Modernization Path

To help you plan your integration, we categorize our APIs by their stage in our platform modernization journey.

  • CORE Modern standard APIs built on latest infrastructure.
  • CLASSIC Stable APIs providing critical data, to be modernized over time.

Read our API Vision to understand our long-term goals and architecture principles.

Maturity Model Differences​

Platform Limits & Error Handling The Platform Limits and Error Handling pages apply only to Core APIs to ensure a consistent user experience. Classic APIs have their guides, limits, and error handling information located within their own individual API section in the API Catalog.

Future Developer Experience (DX) Core APIs will receive future DX improvements (e.g., Trials, Self-Service API Keys, usage info) and share a unified authentication scheme using the standard Authorization: ApiKey request header. Conversely, Classic APIs currently use older authentication schemes such as the x-api-key header. Right now, only the Point Forecast API has self-service access via the API Console.

Developer Experience Consistency While we strive to ensure that all API documentation and specifications are highly accurate, Classic APIs may not offer the same consistent Developer Experience (DX) as our Core APIs. This includes differences in authentication methods, rate limits, request/response structures, and documentation formatting, which may not be as modern or uniform as the Core platform.

Classic API Modernization​

Our Classic APIs are established, widely-used services that form the trusted foundation of many applications. If you depend on a Classic API, you can rely on its continued stability and support. We do not abruptly deprecate services. Our modernization strategy is designed to be seamless, supportive, and driven by customer needs. When we do modernize, we will only make the breaking changes that are necessary and align with our API Vision.

We prioritize which Classic APIs to modernize based on direct customer feedback. If there is a specific Classic API you would like to see brought onto the Core Platform sooner, you can submit feedback by visiting our API Roadmap.

When a Classic API is slated for modernization to the Core Platform, we follow a strict, developer-centric migration process:

  1. Ample Notice & Transparency
    • We announce modernization plans at least 90 days in advance (but generally more) of any mandatory changes.
    • For customers with active contracts, we will work with you and your contract renewal cycle to minimise disruption.
  2. Clear Support & Resources
    • We provide comprehensive migration guides, detailing breaking changes, new endpoint structures, and updated data payloads.
    • Our support team is available for hands-on assistance during the transition.
  3. Incentivized Migration
    • Moving to a Core API unlocks platform-wide benefits, such as unified authentication, centralized rate limiting, and access to new developer tools.

For more details on upcoming developments, refer to our API Roadmap.