Endpoints
Visión general
La API REST de GovClipping ofrece múltiples endpoints que permiten a los usuarios buscar y recuperar documentos estructurados, como artículos y subvenciones, filtrados por tipo de documento, país, región, categoría y fecha.
A continuación, se describen los endpoints disponibles, sus parámetros y ejemplos de uso.
Notas importantes
- Los parámetros opcionales pueden omitirse si no son necesarios.
-
Si los parámetros opcionales de fechas
published_date_fromypublished_date_endno han sido informados, los valores por defecto serán:published_date_from: fecha actual menos 29 días.published_date_end: fecha actual.
- Usa
searchpara búsquedas complejas que combinen múltiples filtros. - La respuesta limita a 50 documentos por página.
- Los documentos están ordenados por fecha de publicación descendente.
- Usa el párametro
pagepara paginar los resultados.
Tabla Resumen de Endpoints
| Método HTTP | Endpoint | Descripción |
|---|---|---|
GET |
/api/v1/{document_type}/search |
Buscador avanzado de documentos usando filtros. |
GET |
/api/v1/{document_type}/{country} |
Filtra documentos por país. |
GET |
/api/v1/{document_type}/{country}/{region} |
Filtra documentos por país y administración pública (Ministerio, Comunidad Autónoma, organismo, ...). |
GET |
/api/v1/{document_type}/{country}/{region}/{category} |
Filtra documentos por país, administración pública y categoría (Notas de prensa, Acuerdo de gobierno, boletín oficial, agenda, participación ciudadana, ...). |
GET |
/api/v1/{document_type}/{country}/{region}/{date} |
Filtra documentos por país, administración pública, categoría y fecha de publicación. |
Nota: Puedes consultar el tipo de dato Parametros GET (Enums)
Endpoint de búsqueda avanzada
Permite buscar artículos o subvenciones basados en palabras clave y diversos filtros.
- Método HTTP:
GET - Ruta:
/api/v1/{document_type}/search - Parámetros de Ruta
{document_type}:- Los valores posibles para
{document_type}son:articlesosubsidies. Más información en Enum Type Document_type.
- Los valores posibles para
- Parámetros de Consulta (Query Params):
keywords_mandatory(opcional): los resultados deben contener obligatoriamente todas estas palabras clave (operador AND), separadas por punto y coma;.keywords_optional(opcional): los resultados contienen al menos una de estas palabras clave (operador OR), separadas por punto y coma;.keywords_excluded(opcional): los resultados NO deben contener ninguna de estas palabras clave, separadas por punto y coma;.countries(Enum type Country, opcional): Código de país (ISO 3166-1 alpha-2) separados por punto y coma;. Por defecto siempre será España (código:es).regions(Enum type Region, opcional): Lista de Administraciones Públicas separadas por punto y coma;(desde Ministerios hasta Comunidades Autónomas y Organismos/Entidades Públicas). Por defecto siempre seran todos (i.e.all).categories(Enum type Category, opcional): Lista de categorías de documentos separadas por punto y coma;(e.g., all, press_release, gov_agreements, citizen_participation, ...). Por defecto siempre seran todos (i.e.all).published_date_from(opcional): Fecha de inicio del rango de los documentos a buscar (formato: YYYY-MM-DD). Por defecto siempre será el día de hoy -29 días (i.e.2024-12-27).published_date_end(opcional): Fecha de fin del rango de los documentos a buscar (formato: YYYY-MM-DD). Por defecto siempre será el día de hoy (i.e.2025-01-25).page(opcional): Número de página de resultados a devolver. Los documentos se devuelven de 50 en 50 y ordenados por fecha de publicación descendente. Por defecto siempre será la primera página (i.e.1).
Buscador avanzado - Ejemplo de petición
Endpoint de Documentos
Permite obtener documentos filtrados por tipo de documento, país, administración pública (= region), categoría o fecha. Este tipo de petición permite obtener todos los artículos publicados en un rango de fechas determinado.
No permite buscar por palabras clave.
- Método HTTP:
GET - Ruta:
/api/v1/{document_type}/{country}/{region}/{category}/{date} - Parámetros de Ruta:
{document_type}(obligatorio):articlesosubsidies. Más información en Tipos de documento.{country}(opcional): Código de país (ISO 3166-1 alpha-2). Por defecto siempre será España (código:es).{region}(opcional): Región específica dentro del país.{category}(opcional): Categoría del documento (e.g., press_release, news).{date}(opcional): Fecha de publicación de los documentos a devolver (formato: YYYY-MM-DD). Por defecto, se devuelven los documentos publicados en la fecha actual y hasta 29 días antes.
- Parámetros de Consulta (Query Params):
page(opcional): Número de página de resultados a devolver. Los documentos se devuelven de 50 en 50 y ordenados por fecha de publicación descendente. Por defecto siempre será la primera página (i.e.1).- Esta petición no soporta otros parámetros de consulta.