Introduction
RustMapsApi is a strongly-typed .NET client for the public
RustMaps API (version 4). It wraps the v4 HTTP endpoints behind a single
IRustMapsClient interface, returns a typed
Result<T> from every call, and registers cleanly with
Microsoft.Extensions.DependencyInjection.
What you can do
- Look up maps — by id, by seed & size, or by RustMaps URL.
- Search — with a structured query or a saved homepage filter, paged with a zero-based index.
- Generate maps — request procedural or custom maps, generate from a saved config, or upload a pre-generated save file.
- Read limits & configs — your current generation limits and your saved/default custom-map configurations.
- Render monument icons — resolve a monument's icon (SVG) straight from its
MonumentType, offline, with the companionRustMapsApi.Assetspackage.
Packages
| Package | Description |
|---|---|
RustMapsApi |
The V4 client, Result<T>, models, requests, and DI registration. |
RustMapsApi.Assets |
Monument icon artwork (SVG) mapped by MonumentType — resolve a monument's icon offline. |
Supported runtimes
RustMapsApi targets .NET Standard 2.0 and .NET 10, so it runs on .NET Framework 4.6.2+, .NET 6 through 10, Mono, and Unity.
Next steps
- New here? Head to Getting Started.
- Want the full surface? See the Client guide.
- Need icons? See the Assets guide.
- Prefer to read code? Browse the Samples.