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

# Coverage Gaps

> Where the org is short on tutors: postcodes with booking demand but too few
IN-PERSON tutors covering them, ranked worst-first.

Delegates to the get_org_coverage_gaps RPC — the single source of truth shared with
the in-app coverage map. Demand comes from this org's booking requests, status-weighted
in SQL (pending weighs most; declined/expired/matched less) and placed by
`preferred_postcode`. Supply counts IN-PERSON covering tutors only: an online
all-areas tutor "covers" everywhere but cannot physically be in the area, so it must
not mask a geographic gap. Aggregated per postcode (filter by `subject` for a single
subject). Read-only intelligence: it recommends where to recruit, it changes nothing.



## OpenAPI

````yaml /openapi.json get /v1/coverage/gaps
openapi: 3.1.0
info:
  title: EquateIt Public API
  description: >-
    REST API for EquateIt tutoring organisations. Pipe your sessions, invoices,
    payments, tutor earnings, students, and more into your own tools. Most
    endpoints are reads; a focused set of writes (each gated by a *:write scope)
    create or update data, including creating student/tutor/parent accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=ei_live_...

    Mint keys in the EquateIt app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/coverage/gaps:
    get:
      tags:
        - General
      summary: Coverage Gaps
      description: >-
        Where the org is short on tutors: postcodes with booking demand but too
        few

        IN-PERSON tutors covering them, ranked worst-first.


        Delegates to the get_org_coverage_gaps RPC — the single source of truth
        shared with

        the in-app coverage map. Demand comes from this org's booking requests,
        status-weighted

        in SQL (pending weighs most; declined/expired/matched less) and placed
        by

        `preferred_postcode`. Supply counts IN-PERSON covering tutors only: an
        online

        all-areas tutor "covers" everywhere but cannot physically be in the
        area, so it must

        not mask a geographic gap. Aggregated per postcode (filter by `subject`
        for a single

        subject). Read-only intelligence: it recommends where to recruit, it
        changes nothing.
      operationId: coverage_gaps_v1_coverage_gaps_get
      parameters:
        - name: subject
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Restrict demand + supply to this subject id
            title: Subject
          description: Restrict demand + supply to this subject id
        - name: min_tutors
          in: query
          required: false
          schema:
            type: integer
            maximum: 20
            minimum: 1
            description: A postcode is a gap when fewer than this many tutors cover it
            default: 1
            title: Min Tutors
          description: A postcode is a gap when fewer than this many tutors cover it
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            description: Max gap rows to return (default 50, max 200)
            default: 50
            title: Limit
          description: Max gap rows to return (default 50, max 200)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_CoverageGapItem_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Page_CoverageGapItem_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/CoverageGapItem'
          type: array
          title: Data
        meta:
          $ref: '#/components/schemas/PageMeta'
      type: object
      required:
        - data
        - meta
      title: Page[CoverageGapItem]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CoverageGapItem:
      properties:
        postcode:
          type: string
          title: Postcode
        suburb:
          anyOf:
            - type: string
            - type: 'null'
          title: Suburb
        subject_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Subject Id
        demand_score:
          type: number
          title: Demand Score
          default: 0
        request_count:
          type: integer
          title: Request Count
          default: 0
        supply_count:
          type: integer
          title: Supply Count
          default: 0
      type: object
      required:
        - postcode
      title: CoverageGapItem
      description: >-
        One under-served (postcode, subject) cell from /v1/coverage/gaps: demand

        outweighing covering supply. `demand_score` is the status-weighted
        booking-request

        signal (pending weighs most; declined/expired/matched less);
        `supply_count` is the

        number of distinct tutors who cover this postcode for the subject.
    PageMeta:
      properties:
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
        count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Count
        total:
          anyOf:
            - type: integer
            - type: 'null'
          title: Total
      type: object
      required:
        - limit
        - offset
      title: PageMeta
      description: |-
        Pagination envelope metadata. `count` is the size of the returned page;
        `total` (when present) is the full result-set size for offset paging.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````