Deprecation & Versioning Policy
Effective date: 2026-08-05 · Last updated: 2026-08-05
DRAFT — PENDING COUNSEL REVIEW. Working draft for public Beta; not legal advice. During Beta, interfaces may change more freely than the commitments below, which take full effect at GA (v1.0).
This policy explains how we version the API and how we retire (deprecate) platforms, routes, or fields, so you can build with confidence. It supports Terms §17 (Changes to the Service and to this Agreement).
1. Versioning
- The API is versioned in the key and path family: keys are minted as
allapi_live_v1_<64hex>and the base ishttps://api.allapi.io. A future breaking generation would be introduced as v2 in parallel, not by silently changing v1 behavior. - The uniform response envelope (
ok,data,error,meta) is a stable contract; we add fields backward-compatibly and do not remove or repurpose existing fields within a major version without deprecation.
2. What "deprecation" means
A deprecated platform, route, or field still works but is scheduled for removal (sunset). We announce it, provide a migration path where one exists, and only remove it after the notice window.
3. Notice windows (target at GA)
| Change | Notice before removal |
|---|---|
| Removing or breaking a field in the response envelope | 90 days |
| Sunsetting a route or a platform | 90 days (or as soon as an upstream forces it — see §4) |
| Backward-compatible additions (new field, new platform, new route) | No notice required; announced in the Changelog |
| Security or legal-compliance changes | As fast as required; announced promptly with the reason where lawful |
Notices are published in the Changelog and, for account-affecting changes, emailed to the address on your account.
4. Upstream-forced changes (honest limitation)
AllAPI is a gateway over third-party public sources we do not control. If an Upstream Source changes, rate-limits, blocks, or removes its data, the corresponding AllAPI platform or route may degrade or stop returning data with little or no notice. In that case:
- the Service responds honestly — e.g.
502 upstream_walled(the upstream blocks anonymous access) or503 upstream_unreachable(temporary) — rather than fabricating data; - we update the platform's status and, where the change is durable, deprecate/sunset the affected route with as much notice as the upstream allows.
This is inherent to the public-data model and is not a Service defect.
5. Beta caveat
During Beta, platforms, routes, fields, limits, and the exact envelope may change more frequently than the GA windows above while we stabilize the catalog. Beta changes are announced in the Changelog. The GA notice windows in §3 apply from v1.0 general availability.
6. Deprecated-endpoint behavior
While deprecated (before sunset), a route continues to function and may include a Deprecation and Sunset HTTP header indicating the planned removal date, so automated clients can detect and migrate.
Contact
API changes & migration help: [email protected] · Status: status page · Operator: Legal Eye Yazılım A.Ş., Kağıthane / İstanbul, Türkiye.
Draft — pending counsel review. Not legal advice.