0xDocs 0x.limo

Docs / REST API

Catalog

Read the 0x store from your own code — listings, live player counts, popularity, review summaries, achievements, leaderboards, news and store art.

The catalog is public. Every route on this page works without a token. With a token, GET /v1/catalog also says which games the caller owns.

#Listings

GET /v1/catalog returns every listed game ("world") with its store record:

bashtested
curl -s https://api.0x.limo/v1/catalog
json
{
  "schema": 1,
  "apps": [
    {
      "appid": 3100001,
      "name": "OG: Earth",
      "source_verified": false,
      "store": {
        "free": true,
        "listed": true,
        "universe": {
          "id": "outgrid-earth",
          "name": "OG: Earth",
          "tagline": "The vanilla planet. Real terrain, real physics, real chemistry.",
          "developer": "OG",
          "tags": ["Open world", "Digital twin", "Physics"],
          "web": {"hosted": "https://earth.0x.limo/"}
        }
      }
    }
  ]
}
  • appid is the numeric ID that every per-game route takes. store.universe.id is the store's slug, used in store URLs such as https://0x.limo/game/<id>.
  • store.free is true for free games. A paid game has store.price: {amount, currency} in minor units.
  • owned appears only for a signed-in caller. It is always true for a free game.
  • source_verified is true when the game was rebuilt from its published source, the result matched what players download, and a reviewer approved it.
  • store.release: "demo" marks a playable demo of an upcoming game. Launchers list demos apart from released games. It comes from the approved listing version's release.
  • p2p.tracker is the WebTorrent tracker a world's web client announces to, when it has one.

The fields under store.universe are the store page: capsule, screenshots, trailer, details, age rating and so on. They come from the listing you submit at /dev/submit (or 0x submit). A reviewer approves each version.

#Live players

GET /v1/catalog/live lists the plays going on now: plays started or heard from in the last 180 s that haven't ended. Only worlds with players appear. at is a Unix time in milliseconds.

bashtested
curl -s https://api.0x.limo/v1/catalog/live
# {"at": 1792259580679, "apps": {"3100001": {"playing": 3}}}

Cached for 5 s (Cache-Control: public, max-age=5).

#Popularity and freshness

GET /v1/catalog/stats gives each listed app's anonymous play counts and time played over the last 7 days and 24 hours, plus approved_at (when it was first listed) and updated_at (when its live version was approved). The store uses these numbers for its trending and new rows. Cached for 60 s.

bashtested
curl -s https://api.0x.limo/v1/catalog/stats
json
{"at": 1792259580679, "apps": {"3100001": {"plays_7d": 66, "seconds_7d": 46540, "plays_24h": 6, "seconds_24h": 3032, "approved_at": null, "updated_at": null}}}

#Reviews

  • GET /v1/catalog/reviews returns the review summary of every listed world with visible reviews: {at, apps: {"<appid>": {count, positive, percent}}}. Cached for 30 s.
  • GET /v1/apps/{appid}/reviews?sort=recent|helpful&cursor=&limit= returns one world's reviews, newest or most helpful first, paged with next_cursor. With a token, the response also has the caller's own review as mine.
  • Players write reviews with PUT /v1/apps/{appid}/reviews/me {recommend, body?} (accounts only, not guests; one review every 30 s). They vote one helpful with PUT .../reviews/{id}/helpful.
bashtested
curl -s https://api.0x.limo/v1/catalog/reviews

#Store page data

These public routes feed a listed game's store page:

RouteReturns
GET /v1/apps/{appid}/achievementsachievements with display names, icons and the share of players who unlocked each; hidden ones are counted, not shown
GET /v1/apps/{appid}/leaderboardsup to 20 leaderboards, busiest first, each with its top 10 (persona names, no SteamIDs)
GET /v1/apps/{appid}/newsthe developer's news posts, newest first
GET /v1/listings/{id}/art/{version}/{file}capsule and screenshots of an approved version (immutable URLs)
GET /v1/listings/{id}/media/{version}/{file}the trailer (trailer.mp4 / trailer.webm) with byte ranges
GET /v1/news/{post}/{file}a news post's image

The art and media URLs name the approved version, so they are cached forever (Cache-Control: public, max-age=31536000, immutable). A new version gets new URLs.

#Your listings

Developers manage their own listings with a token: an access token or a 0xpub_ publish token.

RouteDoes
GET /v1/listingsyour listings with their latest version, review status and open review issues
POST /v1/listingssubmit a new listing or a new version (it waits for review)
GET /v1/listings/{id}one listing with every version (id is the numeric ID or the slug)
POST /v1/listings/{id}/withdrawwithdraw the version waiting for review
POST /v1/listings/{id}/delisttake the live listing out of the store
PUT /v1/listings/uploads/trailerupload a trailer (MP4 or WebM, at most 60 MB) for the next submission
POST /v1/listings/{id}/newspost news (with optional release notes for a version)
GET /v1/listings/issuesreview issues reviewers opened on your listings, and their threads
bashtested
curl -s https://api.0x.limo/v1/listings -H "Authorization: Bearer $ZEROX_TOKEN"

The submission body (title, tagline, description, tags, age rating, the play target, price, capsule, screenshots, details, trailer and source) is described in the catalog reference.

See also the generated catalog reference.