> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hostreach.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Search platform locations

> Autocomplete search for location names on a platform. Pass the `q` query parameter with a partial name (e.g. "Valencia"). Use the returned location object directly as the `filters.location` value in `POST /extractions`.



## OpenAPI

````yaml /openapi.json get /public/v1/platforms/{platform}/locations
openapi: 3.0.0
info:
  title: Hostreach API
  description: >-
    Public REST API for Hostreach.


    Authenticate with an API key via the `X-Api-Key` header or `Authorization:
    Bearer <key>` header.


    Generate API keys from **Settings › Workspace › Acceso API** in the
    dashboard.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.hostreach.io/v2
    description: Production
  - url: http://localhost:3001/v1
    description: Local
security:
  - apiKey: []
tags:
  - name: Identity
    description: Current workspace and usage
  - name: Platforms
    description: Supported real-estate portals and filter schemas
  - name: Extractions
    description: Lead extraction jobs
  - name: Leads
    description: Lead management
  - name: Campaigns
    description: Campaign management
  - name: Messaging
    description: Inbox and WhatsApp conversations
  - name: Templates
    description: WhatsApp message templates
  - name: Accounts
    description: WhatsApp accounts
  - name: Valuations
    description: Property valuations
  - name: Fichas
    description: Property listing sheets
  - name: Scheduling
    description: Calendar and appointments
  - name: Webhooks
    description: Event subscriptions
paths:
  /public/v1/platforms/{platform}/locations:
    get:
      tags:
        - Platforms
      summary: Search platform locations
      description: >-
        Autocomplete search for location names on a platform. Pass the `q` query
        parameter with a partial name (e.g. "Valencia"). Use the returned
        location object directly as the `filters.location` value in `POST
        /extractions`.
      operationId: PlatformsController_getLocations
      parameters:
        - name: platform
          required: true
          in: path
          schema:
            enum:
              - idealista
              - fotocasa
              - metrocuadrado
              - inmuebles24
              - zonaprop
            type: string
        - name: q
          required: true
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
      security:
        - bearerApiKey: []
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API key (hr_live_... or hr_test_...). Generate from Settings › Workspace
        › Acceso API.

````