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

# /onthemarket/locations/search

> Resolve a location name (town, district, postcode or station) into OnTheMarket location identifiers. Returns matches with location_id, name, location_type and the parent area. Feed location_id into the onthemarket/properties/search endpoint.

**Price:** 1 credit



## OpenAPI

````yaml /openapi/real-estate.json post /api/onthemarket/locations/search
openapi: 3.1.0
info:
  title: Any Site API
  description: >+
    Any Site API provides programmatic access to data from LinkedIn, Instagram,
    Twitter, and other platforms.


    ## Authentication


    All API endpoints require an `access-token` header with a valid API token.
    Tokens can be created in the [dashboard](https://app.anysite.io/).


    ## Pricing


    Each endpoint has a credit cost listed in its description. Credits are
    deducted from your token balance per request.

  version: 0.0.1
servers: []
security:
  - AccessToken: []
paths:
  /api/onthemarket/locations/search:
    post:
      tags:
        - /onthemarket
      summary: /onthemarket/locations/search
      description: >-
        Resolve a location name (town, district, postcode or station) into
        OnTheMarket location identifiers. Returns matches with location_id,
        name, location_type and the parent area. Feed location_id into the
        onthemarket/properties/search endpoint.


        **Price:** 1 credit
      operationId: __api_onthemarket_locations_search_post
      parameters:
        - name: access-token
          in: header
          required: true
          schema:
            anyOf:
              - type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnthemarketLocationsSearchPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OnthemarketLocation'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    OnthemarketLocationsSearchPayload:
      properties:
        timeout:
          type: integer
          maximum: 1500
          minimum: 20
          default: 300
        keyword:
          type: string
          minLength: 1
        search_type:
          $ref: '#/components/schemas/OnthemarketSearchType'
          default: for-sale
        count:
          type: integer
          minimum: 1
      type: object
      required:
        - keyword
        - count
    OnthemarketLocation:
      properties:
        '@type':
          type: string
          default: OnthemarketLocation
        location_id:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
        location_type:
          anyOf:
            - type: string
            - type: 'null'
        parent:
          anyOf:
            - type: string
            - type: 'null'
      type: object
      required:
        - location_id
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    OnthemarketSearchType:
      type: string
      enum:
        - for-sale
        - to-rent
        - new-homes
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
        input: {}
        ctx:
          type: object
      type: object
      required:
        - loc
        - msg
        - type
  securitySchemes:
    AccessToken:
      type: apiKey
      in: header
      name: access-token
      description: API token from the dashboard

````