Georgia Civic Data Discovery API

openapi: 3.2.0
info:
  title: Georgia Civic Data Discovery API
  description: 'Read-only REST API serving cleaned, standardized tabular data for the state of Georgia: **education**, **census**, **health** and **immigration**, driven entirely by git-tracked ODCS data contracts — so every dataset''s columns, units, ranges, and allowed values are stable and documented.


    **Base path:** all data routes live under `/api/v1`. Every dataset is addressed by its bare name (names are unique), e.g. `act_scores`.


    **Discover, don''t hard-code.** `GET /api/v1/datasets` lists every dataset (compact; `?fields=full` for everything); `GET /api/v1/search?q=` finds one by meaning; `GET /api/v1/datasets/{name}` returns its schema (columns, units, the exact filter parameters with their allowed values, and a runnable `recommended_query` URL); `GET /api/v1/datasets/{name}/rows` returns the data.


    **Note on filters:** every categorical column of a dataset is its own filter parameter, so the filters differ per dataset and are listed in the dataset''s schema (`filters`), not in this generic document. `GET /api/v1/datasets/{name}/openapi.json` is a per-dataset OpenAPI document with every filter and its allowed values, for function-calling clients that need one. Human docs: https://georgiacivicdata.org/api; agent reference: https://georgiacivicdata.org/llms-full.txt.


    **R and Python packages:** `georgiacivicdata` on CRAN and PyPI wraps this API and returns data frames. Docs: https://georgiacivicdata.org/r/ and https://georgiacivicdata.org/py/ (overview: https://georgiacivicdata.org/packages).


    **License:** data and documentation are licensed CC BY 4.0. Credit "Georgia Civic Data (georgiacivicdata.org)" and the original source. The license covers our cleaning, standardization, compilation, and documentation; source data stays under its original publisher''s terms (each dataset names its source). Every response carries a `Link: ; rel="license"` header, and `GET /api/v1/datasets` returns the terms as a `license` object. Details: https://georgiacivicdata.org/about#license.'
  contact:
    name: Georgia Civic Data
    url: https://georgiacivicdata.org/api
    email: shane@georgiacivicdata.org
  license:
    name: Creative Commons Attribution 4.0 International (CC BY 4.0)
    url: https://creativecommons.org/licenses/by/4.0/
  version: 0.2.0
servers:
- url: https://georgiacivicdata.org
  description: Production (brand domain, same-origin proxy)
- url: https://georgia-civic-data-production.up.railway.app
  description: Production (origin)
tags:
- name: Discovery
  description: Search the catalog, and resolve a place or group name to the code the data uses.
paths:
  /api/v1/search:
    get:
      tags:
      - Discovery
      summary: Find datasets by meaning and keywords
      description: 'Hybrid search over the catalog: keywords (titles, everyday English and Spanish aliases, descriptions, column labels) and meaning (embeddings), merged. Returns matching datasets (with `confidence`: low means nothing may fit) and matching lookup tables. Optional `main_topic`, `level` and `year` keep only datasets that have them. The query text is sent to Voyage AI to be embedded and is never logged; without that service the search falls back to keywords and says so (`retrieval.mode`).'
      operationId: search_api_v1_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          description: What to look for
          title: Q
        description: What to look for
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 20
          title: Limit
      - name: main_topic
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Main Topic
      - name: level
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Level
      - name: year
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Year
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/resolve:
    get:
      tags:
      - Discovery
      summary: Turn a place or group name into the code the data uses
      description: '`kind` = district, school, county or demographic; `q` = a name or a code (''Fulton'', ''Atlanta Public Schools'', ''Midtown High School'', ''hispanic''). Returns ranked candidates with their codes (`district_code`, `school_code` with its `district_code`, `county_fips`, `demographic`) and flags ambiguity, so a query filters on a real code instead of a guess.'
      operationId: resolve_api_v1_resolve_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          title: Q
      - name: kind
        in: query
        required: true
        schema:
          type: string
          description: district, school, county or demographic
          title: Kind
        description: district, school, county or demographic
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 10
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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