---
title: "Dataset stats, sources, and links to all collections"
method: GET
path: "/api/v1/index.json"
---

# Dataset stats, sources, and links to all collections

`GET /api/v1/index.json`

## Request

- Base URL: `https://govwait.com`
- URL: `https://govwait.com/api/v1/index.json`
- Auth: none declared

## Response `200`

Index document

- Index
  - `name` string, required
  - `description` string
  - `generated_at` string, required
  - `stats` object
  - `sources` object[]
    - `id` string
    - `name` string
    - `agency` string
    - `jurisdiction` string
    - `url` string, uri
    - `license_note` string
    - `collection_status` 'active' | 'source_unavailable'
    - `collection_status_since` string, date, nullable
    - `collection_status_note` string, nullable
    - `last_successful_verification_at` string, nullable
  - `endpoints` object, required
    - `jurisdictions` string[]
    - `services` string[]
    - `entity_pattern` string
    - `ircc_forward_looking` string
    - `dataset_metadata` string
    - `downloads` string[]
    - `openapi` string
  - `license` string

---

[API](https://skmtc.dev/govwait/apis/govwait-api.md) · [All operations](https://skmtc.dev/govwait/apis/govwait-api/llms.txt) · [OpenAPI document](https://skmtc.dev/govwait/apis/govwait-api/revisions/63e51dffae13?raw)