openapi: 3.2.0
info:
  title: HouseSigma Blog Content Comments API
  version: wp/v2
  summary: Public, read-only WordPress REST API serving HouseSigma's Canadian housing-market blog.
  description: 'HouseSigma publishes no developer program for its real estate platform: the listing/sold/valuation backend at https://housesigma.com/bkv2/api/ is private and robots-disallowed. This document covers the one genuinely public, anonymously callable, machine-readable HTTP surface HouseSigma operates - the WordPress REST API (wp/v2) behind housesigma.com/blog-en, which serves the company''s Canadian market-analysis blog as JSON.


    This OpenAPI is DERIVED by API Evangelist from the live route-discovery document at https://housesigma.com/blog-en/wp-json/ (157 routes across 8 namespaces, HTTP 200, fetched 2026-07-26). Every path, method, parameter name, type, description, default and bound below is copied from that document; nothing is invented. Only routes verified to return HTTP 200 to an anonymous request are included.


    Write methods (POST/PUT/PATCH/DELETE) are declared by the discovery document on most collections but require WordPress authentication (the document advertises application passwords at /blog-en/wp-admin/authorize-application.php) and are deliberately NOT modelled here. Routes that returned 401 anonymously (/wp/v2/settings, /wp/v2/block-types, /oembed/1.0/proxy, /basepress_kb/v1/kb_categories) are likewise excluded.


    This is not an official HouseSigma developer product. HouseSigma does not document, support, or issue keys for this surface; it is the standard WordPress REST API left enabled on the company''s blog host.'
  contact:
    name: HouseSigma
    url: https://housesigma.com/blog-en/contact-us/
  termsOfService: https://housesigma.com/blog-en/2018/04/25/terms-of-use/
  x-evidence:
    discovery-document: https://housesigma.com/blog-en/wp-json/
    http-status: 200
    fetched: '2026-07-26'
    derived-by: API Evangelist enrichment pipeline
    namespaces-advertised:
    - oembed/1.0
    - basepress_kb/v1
    - contact-form-7/v1
    - saswp-output
    - yoast/v1
    - wp/v2
    - wp-site-health/v1
    - wp-block-editor/v1
    routes-advertised: 157
servers:
- url: https://housesigma.com/blog-en/wp-json
  description: Production (public, read-only)
