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

# Get featured listings for a brokerage

> Returns the brokerage's featured/promoted listings from IDX Broker.
These are the listings the agent has manually promoted in their IDX
Broker dashboard. Supports pagination.




## OpenAPI

````yaml openapi.yaml post /v1/listings/featured
openapi: 3.1.0
info:
  title: ARIS API
  version: 1.0.0
  description: >
    The ARIS API provides programmatic access to the AI real estate assistant

    engine, MLS listing search, widget configuration, and lead management.


    ## Authentication


    All requests must include your developer API key in the `X-ARIS-API-Key`
    header.

    Obtain a key from the ARIS dashboard under **Settings → Developer Keys**.


    ```

    X-ARIS-API-Key: your-api-key

    ```


    Your API key is scoped to your brokerage. The `brokerageId` field in request

    bodies must match the brokerage associated with your key.


    ## Base URL


    ```

    https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router

    ```


    ## Rate Limits


    Requests are subject to your plan's monthly credit allowance. Each

    `/v1/chat` request consumes credits proportional to token usage. Listing

    search and config endpoints do not consume credits.


    ## Streaming


    The `/v1/chat` endpoint returns a Server-Sent Events (SSE) stream in

    OpenAI-compatible delta format. Each event is:


    ```

    data: {"choices":[{"delta":{"content":"..."},"index":0}]}

    ```


    The stream ends with:


    ```

    data: [DONE]

    ```
servers:
  - url: https://dqgynnlsclfbqysauesf.supabase.co/functions/v1/api-router
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /v1/listings/featured:
    post:
      summary: Get featured listings for a brokerage
      description: |
        Returns the brokerage's featured/promoted listings from IDX Broker.
        These are the listings the agent has manually promoted in their IDX
        Broker dashboard. Supports pagination.
      operationId: getFeaturedListings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - brokerageId
              properties:
                brokerageId:
                  type: string
                  example: 550e8400-e29b-41d4-a716-446655440000
                agentId:
                  type: string
                  nullable: true
                  description: Filter to a specific agent's featured listings.
                officeId:
                  type: string
                  nullable: true
                  description: Filter to a specific office's featured listings.
                limit:
                  type: integer
                  default: 10
                  example: 10
                page:
                  type: integer
                  default: 1
                  example: 1
            example:
              brokerageId: 550e8400-e29b-41d4-a716-446655440000
              limit: 10
              page: 1
      responses:
        '200':
          description: Featured listings and pagination metadata.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Listing'
                  total:
                    type: integer
                  page:
                    type: integer
                  limit:
                    type: integer
                  hasMore:
                    type: boolean
components:
  schemas:
    Listing:
      type: object
      description: A normalized MLS property listing.
      properties:
        listingId:
          type: string
          description: Unique listing identifier from the MLS.
          example: a12345
        address:
          type: string
          example: 123 Main St, Austin, TX 78701
        city:
          type: string
          example: Austin
        state:
          type: string
          example: TX
        zip:
          type: string
          example: '78701'
        price:
          oneOf:
            - type: string
            - type: number
          description: Listing price. May be a formatted string or numeric value.
          example: '450000'
        beds:
          type: number
          example: 3
        baths:
          type: number
          example: 2
        sqft:
          oneOf:
            - type: string
            - type: number
          example: '1850'
        photos:
          type: array
          items:
            type: string
            format: uri
          description: Array of photo URLs, ordered with primary photo first.
        daysOnMarket:
          type: integer
          example: 14
        description:
          type: string
          nullable: true
          description: Listing remarks, truncated to 200 characters.
        status:
          type: string
          example: Active
        detailsUrl:
          type: string
          format: uri
          nullable: true
          description: Full-detail listing URL on the IDX Broker-hosted page.
        videoUrls:
          type: array
          nullable: true
          items:
            type: object
            properties:
              url:
                type: string
                format: uri
              title:
                type: string
                nullable: true
          description: Video tour URLs attached to this listing, if any.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-ARIS-API-Key

````