nominatim

Documentation

Index

• type Client
  • func New(httpClient *http.Client) Client
• type Location

Types

type Client

type Client interface {
	// Search searches for a location with the given query.
	Search(ctx context.Context, query string) ([]*Location, error)
	// Name provides a client name used to report health check issues.
	Name() string
	// Ping checks the client is healthy.
	Ping(ctx context.Context) error
}

Client is a client for the Nominatim API.

func New

func New(httpClient *http.Client) Client

New creates a new Nominatim API client with the given base URL and HTTP client.

type Location

type Location struct {
	// Lat is the latitude of the location.
	Lat string `json:"lat"`
	// Long is the longitude of the location.
	Long string `json:"lon"`
	// DisplayName is the display name of the location.
	DisplayName string `json:"display_name"`
}

Location represents a geographical location.