Skip to content

A C# wrapper for the RuneScape wiki real-time prices of the Grand Exchange.

License

Notifications You must be signed in to change notification settings

MichelMichels/osrs-ge

Repository files navigation

RuneScape Wiki GE C# client

NuGet Version

A C# wrapper for the RuneScape wiki real-time prices of the Grand Exchange.

Intro

This C# libary wraps the REST API of prices.runescape.wiki with an opinionated client. Please read the official documentation for guidance about rate limiting.

Quick start

Note

The default options contain a User-Agent of MichelMichels.RuneScapeWiki/1.0 (+https://github.com/MichelMichels/osrs-ge).

// Put these usings at the top of your file
using MichelMichels.RuneScapeWiki;
using MichelMichels.RuneScapeWiki.Models;

// Setup client
GrandExchangeClient context = new();

// Response
LatestResponse result = await context.GetLatest(CancellationToken.None);

REST calls mapping

This table explains the connection between the REST API call and this library's implementation.

REST C#
/api/v1/latest GetLatest(...)
/api/v1/mapping GetMapping(...)
/api/v1/5m GetFiveMinuteAverage(...)
/api/v1/1h GetOneHourAverage(...)
/api/v1/timeseries GetTimeSeries(...)

Every method supports cancellation through CancellationTokens.

About

A C# wrapper for the RuneScape wiki real-time prices of the Grand Exchange.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages