Rentberry SEO URLs API

SEO URLs

OpenAPI Specification

rentberry-seo-urls-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Rentberry SEO URLs API
  description: Renting Done Right. Finally.
  version: 4
tags:
- name: SEO URLs
  description: SEO URLs
paths:
  /v{version}/search_seo_url:
    post:
      tags:
      - SEO URLs
      summary: Generate SEO-optimized search URL
      description: Available since API version 1. Generates canonical, SEO-friendly URLs for search pages based on location and search parameters.
      operationId: post_api_v1_apartment_seo_url
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
          pattern: \d+
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingSeoUrl'
      responses:
        '200':
          description: SEO URL generated successfully
          content:
            application/json:
              schema:
                properties:
                  url:
                    description: Generated SEO-friendly search URL
                    type: string
                    example: /apartments-for-rent/new-york-ny
                type: object
        '400':
          description: Bad request - Validation failed
        '404':
          description: Location not found or cannot be geocoded
components:
  schemas:
    ListingSeoUrl:
      required:
      - formattedAddress
      - transactionType
      - mapView
      properties:
        formattedAddress:
          type: string
        transactionType:
          type: string
          enum:
          - rental
          - sale
        mapView:
          type: string
      type: object