osm

README

turistikrota osm

The osm package provides functions to interact with the OpenStreetMap API. It includes functionalities for reverse geocoding, retrieving details about specific OSM objects, searching for places, and looking up information based on OSM type and ID.

Installation

To install the package, use:

go get github.com/turistikrota/osm

Usage

Importing the Package

import "github.com/turistikrota/osm"

Methods

• Reverse(ctx context.Context, lat float64, long float64, opts ...optFunc) (*ReverseResult, error)
• Details(ctx context.Context, osmType string, osmID int, opts ...optFunc) (*DetailsResult, error)
• DetailsWithPlaceID(ctx context.Context, placeID int, opts ...optFunc) (*DetailsResult, error)
• Search(ctx context.Context, q string, opts ...optFunc) ([]SearchResult, error)
• Lookup(ctx context.Context, osmType string, osmID int, opts ...optFunc) (*LookupResult, error)

Internationalization

The package supports internationalization. To set the language for the API requests, use the WithLanguage option:

result, err := osm.Reverse(ctx, 40.748817, -73.985428, osm.WithLocale("de"))

or change the default language:

osm.DefaultConfig = osm.Config{
    Locale: "de",
}

Examples

Reverse Geocoding

package main

import (
    "context"
    "fmt"
    "github.com/turistikrota/osm"
)

func main() {
    ctx := context.Background()
    result, err := osm.Reverse(ctx, 40.748817, -73.985428) // Latitude and Longitude for the Empire State Building
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println("Reverse Geocoding Result:", result)
}

Retrieving Details

package main

import (
    "context"
    "fmt"
    "github.com/turistikrota/osm"
)

func main() {
    ctx := context.Background()
    result, err := osm.DetailsWithPlaceID(ctx, 240109189) // PlaceID for the Empire State Building
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println("Details Result:", result)
}

Searching for Places

package main

import (
    "context"
    "fmt"
    "github.com/turistikrota/osm"
)

func main() {
    ctx := context.Background()
    results, err := osm.Search(ctx, "Central Park")
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    for _, result := range results {
        fmt.Println("Search Result:", result)
    }
}

Looking Up Information

package main

import (
    "context"
    "fmt"
    "github.com/turistikrota/osm"
)

func main() {
    ctx := context.Background()
    result, err := osm.Lookup(ctx, "way", 123456789) // Example OSM type and ID
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println("Lookup Result:", result)
}

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Documentation

Overview

Package osm provides functions to interact with the OpenStreetMap API. It includes functionalities for reverse geocoding, retrieving details about specific OSM objects, searching for places, and looking up information based on OSM type and ID.

Index

• Constants
• Variables
• func WithLocale(locale string) optFunc
• func WithUserAgent(userAgent string) optFunc
• type DetailsResult
  • func Details(ctx context.Context, osmType string, osmID int, opts ...optFunc) (*DetailsResult, error)
  • func DetailsWithPlaceID(ctx context.Context, placeID int, opts ...optFunc) (*DetailsResult, error)
• type ErrorResult
  • func (e *ErrorResult) Error() string
• type LookupResult
  • func Lookup(ctx context.Context, osmType string, osmID int, opts ...optFunc) ([]LookupResult, error)
• type Opts
• type ReverseResult
  • func Reverse(ctx context.Context, lat float64, long float64, opts ...optFunc) (*ReverseResult, error)
• type SearchResult
  • func Search(ctx context.Context, q string, opts ...optFunc) ([]SearchResult, error)

Constants

const (
	OsmTypeRelation = "R"
	OsmTypeNode     = "N"
)

Variables

var DefaultOpts = Opts{
	Locale:    "en",
	UserAgent: "Chrome",
}

DefaultOpts provides the default options for requests.

Functions

func WithLocale

func WithLocale(locale string) optFunc

WithLocale returns an optFunc that sets the locale option. locale specifies the language for the response.

func WithUserAgent

func WithUserAgent(userAgent string) optFunc

WithUserAgent returns an optFunc that sets the User-Agent option. userAgent specifies the User-Agent header for the request.

Types

type DetailsResult

type DetailsResult struct {
	PlaceID       int    `json:"place_id"`        // PlaceID is the unique identifier for the place.
	ParentPlaceID int    `json:"parent_place_id"` // ParentPlaceID is the unique identifier for the parent place.
	OsmType       string `json:"osm_type"`        // OsmType is the type of the OpenStreetMap object (e.g., node, way, relation).
	OsmID         int    `json:"osm_id"`          // OsmID is the unique identifier for the OpenStreetMap object.
	Category      string `json:"category"`        // Category is the category of the place.
	Type          string `json:"type"`            // Type is the type of the place.
	AdminLevel    any    `json:"admin_level"`     // AdminLevel is the administrative level of the place.
	Localname     string `json:"localname"`       // Localname is the local name of the place.
	Names         struct {
		Name   string `json:"name"`    // Name is the name of the place.
		NameBe string `json:"name:be"` // NameBe is the name of the place in Belarusian.
		NameDe string `json:"name:de"` // NameDe is the name of the place in German.
		NameEs string `json:"name:es"` // NameEs is the name of the place in Spanish.
		NameHe string `json:"name:he"` // NameHe is the name of the place in Hebrew.
		NameKo string `json:"name:ko"` // NameKo is the name of the place in Korean.
		NameLa string `json:"name:la"` // NameLa is the name of the place in Latin.
		NameRu string `json:"name:ru"` // NameRu is the name of the place in Russian.
		NameUk string `json:"name:uk"` // NameUk is the name of the place in Ukrainian.
		NameZh string `json:"name:zh"` // NameZh is the name of the place in Chinese.
	} `json:"names,omitempty"` // Names contains the names of the place in different languages.
	Addresstags struct {
		Postcode string `json:"postcode"` // Postcode is the postal code of the place.
	} `json:"addresstags,omitempty"` // Addresstags contains address-related tags.
	Housenumber          interface{} `json:"housenumber"` // Housenumber is the house number of the place.
	CalculatedPostcode   string      `json:"calculated_postcode"`
	CountryCode          string      `json:"country_code"`
	IndexedDate          time.Time   `json:"indexed_date"`
	Importance           float64     `json:"importance"`
	CalculatedImportance float64     `json:"calculated_importance"`
	Extratags            struct {
		Wikidata  string `json:"wikidata"`
		Wikipedia string `json:"wikipedia"`
	} `json:"extratags,omitempty"`
	CalculatedWikipedia string `json:"calculated_wikipedia"`
	RankAddress         int    `json:"rank_address"`
	RankSearch          int    `json:"rank_search"`
	Isarea              bool   `json:"isarea"`
	Centroid            struct {
		Type        string    `json:"type"`
		Coordinates []float64 `json:"coordinates"`
	} `json:"centroid"`
	Geometry struct {
		Type        string    `json:"type"`
		Coordinates []float64 `json:"coordinates"`
	} `json:"geometry"`
}

DetailsResult represents the detailed information about a specific OpenStreetMap object.

func Details

func Details(ctx context.Context, osmType string, osmID int, opts ...optFunc) (*DetailsResult, error)

Details retrieves detailed information about a specific OpenStreetMap object. It takes a context, OSM type, OSM ID, and optional functions for additional configurations. It returns a DetailsResult and an error if the request fails.

func DetailsWithPlaceID

func DetailsWithPlaceID(ctx context.Context, placeID int, opts ...optFunc) (*DetailsResult, error)

DetailsWithPlaceID retrieves detailed information about a specific place using its place ID. It takes a context, place ID, and optional functions for additional configurations. It returns a DetailsResult and an error if the request fails.

type ErrorResult

type ErrorResult struct {
	Details struct {
		Code    int    `json:"code"`
		Message string `json:"message"`
	} `json:"error"`
}

func (*ErrorResult) Error

func (e *ErrorResult) Error() string

type LookupResult

type LookupResult struct {
	PlaceID     int      `json:"place_id"`
	Licence     string   `json:"licence"`
	OsmType     string   `json:"osm_type"`
	OsmID       int      `json:"osm_id"`
	Boundingbox []string `json:"boundingbox"`
	Lat         string   `json:"lat"`
	Lon         string   `json:"lon"`
	DisplayName string   `json:"display_name"`
	Class       string   `json:"class"`
	Type        string   `json:"type"`
	Importance  float64  `json:"importance"`
	Address     struct {
		Tourism     string `json:"tourism"`
		Road        string `json:"road"`
		Suburb      string `json:"suburb"`
		City        string `json:"city"`
		State       string `json:"state"`
		Postcode    string `json:"postcode"`
		Country     string `json:"country"`
		CountryCode string `json:"country_code"`
	} `json:"address"`
	Extratags struct {
		Image              string `json:"image"`
		Heritage           string `json:"heritage"`
		Wikidata           string `json:"wikidata"`
		Architect          string `json:"architect"`
		Wikipedia          string `json:"wikipedia"`
		Wheelchair         string `json:"wheelchair"`
		Description        string `json:"description"`
		HeritageWebsite    string `json:"heritage:website"`
		HeritageOperator   string `json:"heritage:operator"`
		ArchitectWikidata  string `json:"architect:wikidata"`
		YearOfConstruction string `json:"year_of_construction"`
	} `json:"extratags"`
}

func Lookup

func Lookup(ctx context.Context, osmType string, osmID int, opts ...optFunc) ([]LookupResult, error)

Lookup retrieves information about a specific OpenStreetMap object using its type and ID. It takes a context, OSM type, OSM ID, and optional functions for additional configurations. It returns a LookupResult and an error if the request fails.

