wiki-openapi

OpenAPI 3.0 specification for the RuneScape Wiki Real-time Grand Exchange Prices API, covering both OSRS (Old School RuneScape) and RS3 (RuneScape 3). The OSRS API is published by the OSRS Wiki in partnership with RuneLite; the RS3 API is published by the RuneScape Wiki.

• Spec: openapi.yaml
• Live docs / playground: https://flipping-utilities.github.io/wiki-openapi/
• Upstream wiki docs:
  • OSRS: https://oldschool.runescape.wiki/w/RuneScape:Real-time_Prices
  • RS3: https://runescape.wiki/w/RuneScape:Real-time_Prices

The docs site is rendered with Scalar, an open-source API reference viewer with a built-in interactive client (the "playground"). Requests sent from the playground are routed through Scalar's public CORS proxy (https://proxy.scalar.com) so that prices.runescape.wiki can be called directly from the browser.

Base URLs

Game	Base URL
OSRS	https://prices.runescape.wiki/api/v2/osrs
RS3	https://prices.runescape.wiki/api/v2/rs

Both games share the same response shapes. RS3 exposes a subset of the OSRS endpoints (no /6h or /24h aggregates).

Endpoints covered

Method	Path	OSRS	RS3	Description
GET	/latest	✓	✓	Latest high/low prices for all items (or a single one).
GET	/mapping	✓	✓	Static item metadata (name, id, examine, alch, limits).
GET	/5m	✓	✓	5-minute average prices and traded volumes.
GET	/1h	✓	✓	1-hour average prices and traded volumes.
GET	/6h	✓		6-hour average prices and traded volumes. (OSRS only)
GET	/24h	✓		24-hour average prices and traded volumes. (OSRS only)
GET	/timeseries	✓	✓	Historical high/low series for a single item.

Using the spec

Point any OpenAPI-compatible tool at the published spec URL:

https://flipping-utilities.github.io/wiki-openapi/openapi.yaml

# Example (OSRS): fetch the latest price for the Abyssal whip (id=4151)
curl -H "User-Agent: my-tool - me@example.com" \
  "https://prices.runescape.wiki/api/v2/osrs/latest?id=4151"

# Example (RS3): fetch the latest price for Chronotes (id=49430)
curl -H "User-Agent: my-tool - me@example.com" \
  "https://prices.runescape.wiki/api/v2/rs/latest?id=49430"

⚠️ Set a descriptive User-Agent header. Default user-agents (python-requests, curl/8.x, Java/17, RestSharp, …) are blocked. See the Acceptable use policy on the wiki.

Local preview

Because Scalar fetches the spec via HTTP, open the site through any static file server rather than file://:

# Python
python -m http.server 8000

# Node
npx serve

Then visit http://localhost:8000/.

Regenerating / validating

npx @redocly/cli lint openapi.yaml
npx @redocly/cli bundle openapi.yaml --output openapi.bundle.yaml

Repository layout

.
├── openapi.yaml    # The OpenAPI 3.0.3 document
├── index.html      # Scalar API Reference shell (loads openapi.yaml)
├── .nojekyll       # Disables Jekyll so GitHub Pages serves the raw yaml
└── README.md

License

MIT. The underlying price data is provided by the OSRS Wiki and the RS3 Wiki — please respect their acceptable use policies.