API Reference

Public endpoint documentation for VaporLens.

License and usage conditions

You may use the APIs documented here, including the JSON endpoint and Markdown export, only for non-commercial purposes with attribution to VaporLens. VaporLens analysis returned by these endpoints is licensed under the Creative Commons Attribution-NonCommercial 4.0 International license (CC BY-NC 4.0).

Credit VaporLens, link to the source game page and the license, and indicate if you modified the analysis. Attribution must not imply endorsement by VaporLens.
Commercial API use or commercial reuse of the analysis requires separate permission from VaporLens.
Third-party content remains subject to its respective rights and is not covered by this license.

GET/api/app/$idPublic

Returns summarized review analysis for a Steam app.

Path Param

id

Type

string

Description

Steam app id

Example request

curl https://vaporlens.app/api/app/730

Example response

{
  "name": "Example Game",
  "lastUpdated": "2026-04-04T00:00:00.000Z",
  "categories": ["RPG", "Singleplayer"],
  "summary": [
    "Tight combat loop with strong build variety.",
    "Performance is stable on most modern GPUs."
  ],
  "positives": [
    {
      "point": "Combat depth",
      "explanation": "Players praise build choices and pacing.",
      "importance": 0.81
    }
  ],
  "negatives": [],
  "gameplay": [],
  "performance": [],
  "recommendations": [],
  "misc": [],
  "emotions": [
    {
      "point": "satisfaction",
      "explanation": "Players report consistent enjoyment.",
      "importance": 0.62
    }
  ],
  "hardware": {
    "summary": "High-end PC reports are mostly positive overall, while enthusiast pc reports mixed performance.",
    "sampleSize": 214,
    "coveragePct": 34,
    "audienceSkew": "Review sample is heavily weighted toward high-end Windows PCs.",
    "segments": [
      {
        "label": "High-end PC",
        "count": 42,
        "outcome": "positive",
        "note": "Most reports mention stability and high fps."
      },
      {
        "label": "Enthusiast PC",
        "count": 27,
        "outcome": "mixed",
        "note": "Reports split between high fps and complaints about stutter."
      }
    ],
    "caveats": [
      "214 of 626 reviews expose hardware metadata.",
      "Review sample is heavily weighted toward high-end Windows PCs."
    ]
  },
  "featureScans": {
    "reviewMix": {
      "score": 28,
      "verdict": "Mostly positive",
      "summary": "Positive 72% · Negative 28%."
    },
    "mtxScan": { "score": 18, "summary": "Low monetization pressure." },
    "modScan": {
      "score": 21,
      "summary": "Mods are helpful but not required.",
      "verdict": "Optional"
    },
    "wikiScan": { "score": 22, "summary": "Some optional guide usage." },
    "protonLinuxScan": {
      "score": 36,
      "summary": "Mostly works on Proton, but some users mention minor launch tweaks."
    },
    "steamDeckScan": { "score": 14, "summary": "Mostly smooth on Deck." }
  },
  "featureExtractions": {
    "priceExtraction": { ... },
    "playtimeExtraction": { ... },
    "timeToFunExtraction": { ... },
    "playerArchetypesExtraction": { ... }
  },
  "similar": [1145360, 588650, 268910]
}

Notes

CORS is enabled with Access-Control-Allow-Origin: *.
Non-existent apps return 404 with an error object.
lastUpdated is the ISO timestamp for the latest processed VaporLens snapshot used to build the response.
similar lists the Steam app ids of up to 12 analyzed games closest to this one, most similar first.

GET/app/$id/$gameName.mdPublic

Returns markdown-formatted game analysis text.

Path Params

id, gameName

Content Type

text/markdown

Description

Markdown export

Example request

curl https://vaporlens.app/app/1808500/arc_raiders.md

Example response

Info about Example Game:

Official game description:
Fast-paced extraction shooter with high-stakes runs and squad play.

Release date: Coming soon

Categories: Action, Multiplayer

Feature scans:
- MTX: score 18; verdict: Low pressure; summary: Monetization concerns are limited.
- Mods: score 21; verdict: Optional; summary: Mods are helpful but not required.
- Wiki: score 22; verdict: Optional; summary: Some players reference guides, but not required.
- Proton/Linux: score 36; verdict: Minor Tweaks; summary: Most Linux users get in with small setup adjustments.
- Steam Deck: score 14; verdict: Runs Great; summary: Most feedback reports smooth handheld performance.

- Hardware Profile:
  - Summary: High-end PC reports are mostly positive overall, while enthusiast pc reports mixed performance.
  - Sample size: 214 (34% coverage)
  - Audience skew: Review sample is heavily weighted toward high-end Windows PCs.
  - High-end PC (positive, 42 reports): Most reports mention stability and high fps.
  - Enthusiast PC (mixed, 27 reports): Reports split between high fps and complaints about stutter.

Feature extractions:
- Community Price: ...
- Playtime Metrics: ...
- Time-to-fun: ...
- Player Archetypes: ...

Below are summaries of things people say about the game per category.
Each point is assigned a weight that represents how often it is mentioned across all reviews.
What players like:
- Tight gunplay (weight 0.81): Weapon handling feels responsive.

Notes

Returns 404 markdown when game data is unavailable.
Uses latest processed snapshot for the specified app id.