Referencia de la API

Endpoints

Cada ruta es un GET bajo https://georgiacivicdata.org/api/v1. Los parámetros de filtro por conjunto de datos se enumeran en cada página de conjunto de datos.

De un vistazo

Endpoint	Propósito
`/datasets`	Lista cada conjunto de datos + dimensión
`/datasets/{main}/{topic}`	Esquema completo de un conjunto de datos (JSON)
`/datasets/{main}/{topic}/contract`	Contrato ODCS sin procesar (YAML/JSON)
`/{main}/{topic}`	Consulta las filas de un conjunto de datos
`/education/_dimensions/{name}`	Lee una dimensión (districts/schools/demographics)
`/education/_dimensions/{name}/schema`	El esquema de una dimensión

Catálogo

GET/api/v1/datasets

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"

Esquema del conjunto de datos

GET/api/v1/datasets/{main_topic}/{topic}

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"

GET/api/v1/datasets/{main_topic}/{topic}/contract

El contrato ODCS v3.1 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 del conjunto de datos

GET/api/v1/{main_topic}/{topic}

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

Parámetro	Descripción
`year`	Año exacto. Excluyente con el rango de abajo.
`year_min` / `year_max`	Rango de años inclusivo.
`detail`	states / districts / schools (lo que publique el conjunto de datos).
`district_code` / `school_code` / `demographic`	Listas de códigos separadas por comas (cuando exista la columna).
parámetros por categoría	Un parámetro por columna categórica (ver la página del conjunto de datos).
`limit` / `offset`	Tamaño de página (predeterminado 1000, máximo 10000) y desplazamiento.
`format`	json (predeterminado) / csv / parquet.

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

Dimensiones

GET/api/v1/education/_dimensions/{name}

Lee una tabla de búsqueda compartida — 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"

GET/api/v1/education/_dimensions/{name}/schema

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