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

# Read nearby school information

> Read the source-supplied section from this account’s unexpired retained listing. Missing sections return CAPABILITY_UNAVAILABLE; explicitly empty source collections remain empty. Source associations are operation-specific. School information does not establish attendance assignment; attribution does not verify identity or licensing; tax and nearby-home observations are not tax bills or verified comparable sales. No source request; retained for 24 hours.

Read source-supplied school information from retained Zillow detail or StreetEasy search observations. Source fields and grade codes are preserved without inferring attendance assignment, school identity, distance units or rating scales. Missing sections return CAPABILITY\_UNAVAILABLE. No fresh source request; one credit per successful read.


## OpenAPI

````yaml GET /v1/listings/{listing_id}/schools
openapi: 3.1.0
info:
  title: RealtyCrawl API
  version: 0.1.0
  description: >-
    Unified real estate API with source-specific operations, markets and access
    requirements. Check current capabilities before source requests.
    Documentation-backed beta contracts require explicit configuration and do
    not establish fresh live source acceptance.
servers:
  - url: https://realtycrawl.dev
security:
  - ApiKeyAuth: []
externalDocs:
  url: https://realtycrawl.dev/docs
paths:
  /v1/listings/{listing_id}/schools:
    get:
      tags:
        - listings
      summary: Read nearby school information
      description: >-
        Read the source-supplied section from this account’s unexpired retained
        listing. Missing sections return CAPABILITY_UNAVAILABLE; explicitly
        empty source collections remain empty. Source associations are
        operation-specific. School information does not establish attendance
        assignment; attribution does not verify identity or licensing; tax and
        nearby-home observations are not tax bills or verified comparable sales.
        No source request; retained for 24 hours.
      operationId: getListingSchools
      parameters:
        - name: listing_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: fields
          in: query
          description: >-
            Response-only comma-separated field paths relative to data items; up
            to 32 paths. Source requests and billing are unchanged.
          schema:
            type: string
            maxLength: 4127
        - name: format
          in: query
          description: >-
            Response-only export format. JSON retains the envelope; CSV/NDJSON
            contain data records, with request/credit metadata in headers.
            Errors stay JSON.
          schema:
            type: string
            enum:
              - json
              - csv
              - ndjson
            default: json
      responses:
        '200':
          description: Source observation; inspect meta for evidence and completeness.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getListingSchoolsResponse'
            text/csv:
              schema:
                type: string
                description: Data rows only; request, row count and credits are in headers.
            application/x-ndjson:
              schema:
                type: string
                description: One JSON data item per line; metadata is in headers.
        default:
          description: Typed error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    getListingSchoolsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ListingSchools'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - data
        - meta
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details:
              type: array
              items:
                $ref: '#/components/schemas/SourceOutcome'
          required:
            - code
            - message
            - retryable
          additionalProperties: false
        request_id:
          type: string
      required:
        - error
        - request_id
      additionalProperties: false
    ListingSchools:
      type: object
      properties:
        schools:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              grades:
                anyOf:
                  - type: string
                  - type: 'null'
              level:
                anyOf:
                  - type: string
                  - type: 'null'
              type:
                anyOf:
                  - type: string
                  - type: 'null'
              rating:
                anyOf:
                  - type: object
                    properties:
                      value:
                        type: number
                      scale:
                        type: 'null'
                      provider:
                        const: source_reported
                    required:
                      - value
                      - scale
                      - provider
                    additionalProperties: false
                  - type: 'null'
              distance:
                anyOf:
                  - type: object
                    properties:
                      value:
                        type: number
                      unit:
                        type: 'null'
                    required:
                      - value
                      - unit
                    additionalProperties: false
                  - type: 'null'
              website:
                anyOf:
                  - type: string
                    format: uri
                  - type: 'null'
              source:
                $ref: '#/components/schemas/Source'
            required:
              - name
              - grades
              - level
              - type
              - rating
              - distance
              - website
              - source
            additionalProperties: false
        assignment_verified:
          const: false
        completeness:
          const: unknown
        origin:
          const: source_reported
        source:
          $ref: '#/components/schemas/Source'
      required:
        - schools
        - assignment_verified
        - completeness
        - origin
        - source
      additionalProperties: false
    Meta:
      type: object
      properties:
        request_id:
          type: string
        schema_version:
          type: string
        generated_at:
          type: string
          format: date-time
        completeness:
          type: string
          enum:
            - complete
            - partial
            - unknown
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceOutcome'
        warnings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              field:
                type: string
            required:
              - code
              - message
            additionalProperties: false
        pagination:
          type: object
          properties:
            next_cursor:
              anyOf:
                - type: string
                - type: 'null'
            has_more:
              type: boolean
            returned:
              type: integer
            total:
              anyOf:
                - type: integer
                - type: 'null'
            total_relation:
              type: string
              enum:
                - exact
                - lower_bound
                - unknown
          required:
            - next_cursor
            - has_more
            - returned
            - total
            - total_relation
          additionalProperties: false
        property_groups:
          type: array
          items:
            $ref: '#/components/schemas/PropertyGroup'
      required:
        - request_id
        - schema_version
        - generated_at
        - completeness
        - sources
      additionalProperties: false
    SourceOutcome:
      type: object
      properties:
        platform:
          type: string
        provider:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
          enum:
            - success
            - partial
            - failed
            - unsupported
        error_code:
          anyOf:
            - type: string
            - type: 'null'
        truncated:
          type: boolean
        observed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      required:
        - platform
        - status
      additionalProperties: false
    Source:
      type: object
      properties:
        platform:
          type: string
        country:
          type: string
        native_id:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
              format: uri
            - type: 'null'
        provider:
          type: string
        observed_at:
          type: string
          format: date-time
        source_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        access_class:
          type: string
          enum:
            - public_portal
            - licensed_feed
            - public_record
            - modeled
        retrieved_at:
          type: string
          format: date-time
      required:
        - platform
        - provider
        - observed_at
        - access_class
      additionalProperties: false
    PropertyGroup:
      type: object
      properties:
        property_id:
          anyOf:
            - type: string
            - type: 'null'
        listing_ids:
          type: array
          items:
            type: string
        match_method:
          type: string
        confidence:
          anyOf:
            - type: number
            - type: 'null'
        status:
          type: string
          enum:
            - matched
            - ambiguous
      required:
        - property_id
        - listing_ids
        - match_method
        - status
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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