Skip to main content
secapi-version is a request header. The service resolves a version for the request and returns the resolved value in SECAPI-Version. Record both when reproducing behavior; neither replaces testing the endpoint contract you use.

Prerequisites

  • An API key in SECAPI_API_KEY.
  • A known working endpoint.

Send and inspect the version

Expect a successful response and headers similar to:
If you omit the request header, the service uses its current version value and still emits SECAPI-Version. Record the returned value before comparing behavior across environments.

Use it in a client

The JavaScript and Python clients expose an API-version option. When upgrading a client package, check its documentation and the emitted request headers.

When something changes

  1. Reproduce the request with the same method, path, parameters, and response view.
  2. Capture Request-Id, SECAPI-Version, status, and the error code when present.
  3. Compare the affected operation’s API reference and the changelog.
  4. Test any new client or application version in a controlled environment before moving production traffic.

Limits and production notes

  • A version header does not make an undocumented field or endpoint-specific projection universal.
  • Treat new optional fields and unknown enum values defensively.
  • Keep version configuration near your client construction and log the response version with each failed request.
  • Do not infer a release policy from an echoed header; use published migration guidance when it exists.
Next: API conventions or request diagnostics.