Getting started

github "mapbox/MapboxGeocoder.swift" ~> 0.15

pod'MapboxGeocoder.swift','~> 0.15'

.package(url:"https://github.com/mapbox/MapboxGeocoder.swift.git", from:"0.15.0")

System requirements

Usage

Basics

// main.swiftimport MapboxGeocoderletgeocoder=Geocoder(accessToken:"<#your access token#>")

// main.m@import MapboxGeocoder;MBGeocoder *geocoder = [[MBGeocoderalloc]initWithAccessToken:@"<#your access token#>"];

// main.swiftletgeocoder=Geocoder.shared

// main.mMBGeocoder *geocoder = [MBGeocodersharedGeocoder];

Forward geocoding

// main.swift#if canImport(Contacts)import Contacts#endifletoptions=ForwardGeocodeOptions(query:"200 queen street")// To refine the search, you can set various properties on the options object.options.allowedISOCountryCodes=["CA"]options.focalLocation=CLLocation(latitude:45.3, longitude:-66.1)options.allowedScopes=[.address,.pointOfInterest]lettask= geocoder.geocode(options){(placemarks, attribution, error)inguardlet placemark= placemarks?.firstelse{return}print(placemark.name)        // 200 Queen Stprint(placemark.qualifiedName)        // 200 Queen St, Saint John, New Brunswick E2L 2X1, Canadaletcoordinate= placemark.location.coordinateprint("\(coordinate.latitude),\(coordinate.longitude)")        // 45.270093, -66.050985#if canImport(Contacts)letformatter=CNPostalAddressFormatter()print(formatter.string(from: placemark.postalAddress!))            // 200 Queen St            // Saint John New Brunswick E2L 2X1            // Canada#endif}

// main.m#if !TARGET_OS_TV@import Contacts;#endifMBForwardGeocodeOptions *options = [[MBForwardGeocodeOptionsalloc]initWithQuery:@"200 queen street"];// To refine the search, you can set various properties on the options object.options.allowedISOCountryCodes = @[@"CA"];options.focalLocation = [[CLLocationalloc]initWithLatitude:45.3longitude:-66.1];options.allowedScopes = MBPlacemarkScopeAddress | MBPlacemarkScopePointOfInterest;NSURLSessionDataTask *task = [geocodergeocodeWithOptions:optionscompletionHandler:^(NSArray<MBGeocodedPlacemark *> * _Nullable placemarks,NSString * _Nullable attribution,NSError * _Nullable error) {    MBPlacemark *placemark = placemarks[0];NSLog(@"%@", placemark.name);// 200 Queen StNSLog(@"%@", placemark.qualifiedName);// 200 Queen St, Saint John, New Brunswick E2L 2X1, Canada    CLLocationCoordinate2D coordinate = placemark.location.coordinate;NSLog(@"%f,%f", coordinate.latitude, coordinate.longitude);// 45.270093, -66.050985#if !TARGET_OS_TV    CNPostalAddressFormatter *formatter = [[CNPostalAddressFormatteralloc]init];NSLog(@"%@", [formatterstringFromPostalAddress:placemark.postalAddress]);// 200 Queen St// Saint John New Brunswick E2L 2X1// Canada#endif}];

Reverse geocoding

// main.swiftletoptions=ReverseGeocodeOptions(coordinate:CLLocationCoordinate2D(latitude:40.733, longitude:-73.989))// Or perhaps: ReverseGeocodeOptions(location: locationManager.location)lettask= geocoder.geocode(options){(placemarks, attribution, error)inguardlet placemark= placemarks?.firstelse{return}print(placemark.imageName??"")        // telephoneprint(placemark.genres?.joined(separator:",")??"")        // computer, electronicprint(placemark.administrativeRegion?.name??"")        // New Yorkprint(placemark.administrativeRegion?.code??"")        // US-NYprint(placemark.place?.wikidataItemIdentifier??"")        // Q60}

// main.mMBReverseGeocodeOptions *options = [[MBReverseGeocodeOptionsalloc]initWithCoordinate:CLLocationCoordinate2DMake(40.733, -73.989)];// Or perhaps: [[MBReverseGeocodeOptions alloc] initWithLocation:locationManager.location]NSURLSessionDataTask *task = [geocodergeocodeWithOptions:optionscompletionHandler:^(NSArray<MBGeocodedPlacemark *> * _Nullable placemarks,NSString * _Nullable attribution,NSError * _Nullable error) {    MBPlacemark *placemark = placemarks[0];NSLog(@"%@", placemark.imageName);// telephoneNSLog(@"%@", [placemark.genrescomponentsJoinedByString:@","]);// computer, electronicNSLog(@"%@", placemark.administrativeRegion.name);// New YorkNSLog(@"%@", placemark.administrativeRegion.code);// US-NYNSLog(@"%@", placemark.place.wikidataItemIdentifier);// Q60}];

Batch geocoding

// main.swiftletoptions=ForwardBatchGeocodeOptions(queries:["skyline chili","gold star chili"])options.focalLocation= locationManager.locationoptions.allowedScopes=.pointOfInterestlettask= geocoder.batchGeocode(options){(placemarksByQuery, attributionsByQuery, error)inguardlet placemarksByQuery= placemarksByQueryelse{return}letnearestSkyline=placemarksByQuery[0][0].locationletdistanceToSkyline= nearestSkyline.distance(from: locationManager.location)letnearestGoldStar=placemarksByQuery[1][0].locationletdistanceToGoldStar= nearestGoldStar.distance(from: locationManager.location)letdistance=LengthFormatter().string(fromMeters:min(distanceToSkyline, distanceToGoldStar))print("Found a chili parlor\(distance) away.")}

// main.mMBForwardBatchGeocodeOptions *options = [[MBForwardBatchGeocodeOptionsalloc]initWithQueries:@[@"skyline chili",@"gold star chili"]];options.focalLocation = locationManager.location;options.allowedScopes = MBPlacemarkScopePointOfInterest;NSURLSessionDataTask *task = [geocoderbatchGeocodeWithOptions:optionscompletionHandler:^(NSArray<NSArray<MBGeocodedPlacemark *> *> * _Nullable placemarksByQuery,NSArray<NSString *> * _Nullable attributionsByQuery,NSError * _Nullable error) {if (!placemarksByQuery) {return;    }    MBPlacemark *nearestSkyline = placemarksByQuery[0][0].location;    CLLocationDistance distanceToSkyline = [nearestSkylinedistanceFromLocation:locationManager.location];    MBPlacemark *nearestGoldStar = placemarksByQuery[1][0].location;    CLLocationDistance distanceToGoldStar = [nearestGoldStardistanceFromLocation:locationManager.location];NSString *distance = [NSLengthFormatterstringFromMeters:MIN(distanceToSkyline, distanceToGoldStar)];NSLog(@"Found a chili parlor%@ away.", distance);}];

Tests