GunSpec

Papers

Technical reports GunSpec publishes on the catalogue: each with its named authors, what review it has had, the methods its figures are computed by and the API requests that reproduce them. Both reads need an API key, on every plan including the free one, and return only published papers. The Papers tab explains what a paper is, how one is made and how to reproduce and cite it.

Auth RequiredExplorer+

Get Research Paper

Returns one published research paper, including its full body, its authors, its review status and the API calls that reproduce its figures.

GET/v1/papers/{slug}

Explorer+

  • stringheaderrequired

    Your API key. Authorization: Bearer <key> is accepted in its place.

  • stringrequired

    Paper slug

    Accepts
    a lowercase slug: letters, digits and hyphens
    Example

application/json

  • object

    The paper, wrapped as the blog read wraps a post.

  • object

    A research paper as the public reads serve it.

  • string

    Paper id.

  • string

    URL segment of the paper on the research site.

  • string

    Paper title.

  • string | null

    The abstract, as plain text.

  • string | null

    The paper in markdown. A gunspec-chart fence names a chart by the catalogue data it draws.

  • string[]

    The findings, one sentence each, for a reader with a minute.

  • string

    What kind of document it is.

  • string

    What the research has been through. Publication on the research site is not a review; peer_reviewed means a venue accepted it.

  • string | null

    Where it was submitted or published, when it was.

  • string | null

    Its DOI as registered, never a URL.

  • object[]

    Named authors, in order.

  • string | null

    What the paper is about, as a slug.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 404NOT_FOUNDResource not found
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Needs an API key, on every plan including the free one. A slug that is unknown, a draft or a paper scheduled for later answers 404.

apiCalls lists the requests that reproduce the paper's figures. Send them with your own key; some need a paid plan.

reviewStatus says what review the paper has had. Publishing a paper is not a review.

Full rate limits

Minimum tier
Explorer+
Monthly quota
200/mo
Rate limit
10/min
Daily cap
50

Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.