Hometrack Broker API

The Broker API from Hometrack — 10 operation(s) for broker.

Operations 10

GET /broker/valuation/{valuationId} FindValuationById-Spec #
GET /broker/v2/valuation/{valuationId} FindValuationByIdV2-Spec #
GET /broker/valuation/{valuationId}/input GetValuationInputById-Spec #
GET /broker/v2/valuation/{valuationId}/input GetValuationInputByIdV2-Spec #
GET /broker/order/{orderId} GetValuationOrderById-Spec #
GET /broker/v2/order/{orderId} GetValuationOrderByIdV2-Spec #
GET /broker/order/{orderId}/status GetValuationStatusById-Spec #
GET /broker/v2/order/{orderId}/status GetValuationStatusByIdV2-Spec #
POST /broker/order ValuePropertyBroker-Spec #
POST /broker/v2/order ValuePropertyBrokerV2-Spec #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hometrack-broker-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hometrack-broker-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Avm Broker API
  description: This API provides access to the Broker AVM service.
  version: '1.0'
  x-api-evangelist-provenance:
    provider: Hometrack
    portal: https://developer.hometrack.com
    harvested: '2026-07-26'
    method: Azure API Management developer data-plane, anonymous
    sources:
    - url: https://developer.hometrack.com/developer/apis/broker-avm-api?api-version=2022-04-01-preview&export=true&format=openapi-link
      status: 200
      note: OpenAPI 3.0.1 export (info/servers/securitySchemes verbatim; paths empty in export)
    - url: https://developer.hometrack.com/developer/apis/broker-avm-api/operations?api-version=2022-04-01-preview
      status: 200
      note: operation list
    - url: https://developer.hometrack.com/developer/apis/broker-avm-api/operations/{operationId}?api-version=2022-04-01-preview
      status: 200
      note: per-operation request/response metadata
    - url: https://developer.hometrack.com/developer/apis/broker-avm-api/schemas?api-version=2022-04-01-preview
      status: 200
      note: component schema documents
    note: paths and components.schemas were reassembled verbatim from Hometrack's own APIM operation and schema metadata; nothing was invented.
