Endpoints

Un resumen por conjunto de datos (título, fuente, rango de años, niveles de detalle, endpoint) más un bloque dimensions. Sin parámetros.

curl "https://georgiacivicdata.org/api/v1/datasets"

El esquema completo: cada columna (nombre, tipo, rol, unidad, rango, valores permitidos, descripción), la lista estructurada de filters, las claves foráneas, el puntero key_metric, los años disponibles y el schema_hash. Esto es lo que impulsa esta documentación.

curl "https://georgiacivicdata.org/api/v1/datasets/education/act_scores"

El contrato ODCS v3.2 autoritativo. ?format=yaml (predeterminado) lo devuelve textualmente; ?format=json lo devuelve analizado.

curl "https://georgiacivicdata.org/api/v1/datasets/education/act_scores/contract?format=yaml"

Consulta las filas de un conjunto de datos. Parámetros comunes:

curl "https://georgiacivicdata.org/api/v1/education/act_scores?year=2024&test_component=composite&detail=districts"

Lee una tabla de búsqueda del ámbito educativo — districts, schools o demographics — paginada con limit / offset. Estas aportan las columnas de etiqueta que las consultas de hechos unen.

curl "https://georgiacivicdata.org/api/v1/education/_dimensions/districts?limit=10"

Lee una tabla de búsqueda global — counties (los 159 condados de Georgia, código FIPS + nombre) o demographics. La ruta educativa de arriba se mantiene para districts, schools y demographics.

curl "https://georgiacivicdata.org/api/v1/_dimensions/counties?limit=10"

La clave primaria, los atributos y las claves de enlace de una dimensión.

Polígonos de las zonas, uno por escuela, nivel y rango de grados. Parámetros:

Las propiedades de cada zona incluyen las etiquetas de la escuela y del distrito, nces_school_id, nces_lea_id y su procedencia: method, accuracy_class, positional_rmse_m, boundary_vintage, currency_status, currency_note (qué cambió y cuándo, para una zona cuya fuente es anterior a un cambio aprobado), source_url, source_publisher y retrieved_on. Todos los formatos llevan la nota de que una zona no es una determinación oficial de inscripción: un note de nivel superior en GeoJSON y json, un README.txt en el zip del shapefile y los metadatos del archivo GeoParquet.

curl "https://georgiacivicdata.org/api/v1/education/school_attendance_zones?district_code=761&zone_level=high"

Cada campo con su tipo y descripción, el significado de cada valor enumerado, el sistema de referencia de coordenadas (OGC:CRS84: longitud, latitud), la correspondencia de cada campo con su nombre de campo de shapefile de 10 caracteres y los archivos complementarios, con las columnas de la tabla de cobertura. Un campo de texto de shapefile admite como máximo 254 bytes, así que un valor más largo (un boundary_vintage o un source_url largos) se corta ahí y termina en ...; los demás formatos llevan el texto completo, y currency_note siempre cabe.

Una fila por distrito escolar de Georgia: su estado (complete, partial, one_school_per_grade o not_available), el estado de cada nivel (zoned, one_school_per_grade, partial, not_available o served_by_other_district), la proporción de su superficie y de su población de 2020 que cubren las zonas, y por qué falta algo. format=json (predeterminado) o geojson (con los contornos de los distritos).

Indica lat y lon, o tract_geoid, más un grade y un year opcionales.

Cada respuesta incluye una nota de que no es una determinación oficial de inscripción, y se envía con Cache-Control: no-store. Un GET pone las coordenadas en la URL, que pasa por nuestra plataforma de alojamiento; nuestra aplicación nunca las escribe en sus registros. Para mantener un punto fuera de las URL, envíalo por POST.

curl "https://georgiacivicdata.org/api/v1/education/school_attendance_zones/lookup?lat=33.7479&lon=-84.3903&grade=09"

Un cuerpo JSON con exactamente una de las siguientes opciones, más un grade y un year opcionales:

Las direcciones solo se aceptan por POST, así que nunca aparecen en una URL. Nuestra aplicación nunca escribe direcciones ni coordenadas en sus registros de aplicación, ni las guarda en caché ni las conserva. POST también es la forma privada de enviar un punto. Las respuestas se envían con Cache-Control: no-store. Límites de frecuencia por cliente: 120 solicitudes por minuto para las consultas GET y 20 por minuto para POST.

curl -X POST "https://georgiacivicdata.org/api/v1/education/school_attendance_zones/lookup" \
  -H "Content-Type: application/json" \
  -d '{"address": "55 Trinity Ave SW, Atlanta, GA 30303"}'

Límites de los distritos escolares de Georgia de Census TIGER/Line, identificados por district_code. Filtra con district_code; las mismas opciones de format que las zonas.