---
title: "List research papers"
method: GET
path: "/v1/papers"
tags: ["Papers"]
---

# List research papers

`GET /v1/papers`

## Request

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

Returns the research papers GunSpec has published, newest first: technical reports built on the catalogue and the published methods.

Available on every plan. Requires an API key; Explorer keys receive a reduced field set.

## Query parameters

- `page` integer
- `per_page` integer
- `topic` string

## Response `200`

List research papers

- 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.
    - `id` string: Paper id.
    - `slug` string: URL segment of the paper on the research site.
    - `title` string: Paper title.
    - `abstract` string, nullable: The abstract, as plain text.
    - `body` string, nullable: The paper in markdown. A `gunspec-chart` fence names a chart by the catalogue data it draws.
    - `keyFindings` string[]: The findings, one sentence each, for a reader with a minute.
    - `reportType` 'technical_report' | 'technical_note' | 'preprint' | 'white_paper': What kind of document it is.
    - `reviewStatus` 'not_reviewed' | 'submitted' | 'under_review' | 'peer_reviewed': What the research has been through. Publication on the research site is not a review; `peer_reviewed` means a venue accepted it.
    - `venue` string, nullable: Where it was submitted or published, when it was.
    - `doi` string, nullable: Its DOI as registered, never a URL.
    - `authors` object[]: Named authors, in order.
      - `name` string: Author name.
      - `affiliation` string, nullable: Author affiliation.
    - `topic` string, nullable: What the paper is about, as a slug.
    - `dataVersion` string, nullable: The catalogue data the figures were computed on.
    - `methods` string[]: The documentation Methods pages its figures are computed by, by slug.
    - `apiCalls` string[]: API calls that reproduce its figures.
    - `heroImage` string, nullable: The hero picture, as a path on the research site.
    - `heroAlt` string, nullable: What the hero shows, as alt text.
    - `status` string: Always `published` on a public read.
    - `publishedAt` string, nullable: When it went public.
    - `createdAt` string: When the record was first added, `YYYY-MM-DD HH:MM:SS` in UTC.
    - `updatedAt` string: When a field we serve last changed.
  - `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
- `401`: Missing or invalid API key
- `403`: The credential is valid and the caller is not permitted. Three causes, none of which reissuing a key changes: the plan is below the endpoint's tier, the account is suspended, or the key is not attached to the thing being acted on, meaning a user account for `/v1/me` or a shop for `/v1/vendor`. Distinct from 401, which means the credential is missing, malformed or expired and a new one can work.
- `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)