Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

WRLD iOS API Samples

Samples demonstrating how to use the WRLD iOS API to display beautiful, interactive 3D maps on iOS devices.

Getting started



  1. In root of repo, run pod install to setup dependencies using CocoaPods.
  2. open api-samples.xcworkspace to open the generated Xcode workspace.
  3. Place your WRLD API key in the Info.plist file for each example app. See 'Set your WRLD API key' below for details.

You will see two schemes in the project:

  • HelloWorld - this is a minimal app, demonstrating how to drop a WRLDMapView into your app using Interface Builder.
  • ApiSamples - this app contains a collection of samples, each illustrating an individual API feature.

Select the active scheme for the app you want to build in Xcode, then build and run the app.

Set your WRLD API key

In order to run these samples, you need to sign up for a free developer account at Then create an API key to use in your apps.

These example apps read the API key from their Info.plist file. Set the value of the 'WrldApiKey' entry with the API key that you have just created.


If you are creating a new app, or integrating WRLD 3D Maps into an existing app, the API key should be present in the main bundle info dictionary for the key "WrldApiKey" at the time the WRLDMapView is created.

Further information

For more detailed information, see the API documentation and API examples.

We also have step-by-step instructions on how to integrate a WRLD map view into your app.

Questions, comments, or problems? All feedback is welcome - just create an issue.


These samples use the WRLD iOS SDK, available via CocoaPods.

The source for the SDK is available at


These samples are released under the Simplified BSD License. See the file for details.