> ## 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.

# Get property summary

> One best value per field (year built, bedrooms, baths, living area, assessed value, last sale) with its citation and alternatives. Billable.



## OpenAPI

````yaml /openapi.json get /api/v4/entities/{q_id}/summary
openapi: 3.1.0
info:
  title: Quoin Property API
  version: quoin-v4
  description: Cited property records for Washington, D.C., Maryland and Northern Virginia.
servers:
  - url: https://portal.quoindata.com
security: []
tags:
  - name: Lookups
  - name: Property data
  - name: Search
paths:
  /api/v4/entities/{q_id}/summary:
    get:
      tags:
        - Property data
      summary: Get property summary
      description: >-
        One best value per field (year built, bedrooms, baths, living area,
        assessed value, last sale) with its citation and alternatives. Billable.
      operationId: summary
      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_id
          in: path
          required: true
          description: >-
            Entity id: addr_, parc_, acct_ or unit_ followed by a UUID. Get one
            from find.
          schema:
            type: string
            pattern: >-
              ^(addr|parc|acct|unit)_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
        - name: fields
          in: query
          required: false
          description: 'Comma-separated fields to return. Default: all.'
          schema:
            type: string
            maxLength: 1000
      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
                          properties:
                            field:
                              type: string
                            label:
                              type:
                                - string
                                - 'null'
                            value:
                              type:
                                - string
                                - 'null'
                            citation:
                              type: object
                              properties:
                                source:
                                  type:
                                    - string
                                    - 'null'
                                dataset:
                                  type:
                                    - string
                                    - 'null'
                                as_of:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - source
                                - dataset
                                - as_of
                              additionalProperties: {}
                              description: >-
                                Publisher, dataset and the date Quoin published
                                the data.
                            record_ref:
                              type: string
                            alternatives: {}
                          required:
                            - field
                            - label
                            - value
                            - citation
                            - record_ref
                            - alternatives
                          additionalProperties: false
                      next_cursor:
                        type: string
                        description: >-
                          Present when more results exist. Pass it back as
                          cursor.
                  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 and no payment method. 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: Account 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 at https://portal.quoindata.com/keys.

````

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