Hometrack · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Hometrack PRH Core External Client API v2.0

3 actions 3 updates update extends openapi/hometrack-prh-core-external-client-api-v2-openapi.yml
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-generatedx-apievangelist-sourcex-apievangelist-operationsx-apievangelist-accessx-apievangelist-notesOAuth2ClientCredentialsx-apievangelist-server-note

Targets 3

$.info
$.components.securitySchemes
$.servers

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Hometrack PRH Core External Client API v2.0
  version: 1.0.0
extends: openapi/hometrack-prh-core-external-client-api-v2-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-provider: hometrack
    x-apievangelist-generated: '2026-07-26'
    x-apievangelist-source: https://developer.hometrack.com/apis (Azure API Management OpenAPI export)
    x-apievangelist-operations: 19
    x-apievangelist-access:
      pricing: paid
      onboarding: partner
      public: false
      trial: false
      note: Contracts are public; the data plane returns HTTP 401 without a Hometrack-issued credential.
    x-apievangelist-notes: The only Hometrack API with pagination (page/pageSize/pageResults, response
      TotalCount/PageCount/Page/PageSize) and the only one with a uniform HTTP status vocabulary across
      every operation. Schema titles reveal the internal platform name, PRISM. The 25-value caseStatus
      enum is effectively the published state machine of UK mortgage property-risk decisioning.
- target: $.components.securitySchemes
  update:
    OAuth2ClientCredentials:
      type: oauth2
      description: Documented on https://developer.hometrack.com/api-authentication but absent from the
        Azure API Management export. Added here as an overlay, not a change to the harvested spec.
      flows:
        clientCredentials:
          tokenUrl: https://hometrack-prod.eu.auth0.com/oauth/token
          scopes:
            read:valuations: Read access to valuations.
            write:valuations: Write access to valuations.
- target: $.servers
  update:
    x-apievangelist-server-note: The second declared server, api.hometrack.local, is an internal development
      hostname that does not resolve publicly. Only https://api.hometrack.com is usable.