servers:
- url: https://api.hometrack.com/valuation/v2
- url: https://api.hometrack.local/valuation/v2
security:
- {}
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Broker
paths:
  /broker/valuation/{valuationId}:
    get:
      operationId: FindValuationById-Spec
      summary: FindValuationById-Spec
      description: Find a valuation by ID
      parameters:
      - name: valuationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerValuation-valuationId-GetRequest'
        description: ID of valuation to return
      responses:
        '200':
          description: Valuation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiValuationResponseBroker'
              example:
                order:
                  orderReference: string
                  orderId: string
                valuationId: string
                reference: string
                avm:
                  valuationDate: string
                  effectiveDate: string
                  result: 0
                  capital:
                    capitalAmount: 0
                    confidenceBand: string
                    lowerCapitalAmount: 0
                    upperCapitalAmount: 0
                  rental:
                    rentalAmount: 0
                    confidenceBand: string
                    lowerRentalAmount: 0
                    upperRentalAmount: 0
                  property:
                    yearBuilt: 0
                    floorArea: 0
                    receptions: 0
                    knownValueDate: string
                    knownValue: 0
                    bedrooms: 0
                    propertyType: 0
                  additionalAttributes:
                  - name: string
                    value: string
                  address:
                    postcode: string
                    postTown: string
                    uprn: 0
                    udprn: 0
                    building: string
                    thoroughfare: string
                    dependentLocality: string
                    buildingNumber: 0
                    dependantThoroughfare: string
                    subBuilding: string
        '202':
          description: Valuation order in progress
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/v2/valuation/{valuationId}:
    get:
      operationId: FindValuationByIdV2-Spec
      summary: FindValuationByIdV2-Spec
      description: Find a valuation by ID
      parameters:
      - name: valuationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerV2Valuation-valuationId-GetRequest'
        description: ID of valuation to return
      responses:
        '200':
          description: Valuation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiValuationResponseBroker'
              example:
                order:
                  orderReference: string
                  orderId: string
                valuationId: string
                reference: string
                avm:
                  valuationDate: string
                  effectiveDate: string
                  result: 0
                  capital:
                    capitalAmount: 0
                    confidenceBand: string
                    lowerCapitalAmount: 0
                    upperCapitalAmount: 0
                  rental:
                    rentalAmount: 0
                    confidenceBand: string
                    lowerRentalAmount: 0
                    upperRentalAmount: 0
                  property:
                    yearBuilt: 0
                    floorArea: 0
                    receptions: 0
                    knownValueDate: string
                    knownValue: 0
                    bedrooms: 0
                    propertyType: 0
                  additionalAttributes:
                  - name: string
                    value: string
                  address:
                    postcode: string
                    postTown: string
                    uprn: 0
                    udprn: 0
                    building: string
                    thoroughfare: string
                    dependentLocality: string
                    buildingNumber: 0
                    dependantThoroughfare: string
                    subBuilding: string
        '202':
          description: Valuation order in progress
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/valuation/{valuationId}/input:
    get:
      operationId: GetValuationInputById-Spec
      summary: GetValuationInputById-Spec
      description: Gets the input supplied at inception to request a valuation
      parameters:
      - name: valuationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerValuation-valuationId-InputGetRequest'
        description: ID of valuation to return
      responses:
        '200':
          description: Valuation Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/valuationSectionBroker'
              example:
                address:
                  postcode: string
                  address: string
                  uprn: 0
                effectiveDate: string
                loan:
                  repaymentType: 0
                  minimumRentalIncome: 0
                  additionalLoanAmount: 0
                  outstandingLoanAmount: 0
                  loanAmount: 0
                  remainingTerm: 0
                  existingMortgage: 0
                  instructionType: 1
                property:
                  receptions: 0
                  bedrooms: 0
                  propertyStyle: string
                  propertyType: 0
                  visibleFromRoad: true
                  constructionPeriod: string
                  constructionType: 0
                  exLocalAuthority: true
                  parking: true
                  floorArea: 0
                  yearBuilt: 0
                reference: string
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/v2/valuation/{valuationId}/input:
    get:
      operationId: GetValuationInputByIdV2-Spec
      summary: GetValuationInputByIdV2-Spec
      description: Gets the input supplied at inception to request a valuation
      parameters:
      - name: valuationId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerV2Valuation-valuationId-InputGetRequest'
        description: ID of valuation to return
      responses:
        '200':
          description: Valuation Input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/valuationSectionBroker'
              example:
                address:
                  postcode: string
                  address: string
                  uprn: 0
                effectiveDate: string
                loan:
                  repaymentType: 0
                  minimumRentalIncome: 0
                  additionalLoanAmount: 0
                  outstandingLoanAmount: 0
                  loanAmount: 0
                  remainingTerm: 0
                  existingMortgage: 0
                  instructionType: 1
                property:
                  receptions: 0
                  bedrooms: 0
                  propertyStyle: string
                  propertyType: 0
                  visibleFromRoad: true
                  constructionPeriod: string
                  constructionType: 0
                  exLocalAuthority: true
                  parking: true
                  floorArea: 0
                  yearBuilt: 0
                reference: string
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/order/{orderId}:
    get:
      operationId: GetValuationOrderById-Spec
      summary: GetValuationOrderById-Spec
      description: Find a valuation order by ID
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerOrder-orderId-GetRequest'
        description: ID of order to return
      responses:
        '200':
          description: Valuation order response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/valuationOrderResponse'
              example:
                orderId: string
                orderReference: string
                valuations:
                - valuationId: string
                  reference: string
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/v2/order/{orderId}:
    get:
      operationId: GetValuationOrderByIdV2-Spec
      summary: GetValuationOrderByIdV2-Spec
      description: Find a valuation order by ID
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerV2Order-orderId-GetRequest'
        description: ID of order to return
      responses:
        '200':
          description: Valuation order response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/valuationOrderResponse'
              example:
                orderId: string
                orderReference: string
                valuations:
                - valuationId: string
                  reference: string
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/order/{orderId}/status:
    get:
      operationId: GetValuationStatusById-Spec
      summary: GetValuationStatusById-Spec
      description: Get the status of a valuation order by order ID
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerOrder-orderId-StatusGetRequest'
        description: ID of order to return
      responses:
        '200':
          description: Valuation order status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderStatusResponse'
              example:
                orderId: string
                orderReference: string
                status: 0
                valuations:
                - valuationId: string
                  reference: string
                  status: 0
                  valuationType: 0
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/v2/order/{orderId}/status:
    get:
      operationId: GetValuationStatusByIdV2-Spec
      summary: GetValuationStatusByIdV2-Spec
      description: Get the status of a valuation order by order ID
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/BrokerV2Order-orderId-StatusGetRequest'
        description: ID of order to return
      responses:
        '200':
          description: Valuation order status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/orderStatusResponse'
              example:
                orderId: string
                orderReference: string
                status: 0
                valuations:
                - valuationId: string
                  reference: string
                  status: 0
                  valuationType: 0
        '401':
          description: Unauthorised request
        '404':
          description: Valuation order not found
      tags:
      - Broker
  /broker/order:
    post:
      operationId: ValuePropertyBroker-Spec
      summary: ValuePropertyBroker-Spec
      description: Creates the valuation order for the property
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiRequestBroker'
            example:
              order:
                accountId: 0
                orderReference: string
                userId: 0
                valuationType: 0
              valuations:
              - address:
                  postcode: string
                  address: string
                  uprn: 0
                effectiveDate: string
                loan:
                  repaymentType: 0
                  minimumRentalIncome: 0
                  additionalLoanAmount: 0
                  outstandingLoanAmount: 0
                  loanAmount: 0
                  remainingTerm: 0
                  existingMortgage: 0
                  instructionType: 1
                property:
                  receptions: 0
                  bedrooms: 0
                  propertyStyle: string
                  propertyType: 0
                  visibleFromRoad: true
                  constructionPeriod: string
                  constructionType: 0
                  exLocalAuthority: true
                  parking: true
                  floorArea: 0
                  yearBuilt: 0
                reference: string
      responses:
        '200':
          description: Valuation order ID
          content:
            plain/text:
              schema:
                $ref: '#/components/schemas/BrokerOrderPost200PlainTextResponse'
        '400':
          description: Incorrect input data submitted
        '403':
          description: Operation forbidden
      tags:
      - Broker
  /broker/v2/order:
    post:
      operationId: ValuePropertyBrokerV2-Spec
      summary: ValuePropertyBrokerV2-Spec
      description: Creates the valuation order with climate data for the property
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiRequestBroker'
            example:
              order:
                accountId: 0
                orderReference: string
                userId: 0
                valuationType: 0
              valuations:
              - address:
                  postcode: string
                  address: string
                  uprn: 0
                effectiveDate: string
                loan:
                  repaymentType: 0
                  minimumRentalIncome: 0
                  additionalLoanAmount: 0
                  outstandingLoanAmount: 0
                  loanAmount: 0
                  remainingTerm: 0
                  existingMortgage: 0
                  instructionType: 1
                property:
                  receptions: 0
                  bedrooms: 0
                  propertyStyle: string
                  propertyType: 0
                  visibleFromRoad: true
                  constructionPeriod: string
                  constructionType: 0
                  exLocalAuthority: true
                  parking: true
                  floorArea: 0
                  yearBuilt: 0
                reference: string
      responses:
        '200':
          description: Valuation order ID
          content:
            plain/text:
              schema:
                $ref: '#/components/schemas/BrokerV2OrderPost200PlainTextResponse'
        '400':
          description: Incorrect input data submitted
        '403':
          description: Operation forbidden
      tags:
      - Broker
