https://github.com/turistikrota/osm

openstreetmap nominatim api for golang
https://github.com/turistikrota/osm

openstreetmap openstreetmap-api

Last synced: about 1 month ago
JSON representation

openstreetmap nominatim api for golang

• Host: GitHub
• URL: https://github.com/turistikrota/osm
• Owner: turistikrota
• License: apache-2.0
• Created: 2024-10-03T18:44:05.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-03T18:48:46.000Z (3 months ago)
• Last Synced: 2024-10-11T12:09:21.730Z (2 months ago)
• Topics: openstreetmap, openstreetmap-api
• Language: Go
• Homepage: https://pkg.go.dev/github.com/turistikrota/osm
• Size: 9.77 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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:

```sh

go get github.com/turistikrota/osm

```

## Usage

### Importing the Package

```go

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:

```go

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

```

or change the default language:

```go

osm.DefaultConfig = osm.Config{

    Locale: "de",

}

```

### Examples

#### Reverse Geocoding

```go

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

```go

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

```go

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

```go

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](LICENSE) file for details.