Data API Documentation

    Access Caribbean education datasets programmatically via our RESTful API.

    Overview

    The Edu-Search Caribbean Data API provides programmatic access to our collection of educational datasets. All endpoints return JSON responses and support CORS for browser-based applications.

    Base URL

    https://demo.edusearchcaribbean.com/api/public/datasets

    Authentication

    Currently, all API endpoints are publicly accessible and do not require authentication. Rate limiting may apply to prevent abuse.

    No API Key Required

    Endpoints

    GET
    /

    Description

    Retrieve a list of all publicly available datasets with pagination support.

    Query Parameters

    limitNumber of results (default: 50, max: 100)
    offsetStarting position (default: 0)
    countryFilter by country name
    dataset_typeFilter by type (microdata, indicators, aggregated)
    access_typeFilter by access (open, restricted, licensed)

    Example Request

    curl "https://demo.edusearchcaribbean.com/api/public/datasets?limit=10&country=Jamaica"

    Example Response

    {
      "datasets": [
        {
          "id": "uuid",
          "title": "Caribbean Education Indicators 2023",
          "slug": "education-indicators-2023",
          "type": "dataset",
          "abstract": "...",
          "publication_date": "2023-12-01",
          "datasets": {
            "dataset_type": "indicators",
            "access_type": "open",
            "api_enabled": true
          }
        }
      ],
      "count": 15,
      "limit": 10,
      "offset": 0
    }

    Response Codes

    200Success
    404Resource not found
    403Access forbidden (API not enabled for dataset)
    500Internal server error

    Support

    For questions about the API or to request additional features, please contact us at api@edusearchcaribbean.com