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

# Search multifamily properties

> Apartment properties matching an address, property name or owner, best matches first. Up to 100 for address searches and 500 for owner searches. Not paged: narrow the query to reach other properties. Billable when anything matches; empty results are free.



## OpenAPI

````yaml /openapi.json get /api/v4/multifamily/search
openapi: 3.1.0
info:
  title: quoindata Property API
  version: quoin-v4
  description: >-
    Two products, each with its own API keys: Property records (property,
    ownership, tax, sales and permit records) and Multifamily (apartment
    property profiles).
servers:
  - url: https://developer.quoindata.com
security: []
tags:
  - name: Property records
  - name: Multifamily
paths:
  /api/v4/multifamily/search:
    get:
      tags:
        - Multifamily
      summary: Search multifamily properties
      description: >-
        Apartment properties matching an address, property name or owner, best
        matches first. Up to 100 for address searches and 500 for owner
        searches. Not paged: narrow the query to reach other properties.
        Billable when anything matches; empty results are free.
      operationId: multifamily_search
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 256
          description: >-
            A unique value per logical call. Retrying with the same key within
            seven days returns the stored response at no charge.
        - name: q
          in: query
          required: true
          description: >-
            Address or property name, or an owner, operator or contact name when
            by=owner. 3–100 characters.
          schema:
            type: string
            minLength: 3
            maxLength: 100
        - name: by
          in: query
          required: false
          description: >-
            address (default) or owner. Owner search matches every typed word
            and follows shared mailing addresses one step.
          schema:
            default: address
            type: string
            enum:
              - address
              - owner
        - name: state
          in: query
          required: false
          description: Two-letter state code to limit matches to.
          schema:
            type: string
            enum:
              - DC
              - MD
              - VA
        - name: limit
          in: query
          required: false
          description: Results, 1–100 for by=address or 1–500 for by=owner. Default 20.
          schema:
            default: 20
            type: integer
            minimum: 1
            maximum: 500
      responses:
        '200':
          description: Success
          headers:
            X-Quoin-Charged-Micro-USD:
              schema:
                type: integer
              description: >-
                Amount charged for this call in millionths of a dollar. 0 for
                free calls and replays.
            X-Quoin-Balance-Micro-USD:
              schema:
                type: integer
              description: Remaining account credit in millionths of a dollar.
            X-Quoin-Replayed:
              schema:
                type: string
              description: >-
                true when the response is a stored replay of an earlier call
                with the same Idempotency-Key.
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Calls left in the current minute.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: object
                    properties:
                      items:
                        type: array
                        items:
                          type: object
                          required:
                            - property_id
                          properties:
                            property_id:
                              type: string
                              format: uuid
                            name:
                              type: string
                            address:
                              type: string
                            city:
                              type: string
                            state:
                              type: string
                              enum:
                                - DC
                                - MD
                                - VA
                            zip:
                              type: string
                            units:
                              type: number
                            year_built:
                              type: integer
                            owner:
                              type: string
                              description: >-
                                Recorded owner, or an inferred owner marked
                                "(inferred)".
                            operator:
                              type: string
                              description: >-
                                True owner or operator, or an inferred one
                                marked "(inferred)".
                            connection:
                              type: string
                              description: 'Owner searches only: why this property matched.'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '400':
          description: Invalid request. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '401':
          description: Missing or revoked API key. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '402':
          description: Credit used up; add funds in the portal. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '403':
          description: >-
            Key is for the other product, or the account is suspended. Not
            charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '404':
          description: Not found, or no search matches. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '409':
          description: Idempotency-Key reused for a different request. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '422':
          description: Response too large. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '429':
          description: Rate limit reached. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
        '503':
          description: Timed out or temporarily unavailable; retry. Not charged.
          content:
            application/json:
              schema:
                type: object
                required:
                  - contract_version
                  - request_id
                  - operation
                  - status
                  - data
                  - error
                  - meta
                properties:
                  contract_version:
                    const: quoin-v4
                  request_id:
                    type: string
                    description: Your Idempotency-Key, or a generated id.
                  operation:
                    type: string
                  status:
                    enum:
                      - ok
                      - error
                  data:
                    type: 'null'
                  error:
                    anyOf:
                      - type: object
                        properties:
                          code:
                            type: string
                            description: Stable machine-readable code. See Errors.
                          message:
                            type: string
                          retryable:
                            type: boolean
                      - type: 'null'
                  meta:
                    type: object
                    properties:
                      served_at:
                        type: string
                        format: date-time
                      next_cursor:
                        type:
                          - string
                          - 'null'
      security:
        - bearer_auth: []
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Create a key for the product you need at
        https://developer.quoindata.com/keys. A key works only for its own
        product.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.