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.

Authentifizierung erforderlichExplorer+

List Research Papers

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

GET/v1/papers

Explorer+

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • integerstandard1

    Page number, from 1 to 10,000

    Bereich
    1 – 10000
    Beispiel
  • integerstandard20

    Items per page (max 100)

    Bereich
    1 – 100
    Beispiel
  • string

    Filter by topic

    Max. Länge
    60
    Beispiel

application/json

  • 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

    Author name.

  • string | null

    Author affiliation.

  • string | null

    What the paper is about, as a slug.

  • string | null

    The catalogue data the figures were computed on.

  • string[]

    The documentation Methods pages its figures are computed by, by slug.

  • string[]

    API calls that reproduce its figures.

  • string | null

    The hero picture, as a path on the research site.

  • string | null

    What the hero shows, as alt text.

  • string

    Always published on a public read.

  • string | null

    When it went public.

  • string

    When the record was first added, YYYY-MM-DD HH:MM:SS in UTC.

  • string

    When a field we serve last changed.

  • number

    Current page number

  • number

    Items per page

  • number

    Total matching records (Builder and above)

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

Needs an API key, on every plan including the free one. Only published papers are returned, newest first.

Filter with topic to list the papers on one subject.

Alle Anfragelimits

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.

Authentifizierung erforderlichExplorer+

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+

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • stringerforderlich

    Paper slug

    Akzeptiert
    a lowercase slug: letters, digits and hyphens
    Beispiel

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.

Alle Anfragelimits

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.