Versioning
The Grand Public API is versioned by a prefix in the URL path. The current version is
v1, and every endpoint lives under it:
https://public-api.heygrand.com/v1/...
Our compatibility promise
We won't make breaking changes within a version. While you're on v1, you can rely on:
- Existing endpoints keeping their paths and methods.
- Existing response fields keeping their names, types, and meaning.
- Required request parameters staying required (and no new required parameters appearing).
When we need to make a breaking change, it ships under a new path prefix (e.g. /v2),
announced ahead of time in the Changelog. The previous version keeps working
through a documented deprecation window.
Non-breaking changes
These can happen at any time within v1, so your integration should tolerate them:
- New endpoints being added.
- New fields appearing in a response object.
- New optional request parameters.
- New enum values in fields like
tradingStatus.
Write your client to ignore unknown JSON fields rather than failing on them. Most JSON libraries do this by default, but strict deserializers may need to be configured for it. This single habit makes your integration resilient to every non-breaking change above.
Staying informed
Subscribe to or check the Changelog for new features, deprecations, and any upcoming version changes.