Getting Started

Getting Started

The Xweather iOS SDK and tvOS is divided into separate libraries so you can only include what's required for your application. The two primary frameworks include:

  • AerisWeatherKit.framework
  • AerisMapKit.framework

If you are using AerisMapKit but using Mapbox or Google Maps SDKs in your application rather than the standard Apple Maps provided in MapKit, you would need to also include one of the following libraries:

  • AerisMapboxMapKit.framework
  • AerisGoogleMapKit.framework

Note that Mapbox and GoogleMap support are not currently available for tvOS.

Start using the Xweather iOS SDK

You'll need an active Xweather Weather API subscription (opens in a new tab) and your application registered with in order to receive the required access ID and secret key.

Create an AerisWeather account

Sign up for an Xweather Flex subscription (opens in a new tab). We offer a free developer account (opens in a new tab) for you to give our weather API a test drive.

Create your API access keys

Log in (opens in a new tab) to your account and find the Apps section to register your application for an API access key. Within the Apps section, click on New Application to register a new app. You will then be prompted to enter a project name and namespace. These can be updated at any time.

Follow our SDK installation and setup guides

Set up your iOS application by following the installation and project setup guides to integrate the SDK into your project.

Review our SDK usage documentation

Review our usage documentation for loading data, creating a weather map or displaying graphs.

Reference the SDK developer documentation

Reference the SDK API documentation for information regarding the classes, methods and properties used throughout the SDK.