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



## OpenAPI

````yaml https://portal.quoindata.com/api/v2/openapi.json post /api/v2/property-queries
openapi: 3.1.0
info:
  title: Quoin Property Intelligence API
  version: quoin-v2
  description: Tenant-scoped source-linked property data.
servers:
  - url: https://portal.quoindata.com
security:
  - bearer_auth: []
paths:
  /api/v2/property-queries:
    post:
      summary: get_property
      operationId: get_property
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Unique key for one logical POST. Reuse is replay-safe or returns a
            conflict.
          schema:
            type: string
            minLength: 1
            maxLength: 256
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/get_property'
      responses:
        '200':
          description: Canonical response envelope.
          headers:
            X-Quoin-Balance-Micro-USD:
              description: Remaining welcome credit after the call, in micro-USD.
              schema:
                type: integer
                format: int64
            X-Quoin-Held-Micro-USD:
              description: Outstanding reserved credit after settlement, in micro-USD.
              schema:
                type: integer
                format: int64
                minimum: 0
            X-Quoin-Price-Micro-USD:
              description: Rate snapshot price for the admitted call, in micro-USD.
              schema:
                type: integer
                format: int64
                minimum: 0
            X-Quoin-Rate-Version:
              description: Version of the rate card used for the admitted call.
              schema:
                type: string
            X-Quoin-Calls-30d:
              description: Account call count in the rolling 30-day window.
              schema:
                type: integer
                format: int64
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseEnvelopeV2_get_property'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
        '503':
          $ref: '#/components/responses/Error'
        default:
          $ref: '#/components/responses/Error'
      security:
        - bearer_auth: []
