---
title: "Run every check and return a single 0 to 100 score"
method: GET
path: "/api/score"
---

# Run every check and return a single 0 to 100 score

`GET /api/score`

## Request

- Base URL: `https://api.shipwork.io`
- URL: `https://api.shipwork.io/api/score`
- Auth: none declared

Runs all checks, then weights findings into one score, a letter grade and a tone of good, warn or bad. Powers the embeddable badge at /badge.svg.

## Query parameters

- `url` string, uri, required

## Response `200`

Score, grade, tone, per-check breakdown and summary counts

- object
  - `score` integer
  - `grade` 'A' | 'B' | 'C' | 'D' | 'F'
  - `tone` 'good' | 'warn' | 'bad'
  - `breakdown` object
  - `summary` object

---

[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)