type Opts

type Opts struct {
	Locale    string // Locale specifies the language for the response.
	UserAgent string // UserAgent specifies the User-Agent header for the request.
}

Opts holds configuration options for requests.

type ReverseResult

type ReverseResult struct {
	PlaceID     int     `json:"place_id"`     // PlaceID is the unique identifier for the place.
	Licence     string  `json:"licence"`      // Licence is the licence information for the data.
	OsmType     string  `json:"osm_type"`     // OsmType is the type of the OpenStreetMap object (e.g., node, way, relation).
	OsmID       int     `json:"osm_id"`       // OsmID is the unique identifier for the OpenStreetMap object.
	Lat         string  `json:"lat"`          // Lat is the latitude of the place.
	Lon         string  `json:"lon"`          // Lon is the longitude of the place.
	Class       string  `json:"class"`        // Class is the classification of the place (e.g., place, highway).
	Type        string  `json:"type"`         // Type is the type of the place (e.g., city, street).
	PlaceRank   int     `json:"place_rank"`   // PlaceRank is the rank of the place.
	Importance  float64 `json:"importance"`   // Importance is the importance score of the place.
	Addresstype string  `json:"addresstype"`  // Addresstype is the type of address.
	Name        string  `json:"name"`         // Name is the name of the place.
	DisplayName string  `json:"display_name"` // DisplayName is the human-readable name of the place.
	Address     struct {
		Amenity       string `json:"amenity"`                  // Amenity is the amenity at the place.
		HouseNumber   string `json:"house_number"`             // HouseNumber is the house number of the place.
		Road          string `json:"road"`                     // Road is the road of the place.
		Quarter       string `json:"quarter"`                  // Quarter is the quarter of the place.
		Neighbourhood string `json:"neighbourhood"`            // Neighbourhood is the neighbourhood of the place.
		Suburb        string `json:"suburb"`                   // Suburb is the suburb of the place.
		County        string `json:"county"`                   // County is the county of the place.
		City          string `json:"city"`                     // City is the city of the place.
		State         string `json:"state"`                    // State is the state of the place.
		ISO31662Lvl4  string `json:"ISO3166-2-lvl4"`           // ISO31662Lvl4 is the ISO 3166-2 level 4 code of the place.
		Postcode      string `json:"postcode"`                 // Postcode is the postal code of the place.
		Country       string `json:"country"`                  // Country is the country of the place.
		CountryCode   string `json:"country_code"`             // CountryCode is the country code of the place.
		Town          string `json:"town"`                     // Town is the town of the place.
		Province      string `json:"province"`                 // Province is the province of the place.
		Region        string `json:"region"`                   // Region is the region of the place.
		StateDistrict string `json:"state_district,omitempty"` // Village is the state district of the place.
		Leisure       string `json:"leisure,omitempty"`        // Leisure is the leisure activity at the place.
		Residential   string `json:"residential,omitempty"`    // Residential is the residential area of the place.
	} `json:"address"` // Address contains detailed address information.
	Boundingbox []string `json:"boundingbox"` // Boundingbox is the bounding box of the place.
}

ReverseResult represents the result of a reverse geocoding request.

func Reverse

func Reverse(ctx context.Context, lat float64, long float64, opts ...optFunc) (*ReverseResult, error)

Reverse performs a reverse geocoding request to convert latitude and longitude into a human-readable address. It takes a context, latitude, longitude, and optional functions for additional configurations. It returns a ReverseResult and an error if the request fails.

type SearchResult

type SearchResult struct {
	Address struct {
		ISO31662Lvl4  string `json:"ISO3166-2-lvl4"`
		Borough       string `json:"borough"`
		City          string `json:"city"`
		Country       string `json:"country"`
		CountryCode   string `json:"country_code"`
		Historic      string `json:"historic"`
		HouseNumber   string `json:"house_number"`
		Neighbourhood string `json:"neighbourhood"`
		Postcode      string `json:"postcode"`
		Road          string `json:"road"`
		Suburb        string `json:"suburb"`
	} `json:"address"`
	Boundingbox []string `json:"boundingbox"`
	Class       string   `json:"class"`
	DisplayName string   `json:"display_name"`
	Importance  float64  `json:"importance"`
	Lat         string   `json:"lat"`
	Licence     string   `json:"licence"`
	Lon         string   `json:"lon"`
	OsmID       int      `json:"osm_id"`
	OsmType     string   `json:"osm_type"`
	PlaceID     int      `json:"place_id"`
	Svg         string   `json:"svg"`
	Type        string   `json:"type"`
}

func Search

func Search(ctx context.Context, q string, opts ...optFunc) ([]SearchResult, error)

Search performs a search query to find places matching the given query string. It takes a context, query string, and optional functions for additional configurations. It returns a slice of SearchResult and an error if the request fails.