security: []
tags:
- name: Comments
paths:
  /wp/v2/comments:
    get:
      operationId: listComments
      summary: List approved comments
      description: Derived from the live WordPress REST route-discovery document at https://housesigma.com/blog-en/wp-json/ (route `/wp/v2/comments`). Verified to answer anonymously over HTTPS on 2026-07-26.
      tags:
      - Comments
      security:
      - {}
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
          headers:
            X-WP-Total:
              description: Total number of matching items.
              schema:
                type: integer
            X-WP-TotalPages:
              description: Total number of pages available.
              schema:
                type: integer
            Link:
              description: RFC 8288 pagination links (rel="next" / rel="prev").
              schema:
                type: string
        '400':
          $ref: '#/components/responses/InvalidParam'
        '401':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      parameters:
      - name: context
        in: query
        required: false
        description: Scope under which the request is made; determines fields present in response.
        schema:
          type: string
          enum:
          - view
          - embed
          - edit
          default: view
      - name: page
        in: query
        required: false
        description: Current page of the collection.
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: per_page
        in: query
        required: false
        description: Maximum number of items to be returned in result set.
        schema:
          type: integer
          default: 10
          minimum: 1
          maximum: 100
      - name: search
        in: query
        required: false
        description: Limit results to those matching a string.
        schema:
          type: string
      - name: after
        in: query
        required: false
        description: Limit response to comments published after a given ISO8601 compliant date.
        schema:
          type: string
          format: date-time
      - name: author
        in: query
        required: false
        description: Limit result set to comments assigned to specific user IDs. Requires authorization.
        schema:
          type: array
          items:
            type: integer
      - name: author_exclude
        in: query
        required: false
        description: Ensure result set excludes comments assigned to specific user IDs. Requires authorization.
        schema:
          type: array
          items:
            type: integer
      - name: author_email
        in: query
        required: false
        description: Limit result set to that from a specific author email. Requires authorization.
        schema:
          type: string
          format: email
      - name: before
        in: query
        required: false
        description: Limit response to comments published before a given ISO8601 compliant date.
        schema:
          type: string
          format: date-time
      - name: exclude
        in: query
        required: false
        description: Ensure result set excludes specific IDs.
        schema:
          type: array
          items:
            type: integer
          default: []
      - name: include
        in: query
        required: false
        description: Limit result set to specific IDs.
        schema:
          type: array
          items:
            type: integer
          default: []
      - name: offset
        in: query
        required: false
        description: Offset the result set by a specific number of items.
        schema:
          type: integer
      - name: order
        in: query
        required: false
        description: Order sort attribute ascending or descending.
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      - name: orderby
        in: query
        required: false
        description: Sort collection by comment attribute.
        schema:
          type: string
          enum:
          - date
          - date_gmt
          - id
          - include
          - post
          - parent
          - type
          default: date_gmt
      - name: parent
        in: query
        required: false
        description: Limit result set to comments of specific parent IDs.
        schema:
          type: array
          items:
            type: integer
          default: []
      - name: parent_exclude
        in: query
        required: false
        description: Ensure result set excludes specific parent IDs.
        schema:
          type: array
          items:
            type: integer
          default: []
      - name: post
        in: query
        required: false
        description: Limit result set to comments assigned to specific post IDs.
        schema:
          type: array
          items:
            type: integer
          default: []
      - name: status
        in: query
        required: false
        description: Limit result set to comments assigned a specific status. Requires authorization.
        schema:
          type: string
          default: approve
      - name: type
        in: query
        required: false
        description: Limit result set to comments assigned a specific type. Requires authorization.
        schema:
          type: string
          default: comment
      - name: password
        in: query
        required: false
        description: The password for the post if it is password protected.
        schema:
          type: string
  /wp/v2/comments/{id}:
    get:
      operationId: getComment
      summary: Retrieve a comment by id
      description: Derived from the live WordPress REST route-discovery document at https://housesigma.com/blog-en/wp-json/ (route `/wp/v2/comments/(?P<id>[\d]+)`). Verified to answer anonymously over HTTPS on 2026-07-26.
      tags:
      - Comments
      security:
      - {}
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/InvalidParam'
        '401':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      parameters:
      - name: id
        in: path
        required: true
        description: Unique identifier for the comment.
        schema:
          type: integer
      - name: context
        in: query
        required: false
        description: Scope under which the request is made; determines fields present in response.
        schema:
          type: string
          enum:
          - view
          - embed
          - edit
          default: view
      - name: password
        in: query
        required: false
        description: The password for the parent post of the comment (if the post is password protected).
        schema:
          type: string
components:
  responses:
    NotFound:
      description: No such route or resource (rest_no_route / rest_post_invalid_id).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: rest_post_invalid_id
            message: Invalid post ID.
            data:
              status: 404
    Forbidden:
      description: Not permitted anonymously (rest_forbidden).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: rest_forbidden
            message: Sorry, you are not allowed to do that.
            data:
              status: 401
    InvalidParam:
      description: Invalid parameter (rest_invalid_param).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: rest_invalid_param
            message: 'Invalid parameter(s): per_page'
            data:
              status: 400
              params:
                per_page: per_page must be between 1 (inclusive) and 100 (inclusive)
  schemas:
    Error:
      type: object
      description: The WordPress REST error envelope, captured verbatim from live responses.
      properties:
        code:
          type: string
          description: Machine-readable error code, e.g. rest_no_route.
        message:
          type: string
          description: Human-readable message.
        data:
          type: object
          properties:
            status:
              type: integer
              description: HTTP status code.
            params:
              type: object
              description: Per-parameter messages (rest_invalid_param only).
            details:
              type: object
              description: Per-parameter nested error objects (rest_invalid_param only).
          required:
          - status
      required:
      - code
      - message
      - data
  securitySchemes:
    applicationPassword:
      type: http
      scheme: basic
      description: WordPress application passwords, advertised by the live discovery document at https://housesigma.com/blog-en/wp-admin/authorize-application.php. Required only for write methods and for routes excluded from this document; every operation modelled here is anonymous.