components:
  schemas:
    get_property:
      type: object
      properties:
        property_refs:
          minItems: 1
          maxItems: 5
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 512
          description: >-
            Up to five account references; record arrays may be shortened to fit
            the 256 KiB response ceiling.
        sections:
          maxItems: 13
          type: array
          items:
            type: string
            enum:
              - identity
              - assessment
              - tax
              - delinquency_tax_sale
              - special_assessment
              - ownership
              - transfer
              - deed_reference
              - permit
              - license
              - inspection_enforcement
              - building
              - land
        fields:
          description: >-
            Reserved; the current property reader returns unavailable (HTTP
            422).
          maxItems: 256
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 256
        as_of:
          description: >-
            Reserved; historical property reads currently return unavailable
            (HTTP 422).
          type: string
          minLength: 1
          maxLength: 64
        publication_id:
          description: >-
            Reserved; publication-pinned property reads currently return
            unavailable (HTTP 422).
          type: string
          minLength: 1
          maxLength: 256
        section_limit:
          default: 20
          type: integer
          minimum: 1
          maximum: 100
        cursors:
          description: >-
            Reserved; section continuation currently returns unavailable (HTTP
            422).
          type: object
          propertyNames:
            type: string
            minLength: 1
            maxLength: 128
          additionalProperties:
            type: string
            minLength: 1
            maxLength: 4096
      required:
        - property_refs
      additionalProperties: false
    ResponseEnvelopeV2_get_property:
      type: object
      properties:
        contract_version:
          type: string
          const: quoin-v2
        request_id:
          type: string
          minLength: 1
          maxLength: 512
        operation:
          type: string
          minLength: 1
          maxLength: 256
        status:
          type: string
          enum:
            - ok
            - partial
            - error
        data:
          anyOf:
            - type: object
              properties:
                items:
                  maxItems: 5
                  type: array
                  items:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
              required:
                - items
              additionalProperties: {}
            - type: 'null'
        error:
          anyOf:
            - type: object
              properties:
                code:
                  type: string
                  minLength: 1
                  maxLength: 256
                message:
                  type: string
                  minLength: 1
                  maxLength: 4000
                retryable:
                  type: boolean
                retry_after_seconds:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                details: {}
              required:
                - code
                - message
                - retryable
              additionalProperties: false
            - type: 'null'
        meta:
          type: object
          properties:
            served_at:
              type: string
              minLength: 1
              maxLength: 64
            publication_id:
              type: string
              minLength: 1
              maxLength: 256
            generation_ids:
              maxItems: 100
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 256
            truncated:
              type: boolean
            next_cursor:
              type: string
              minLength: 1
              maxLength: 4096
            warnings:
              maxItems: 100
              type: array
              items:
                type: string
                maxLength: 1000
            usage_units:
              type: number
              minimum: 0
          required:
            - served_at
            - truncated
          additionalProperties: false
        provenance:
          anyOf:
            - type: object
              properties:
                source_refs:
                  maxItems: 100
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 512
                sources:
                  maxItems: 100
                  type: array
                  items:
                    type: object
                    properties:
                      source_ref:
                        type: string
                        minLength: 1
                        maxLength: 512
                      source_kind:
                        type: string
                        minLength: 1
                        maxLength: 256
                      publisher:
                        type: string
                        minLength: 1
                        maxLength: 256
                      release_id:
                        type: string
                        minLength: 1
                        maxLength: 256
                      captured_at:
                        type: string
                        minLength: 1
                        maxLength: 64
                      official_url:
                        type: string
                        maxLength: 2048
                        format: uri
                    required:
                      - source_ref
                      - source_kind
                    additionalProperties: false
              required:
                - source_refs
                - sources
              additionalProperties: false
            - type: 'null'
      required:
        - contract_version
        - request_id
        - operation
        - status
        - data
        - error
        - meta
      additionalProperties: false
    ResponseEnvelopeV2:
      type: object
      properties:
        contract_version:
          type: string
          const: quoin-v2
        request_id:
          type: string
          minLength: 1
          maxLength: 512
        operation:
          type: string
          minLength: 1
          maxLength: 256
        status:
          type: string
          enum:
            - ok
            - partial
            - error
        data:
          anyOf:
            - {}
            - type: 'null'
        error:
          anyOf:
            - type: object
              properties:
                code:
                  type: string
                  minLength: 1
                  maxLength: 256
                message:
                  type: string
                  minLength: 1
                  maxLength: 4000
                retryable:
                  type: boolean
                retry_after_seconds:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                details: {}
              required:
                - code
                - message
                - retryable
              additionalProperties: false
            - type: 'null'
        meta:
          type: object
          properties:
            served_at:
              type: string
              minLength: 1
              maxLength: 64
            publication_id:
              type: string
              minLength: 1
              maxLength: 256
            generation_ids:
              maxItems: 100
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 256
            truncated:
              type: boolean
            next_cursor:
              type: string
              minLength: 1
              maxLength: 4096
            warnings:
              maxItems: 100
              type: array
              items:
                type: string
                maxLength: 1000
            usage_units:
              type: number
              minimum: 0
          required:
            - served_at
            - truncated
          additionalProperties: false
        provenance:
          anyOf:
            - type: object
              properties:
                source_refs:
                  maxItems: 100
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 512
                sources:
                  maxItems: 100
                  type: array
                  items:
                    type: object
                    properties:
                      source_ref:
                        type: string
                        minLength: 1
                        maxLength: 512
                      source_kind:
                        type: string
                        minLength: 1
                        maxLength: 256
                      publisher:
                        type: string
                        minLength: 1
                        maxLength: 256
                      release_id:
                        type: string
                        minLength: 1
                        maxLength: 256
                      captured_at:
                        type: string
                        minLength: 1
                        maxLength: 64
                      official_url:
                        type: string
                        maxLength: 2048
                        format: uri
                    required:
                      - source_ref
                      - source_kind
                    additionalProperties: false
              required:
                - source_refs
                - sources
              additionalProperties: false
            - type: 'null'
      required:
        - contract_version
        - request_id
        - operation
        - status
        - data
        - error
        - meta
      additionalProperties: false
  responses:
    Error:
      description: Canonical error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnvelopeV2'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: qk_...
      description: >-
        Send `Authorization: Bearer qk_…` using an API key created in the Quoin
        Developer Portal.

````