---
title: "Whether page and sitemap hreflang declarations agree"
method: GET
path: "/api/check/hreflang-sitemap"
---

# Whether page and sitemap hreflang declarations agree

`GET /api/check/hreflang-sitemap`

## Request

- Base URL: `https://api.shipwork.io`
- URL: `https://api.shipwork.io/api/check/hreflang-sitemap`
- Auth: none declared

## Query parameters

- `url` string, uri, required

## Response `200`

Check result

- object
  - `ok` boolean
  - `tookMs` integer
  - `cached` boolean
  - `findings` object[]
    - `level` 'error' | 'warn' | 'info'
    - `message` string

## Other responses

- `400`: Missing or unsafe url
- `429`: Rate limited

---

[API](https://skmtc.dev/shipwork/apis/shipwork-checks-api.md) · [All operations](https://skmtc.dev/shipwork/apis/shipwork-checks-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shipwork/apis/shipwork-checks-api/revisions/951486ecf68a?raw)