---
title: "List cited sources"
method: GET
path: "/v1/data/sources"
tags: ["Data Quality"]
---

# List cited sources

`GET /v1/data/sources`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/v1/data/sources`
- Auth: one of:
  - none
  - API key in header `X-API-Key`
  - HTTP bearer

Every site the catalogue cites, strongest first: its kind and place in the source hierarchy, the basis for that kind, and how many records cite it. A maker's own site, a standards body or a government is an `authority`; every other kind a person has classed from the site's own pages is `classified`; the rest are `unclassified` and count as the weakest kind until someone classes them. Classed with the same rules as every record's `provenance.sourceKinds`, so the two never disagree.

No API key required.

## Query parameters

- `page` integer
- `per_page` integer
- `q` string
- `kind` 'manufacturer' | 'standards_body' | 'government' | 'peer_reviewed' | 'reference' | 'aggregator' | 'press' | 'retailer' | 'community' | 'other'
- `tier` 'authority' | 'classified' | 'unclassified'

## Response `200`

List cited sources

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` object[], required: One page of results. Use `pagination` to walk the rest.
    - `host` string, required: The site, without `www.`; an archived copy counts as the site it captured.
    - `kind` 'manufacturer' | 'standards_body' | 'government' | 'peer_reviewed' | 'reference' | 'aggregator' | 'press' | 'retailer' | 'community' | 'other', required: What kind of source it is, in the source hierarchy.
    - `rank` integer, required: The kind's place in the hierarchy: 0 is the strongest (a maker's own page), 8 the weakest (unclassified).
    - `basis` 'declared' | 'maker' | 'rule' | 'unclassified', required: Why it has that kind: classed by a person from the site's own pages, a catalogued maker's own website, a .gov or .mil domain, or not yet classed.
    - `tier` 'authority' | 'classified' | 'unclassified', required: `authority` for a maker's own site, a standards body or a government; `classified` for every other kind a person has classed; `unclassified` otherwise.
    - `citations` integer, required: How many citations in the catalogue point at it.
    - `records` object, required: How many records of each catalog cite it at least once.
    - `makers` string[]: For a maker's own site, the manufacturer ids publishing from it.
    - `evidence` string: What the site said it was when a person classed it, where one did.
  - `pagination` Pagination: Page-size is reported under both `per_page` (matching the request parameter) and `limit` (retained for existing integrations). They always carry the same value. `total` and `totalPages` are omitted for Explorer and anonymous callers.
    - `page` integer, required: The page this response is, 1-based.
    - `per_page` integer, required: Page size. Same value as `limit`.
    - `limit` integer, required: Page size. Alias of `per_page`.
    - `total` integer: Total records matching the query across every page.
    - `totalPages` integer: How many pages the result set spans at the current `per_page`.

## Other responses

- `400`: Validation error
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

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