---
title: "Get all groundhogs"
method: GET
path: "/api/v1/groundhogs"
tags: ["groundhogs"]
---

# Get all groundhogs

`GET /api/v1/groundhogs`

Returns all prognosticating animals with their known predictions.

## Query parameters

- `country` string
- `isGroundhog` '1' | '0' | 'true' | 'false'

## Response `200`

OK

- object
  - `groundhogs` Groundhog[]
    - `id` integer, required
    - `slug` string, required
    - `shortname` string, required
    - `name` string, required
    - `city` string, required
    - `region` string, required
    - `country` string, required
    - `coordinates` string, required
    - `source` string, required
    - `contact` string, required
    - `currentPrediction` string, required
    - `isGroundhog` integer, required
    - `type` string, required
    - `active` 0 | 1, required
    - `description` string, required
    - `image` string, required
    - `predictions` Prediction[]
      - `year` integer, required
      - `shadow` integer, nullable, required
      - `details` string, required
      - `groundhog` Groundhog — recursive
    - `predictionsCount` integer — All predictions, excluding nulls.

---

[API](https://skmtc.dev/swaggerhub/apis/groundhog-day-api.md) · [All operations](https://skmtc.dev/swaggerhub/apis/groundhog-day-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/swaggerhub/groundhog-day-api/revisions/323f97be2b21/schema)