Versioning

URL path versioning

The API version is part of the URL path. All current endpoints live under /v1/:

https://api.askedgar.com/v1/dilution-rating?ticker=AAPL

Every response includes an X-API-Version header confirming which version served the request:

X-API-Version: v1

What counts as a breaking change

We treat the following as breaking changes that require a new API version:

• Removing an endpoint or field from a response
• Renaming a field or changing its data type
• Changing the meaning or behavior of an existing parameter
• Altering the authentication mechanism

These changes will never land in an existing version without notice. They ship in a new version (e.g. /v2/).

What we ship without a new version

The following are non-breaking and may be added to the current version at any time:

• New endpoints
• New optional query parameters on existing endpoints
• New fields in response objects
• Bug fixes that correct incorrect data or behavior
• Performance improvements

💡

Build your integration defensively — ignore unknown fields in responses rather than failing on them. This ensures your code stays compatible as we add new data.

How we handle deprecations

When a field, endpoint, or behavior is being retired, we follow a consistent process:

1. Announce — We notify customers via email that a deprecation is coming, with a timeline and migration guidance.
2. Sunset — The deprecated feature continues to work but responses include a Sunset or Deprecated indicator. Documentation is updated to flag the change.
3. Remove — After the sunset period, the feature is removed. Requests to removed endpoints return a clear error explaining what changed.

We won't pull the rug out from under you. Deprecations come with advance notice and enough time to migrate.

How we notify you

You'll hear from us when:

• A new API version is released
• Endpoints or fields are deprecated
• Breaking changes are planned (with migration timelines)
• Significant new features or endpoints are added

Notifications are sent via email to the account associated with your API Platform account. Make sure your contact details are current.

You can also track all changes, additions, and deprecations on our changelog.

Legacy URL redirects

If you're using the older URL pattern /enterprise/v1/*, those requests are permanently redirected (HTTP 301) to /v1/*. Your client will follow the redirect automatically, but you should update your base URL to avoid the extra hop.

Next steps