Purplebricks

Purplebricks On The Market Branch API

The OnTheMarketBranch API from Purplebricks — 3 operation(s) for onthemarketbranch.

Documentation GitHub OpenAPI

Operations 3

GET /v1/onthemarketbranch Get onthemarketbranch #

GET /v1/onthemarketbranch/{branchId} Get onthemarketbranch by branch id #

GET /v1/onthemarketbranch/search Get onthemarketbranch search #

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/purplebricks-onthemarketbranch-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Purplebricks.Branch.Api 1.0 - Squad Agents Experience On…
  description: '### Provides full branch information for a postcode or property

    ### Purplebricks.Branch.Api Git Repository'
  version: '1.0'
servers:
- url: https://api.purplebricks.co.uk/branch-api
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- Bearer: []
tags:
- name: OnTheMarketBranch
paths:
  /v1/onthemarketbranch:
    get:
      tags:
      - OnTheMarketBranch
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnTheMarketBranchList'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get onthemarketbranch
      x-summary-source: derived
      operationId: getV1Onthemarketbranch
      x-operation-id-source: derived
  /v1/onthemarketbranch/{branchId}:
    get:
      tags:
      - OnTheMarketBranch
      parameters:
      - name: branchId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnTheMarketBranch'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get onthemarketbranch by branch id
      x-summary-source: derived
      operationId: getV1OnthemarketbranchByBranchId
      x-operation-id-source: derived
  /v1/onthemarketbranch/search:
    get:
      tags:
      - OnTheMarketBranch
      parameters:
      - name: propertyId
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnTheMarketBranch'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get onthemarketbranch search
      x-summary-source: derived
      operationId: getV1OnthemarketbranchSearch
      x-operation-id-source: derived
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    BranchService:
      enum:
      - NotSpecified
      - Sales
      - Lettings
      type: string
    OnTheMarketBranchList:
      type: object
      properties:
        count:
          type: integer
          format: int32
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OnTheMarketBranch'
      additionalProperties: false
    OnTheMarketBranch:
      type: object
      properties:
        branchId:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
        postcodeArea:
          type:
          - string
          - 'null'
        service:
          $ref: '#/components/schemas/BranchService'
        livePropertyIds:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using Bearer scheme
      name: Authorization
      in: header