AarxMaps.Core 1.0.0

AarxMaps

Strongly typed .NET SDK for the Google Maps Platform: Places API (New) and Routes API, with fluent request builders, dependency injection, typed exceptions and optional response caching.

Runs on .NET 10 and later. MIT licensed.

Documentation: aarexus.github.io/AarxMaps

Requirements

• .NET 10 or later. Apps on .NET 8 or 9 can't install the packages until they upgrade.
• A Google Cloud API key with the APIs you use enabled: Places API (New) for AarxMaps.Places, Routes API for AarxMaps.Routes. The legacy Places API is not used.
• Billing enabled on the Google Cloud project. Every call in this SDK is a billed Google request.

Installation

dotnet add package AarxMaps.Places   # pulls in AarxMaps.Core
dotnet add package AarxMaps.Routes   # pulls in AarxMaps.Core

Install AarxMaps.Core on its own only to call Google endpoints directly through IMapsApiClient, without a feature module. See Custom endpoints.

Quick start

Store the API key in user secrets, under the AarxMaps section that AddAarxMaps binds:

dotnet user-secrets init
dotnet user-secrets set "AarxMaps:ApiKey" "YOUR_API_KEY"

ASP.NET Core (Program.cs):

using AarxMaps.Core.Extensions;
using AarxMaps.Core.Models.Geometry;
using AarxMaps.Places.Common.Extensions;
using AarxMaps.Places.Services;
using AarxMaps.Places.Services.Searching;
using AarxMaps.Routes.Common.Extensions;
using AarxMaps.Routes.Common.Models;
using AarxMaps.Routes.Services;
using AarxMaps.Routes.Services.Directions;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddAarxMaps(o =>
    builder.Configuration.GetSection("AarxMaps").Bind(o));
builder.Services.AddAarxMapsPlaces();
builder.Services.AddAarxMapsRoutes();

var app = builder.Build();

app.MapGet("/coffee", async (IPlacesService places, CancellationToken ct) => {
    var request = new TextRequestBuilder()
        .WithTextQuery("coffee in Seattle")
        .WithPageSize(5)
        .Build();

    var result = await places.Search.SearchByTextAsync(request, ct);
    return result.Places.Select(p => new { p.PlaceId, p.DisplayName });
});

app.MapGet("/route", async (IRoutesService routes, CancellationToken ct) => {
    var spaceNeedle = new LatLng(47.6205, -122.3493);

    var request = new RouteRequestBuilder()
        .From(new WaypointBuilder().FromAddress("Pike Place Market").Build())
        .To(new WaypointBuilder().FromLocation(spaceNeedle).Build())
        .WithTravelMode(TravelMode.Drive)
        .Build();

    var result = await routes.Directions.GetRoutesAsync(request, ct: ct);
    var route = result.Routes
        .FirstOrDefault(r => r.Labels.Contains(RouteLabel.DefaultRoute));

    return route is null
        ? Results.NotFound()
        : Results.Ok(new { route.DistanceMeters, route.Duration });
});

app.Run();

For a console app without a host, and the services you can inject, see the Quick start page.

Documentation

• Getting started: Introduction, Installation, Quick start
• Core: Configuration and registration, Caching, Errors, Cancellation and timeouts, Coordinates, Custom endpoints
• Places: Overview, Search areas, Autocomplete, Text search, Nearby search, Place details, Photos and reviews
• Routes: Overview, Waypoints, Directions, Route results, Distance matrix, Option rules by travel mode
• Known limitations
• Coming from DelgadoMaps: every renamed type and member, for users of the D3lg4doMaps.* packages.

License

MIT. See LICENSE.

Not affiliated with or endorsed by Google. Use of Google Maps Platform is subject to Google's terms of service.