components:
  schemas:
    valuationListResponse:
      type: object
      properties:
        valuationId:
          type: string
        reference:
          type: string
    cavmCapital:
      type: object
      properties:
        capitalAmount:
          type: integer
          format: int32
        confidenceBand:
          type: string
        lowerCapitalAmount:
          type: integer
          format: int32
        upperCapitalAmount:
          type: integer
          format: int32
    order:
      type: object
      properties:
        accountId:
          type: integer
          format: int32
        orderReference:
          type: string
        userId:
          type: integer
          format: int32
        valuationType:
          enum:
          - 0
          - 1
          - 2
          type: integer
          format: int32
          default: 0
    BrokerV2Order-orderId-GetRequest:
      type: string
      x-apim-inline: true
    property:
      type: object
      properties:
        receptions:
          type:
          - integer
          - 'null'
          format: int32
        bedrooms:
          type:
          - integer
          - 'null'
          format: int32
        propertyStyle:
          type: string
        propertyType:
          type:
          - integer
          - 'null'
          format: int32
        visibleFromRoad:
          type: boolean
        constructionPeriod:
          type: string
        constructionType:
          type:
          - integer
          - 'null'
          format: int32
        exLocalAuthority:
          type: boolean
        parking:
          type: boolean
        floorArea:
          type:
          - integer
          - 'null'
          format: int32
        yearBuilt:
          type:
          - integer
          - 'null'
          format: int32
    additionalAttribute:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
    BrokerV2OrderPost200PlainTextResponse:
      type: string
      x-apim-inline: true
    BrokerOrder-orderId-GetRequest:
      type: string
      x-apim-inline: true
    BrokerOrderPost200PlainTextResponse:
      type: string
      x-apim-inline: true
    propertyAttributesUsedBroker:
      type: object
      properties:
        yearBuilt:
          type:
          - integer
          - 'null'
          format: int32
        floorArea:
          type:
          - integer
          - 'null'
          format: int32
        receptions:
          type:
          - integer
          - 'null'
          format: int32
        knownValueDate:
          type:
          - string
          - 'null'
          format: date-time
        knownValue:
          type:
          - integer
          - 'null'
          format: int32
        bedrooms:
          type:
          - integer
          - 'null'
          format: int32
        propertyType:
          type:
          - integer
          - 'null'
          format: int32
    BrokerV2Order-orderId-StatusGetRequest:
      type: string
      x-apim-inline: true
    apiValuationResponseBroker:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/orderApi'
        valuationId:
          type: string
        reference:
          type: string
        avm:
          $ref: '#/components/schemas/avmValuationBroker'
    addressRequestBroker:
      type: object
      properties:
        postcode:
          type: string
        address:
          type: string
        uprn:
          type:
          - integer
          - 'null'
          format: int64
    addressResponse:
      type: object
      properties:
        postcode:
          type: string
        postTown:
          type: string
        uprn:
          type:
          - integer
          - 'null'
          format: int64
        udprn:
          type:
          - integer
          - 'null'
          format: int64
        building:
          type: string
        thoroughfare:
          type: string
        dependentLocality:
          type: string
        buildingNumber:
          type:
          - integer
          - 'null'
          format: int32
        dependantThoroughfare:
          type: string
        subBuilding:
          type: string
    BrokerV2Valuation-valuationId-InputGetRequest:
      type: string
      x-apim-inline: true
    apiRequestBroker:
      type: object
      properties:
        order:
          $ref: '#/components/schemas/order'
        valuations:
          type: array
          items:
            $ref: '#/components/schemas/valuationSectionBroker'
    loan:
      type: object
      properties:
        repaymentType:
          type:
          - integer
          - 'null'
          format: int32
        minimumRentalIncome:
          type:
          - integer
          - 'null'
          format: int32
        additionalLoanAmount:
          type:
          - integer
          - 'null'
          format: int32
        outstandingLoanAmount:
          type:
          - integer
          - 'null'
          format: int32
        loanAmount:
          type:
          - integer
          - 'null'
          format: int32
        remainingTerm:
          type:
          - integer
          - 'null'
          format: int32
        existingMortgage:
          type:
          - integer
          - 'null'
          format: int32
        instructionType:
          enum:
          - 1
          - 2
          - 3
          - 4
          - 5
          type:
          - integer
          - 'null'
          format: int32
          default: 1
    avmValuationBroker:
      type: object
      properties:
        valuationDate:
          type: string
          format: date-time
        effectiveDate:
          type: string
          format: date-time
        result:
          enum:
          - 0
          - 1
          type: integer
          format: int32
          default: 0
        capital:
          $ref: '#/components/schemas/cavmCapital'
        rental:
          $ref: '#/components/schemas/cavmRental'
        property:
          $ref: '#/components/schemas/propertyAttributesUsedBroker'
        additionalAttributes:
          type: array
          items:
            $ref: '#/components/schemas/additionalAttribute'
        address:
          $ref: '#/components/schemas/addressResponse'
    valuationStatusResponse:
      type: object
      properties:
        valuationId:
          type: string
        reference:
          type: string
        status:
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
          format: int32
          default: 0
        valuationType:
          enum:
          - 0
          - 1
          - 2
          type: integer
          format: int32
          default: 0
    BrokerValuation-valuationId-GetRequest:
      type: string
      x-apim-inline: true
    BrokerOrder-orderId-StatusGetRequest:
      type: string
      x-apim-inline: true
    cavmRental:
      type: object
      properties:
        rentalAmount:
          type: integer
          format: int32
        confidenceBand:
          type: string
        lowerRentalAmount:
          type: integer
          format: int32
        upperRentalAmount:
          type: integer
          format: int32
    BrokerV2Valuation-valuationId-GetRequest:
      type: string
      x-apim-inline: true
    valuationSectionBroker:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/addressRequestBroker'
        effectiveDate:
          type:
          - string
          - 'null'
          format: date-time
        loan:
          $ref: '#/components/schemas/loan'
        property:
          $ref: '#/components/schemas/property'
        reference:
          type: string
    orderStatusResponse:
      type: object
      properties:
        orderId:
          type: string
        orderReference:
          type: string
        status:
          enum:
          - 0
          - 1
          - 2
          - 3
          type: integer
          format: int32
          default: 0
        valuations:
          type: array
          items:
            $ref: '#/components/schemas/valuationStatusResponse'
    BrokerValuation-valuationId-InputGetRequest:
      type: string
      x-apim-inline: true
    valuationOrderResponse:
      type: object
      properties:
        orderId:
          type: string
        orderReference:
          type: string
        valuations:
          type: array
          items:
            $ref: '#/components/schemas/valuationListResponse'
    orderApi:
      type: object
      properties:
        orderReference:
          type: string
        orderId:
          type: string
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query