Skip to main content

Versioning

yfin's public REST API is versioned under /v1. The current SDKs target the https://api.yfin.dev/v1 API surface.

Compatibility Promise​

Within /v1, yfin aims to keep existing integrations working:

  • Existing public routes should keep their path and method.
  • Existing response fields should not change meaning.
  • New response fields may be added.
  • Optional fields may remain absent for symbols where data is unavailable.
  • New error codes may be added for new failure modes.
  • SDKs may add helpers without removing existing public methods in the same major version.

Breaking Changes​

Breaking changes should be introduced through a new API version or a documented migration path. Examples include removing a route, changing a field's meaning, or changing required parameters for an existing route.

Changelog​

Use the project changelog and release notes to track SDK and API changes:

  • GitHub repository: bluedoor-ai/yfin
  • OpenAPI document: https://api.yfin.dev/v1/openapi.json
  • Endpoint catalog: https://api.yfin.dev/v1/endpoints

Developer Guidance​

  • Generate clients from the OpenAPI document when you need exact types.
  • Keep unknown JSON fields when proxying or storing API responses.
  • Avoid exhaustive switches over open-ended market-data categories unless your app has a default case.
  • Pin SDK versions in production applications.