Perchwell Metadata API

OData service metadata.

OpenAPI Specification

perchwell-metadata-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Perchwell JSON Listings Metadata API
  version: '1.0'
  description: Perchwell's JSON API provides access to real estate listing data in a format designed for ease of use and speed of development. The API uses simple token authentication and a basic query interface for filtering listings and paginating through results. Faithfully generated by the API Evangelist enrichment pipeline from Perchwell's published API reference (https://docs.perchwell.com/#/json_api_getting_started).
  contact:
    name: Perchwell Support
    email: support@perchwell.com
    url: https://docs.perchwell.com
servers:
- url: https://www.perchwell.com
  description: Production
security:
- tokenAuth: []
tags:
- name: Metadata
  description: OData service metadata.
paths:
  /$metadata:
    get:
      operationId: getMetadata
      summary: Get OData service metadata
      description: Returns the CSDL metadata document describing resources, fields, and lookup values.
      tags:
      - Metadata
      responses:
        '200':
          description: OData CSDL metadata document.
          content:
            application/xml:
              schema:
                type: string
components:
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Simple token authentication. Send the API token in the Authorization header.