# iOS

The HyprMX SDK is designed to present rewarded, interstitial, and banner/MREC ads in your application. To integrate the SDK, follow the steps below.

{% hint style="info" %}
[Apple Privacy Manifest](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files) is included in iOS SDK 6.3.0.1+
{% endhint %}

## SDK Integration <a href="#quickstart-sdkintegration" id="quickstart-sdkintegration"></a>

The SDK can be integrated using [CocoaPods](#quickstart-cocoapods) or by [Manual Installation](#manual-installation).

{% hint style="info" %}
If your app is integrated with HyprMX SDK 6.x and you need help with migrating to 6.4+, please follow the steps in the [migration guide](/sdk-integration-guides/ios/migrate-to-version-6.4+.md).
{% endhint %}

### Swift Package Manager

Swift Package Manager is a dependency manager for Swift and Objective-C Cocoa projects. To integrate the HyprMX SDK with Swift Package Manager, follow the steps below.

{% stepper %}
{% step %}
From XCode's menu bar, navigate to File / Add Package Dependencies...
{% endstep %}

{% step %}
Place the following text into the search bar located in the upper right of the dialog.

```
git@github.com:JunGroupProductions/HyprMX-SDK-SPM.git
```

{% endstep %}

{% step %}
Select the "Exact Version" option for the Dependency Rule and use the following version:

```
6.4.6
```

{% endstep %}

{% step %}
Click the "Add Package" button.
{% endstep %}
{% endstepper %}

### CocoaPods <a href="#quickstart-cocoapods" id="quickstart-cocoapods"></a>

[CocoaPods](https://cocoapods.org/) is a dependency manager for Swift and Objective-C Cocoa projects. To integrate the HyprMX SDK with CocoaPods, add the following to your Podfile:

<pre class="language-bash"><code class="lang-bash"><strong>pod 'HyprMX', '6.4.6'
</strong></code></pre>

Note: HyprMX 6.0.0+ supports Cocoapods 1.10+

{% hint style="danger" %}
We cannot distribute new SDKs via CocoaPods [starting in December 2026](https://dev.to/surhidamatya/cocoapods-is-going-read-only-what-ios-developers-need-to-know-19j8).
{% endhint %}

### Manual Installation

To manually install the framework, follow the steps below.

{% stepper %}
{% step %}
Download the SDK here and unzip the file.
{% endstep %}

{% step %}
Drag and drop the HyprMX.xcframework (available in the zip) into your Xcode project. Make sure that the files are copied and verify the target membership.

<figure><img src="/files/9jIaWJbt6IUOAq8M3PDt" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Select your Project File and the Target. In the "General" tab, drag the HyprMX.xcframework from the File Explorer into the "Frameworks, Libraries, and Embedded Content" section.

{% endstep %}

{% step %}
Set the Embed setting to "Embed & Sign".

<figure><img src="/files/ZN7mrMJYIZ40pCSqEY1W" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

## Xcode Project Setup

### Application Transport Security <a href="#quickstart-applicationtransportsecurityats" id="quickstart-applicationtransportsecurityats"></a>

We recommend that [ATS](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW60) (App Transport Security) settings are turned off as Apple has put on hold their efforts to enforce the policy. In order to do so, add the App Transport Security dictionary key below to your Info.plist.

```markup
<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>   
```

If you prefer to enable ATS, you **must** add the below App Transport Security dictionary keys to your Info.plist to ensure that HyprMX operates properly.

```markup
<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoadsForMedia</key>
    <true/>
    <key>NSAllowsArbitraryLoadsInWebContent</key>
    <true/>
</dict> 
```

### Configuring Privacy Controls <a href="#quickstart-configuringprivacycontrols" id="quickstart-configuringprivacycontrols"></a>

iOS requires that the use of a user's camera, photo library, IDFA, etc. be declared by advertisers in the plist. Add all of the following entries to your app's plist.

```markup
<key>NSCameraUsageDescription</key>
    <string>${PRODUCT_NAME} requests write access to the Camera</string>
<key>NSPhotoLibraryAddUsageDescription</key>
    <string>${PRODUCT_NAME} requests write access to the Photo Library</string> 
<key>NSUserTrackingUsageDescription</key>
    <string>${PRODUCT_NAME} would like to show you personalized ads</string>
```

### SKAdNetwork Identifier <a href="#quickstart-skadnetworkidentifier" id="quickstart-skadnetworkidentifier"></a>

HyprMX SDK 5.4.0+ supports Apple's new SKAdNetwork for Attribution. To add the HyprMX SKAdNetwork ID to your info.plist:

```markup
<key>SKAdNetworkItems</key>
<array>
    <dict>
        <key>SKAdNetworkIdentifier</key>
        <string>nu4557a4je.skadnetwork</string>
    </dict>
    ...
</array>
```

Note: SKAdNetwork IDs are case sensitive. For more information about SKAdNetwork please refer to Apple's [documentation](https://developer.apple.com/documentation/storekit/skadnetwork).

### Orientation

HyprMX recommends your app support all orientations globally to maximize ad fill, as HyprMX ads may be shown in any orientation, and our view controller needs your app to support that behavior. You can configure this by selecting all possible orientations under the General tab of your Xcode target, or by configuring the `supportedInterfaceOrientations` in your App Delegate:

{% tabs %}
{% tab title="Swift" %}

```swift
func application(_ application: UIApplication, 
                supportedInterfaceOrientationsFor window: UIWindow?) -> UIInterfaceOrientationMask {
    return .all
}
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
- (UIInterfaceOrientationMask)application:(UIApplication *)application 
  supportedInterfaceOrientationsForWindow:(UIWindow *)window {
    return UIInterfaceOrientationMaskAll;
}
```

{% endtab %}
{% endtabs %}

*Please note, this setup does not require that your app's interface support all orientations. You just have to configure your view controllers' orientation settings:*

{% tabs %}
{% tab title="Swift" %}

```swift
public override var supportedInterfaceOrientations: UIInterfaceOrientationMask {
    return .landscape
}

public override var preferredInterfaceOrientationForPresentation: UIInterfaceOrientation {
    return .landscapeLeft
}
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
- (UIInterfaceOrientationMask)supportedInterfaceOrientations {
    return UIInterfaceOrientationMaskLandscape;
}

- (UIInterfaceOrientation)preferredInterfaceOrientationForPresentation {
    return UIInterfaceOrientationLandscapeLeft;
}
```

{% endtab %}
{% endtabs %}

## Importing the SDK <a href="#quickstart-initializinghyprmx" id="quickstart-initializinghyprmx"></a>

To import the HyprMX Mobile SDK into your Application:

{% tabs %}
{% tab title="Swift" %}

```swift
import HyprMX
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
@import HyprMX;
```

{% endtab %}
{% endtabs %}

## Initializing HyprMX <a href="#quickstart-initializinghyprmx" id="quickstart-initializinghyprmx"></a>

After you have integrated the SDK, proceed to initialize the HyprMX SDK. To initialize, see details below. As a best practice, initialize HyprMX as soon as possible (i.e. when your application is loading) so we can begin preloading ads.&#x20;

### **Initialization API**

#### **Sample Initializer**&#x20;

{% tabs %}
{% tab title="Swift" %}

```swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    let distributorId = "Your Distributor ID"
 
    Task {
        let completed = await HyprMX.initialize(distributor: distributorId)
        switch completed {
            case .success:
                handleSuccess()
            case .failure(let error):
                print(error)
                handleFailure()
        }
    }

    return true
}
```

{% endtab %}

{% tab title="Objective-C" %}

```objectivec
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  NSString *distributorId = @"Your Distributor ID";

  [HyprMX initWithDistributorId:distributorId
                     completion: ^(BOOL success, NSError * _Nullable error) {
      if (success) {
          handleSuccess();
      } else {
          NSLog(@"%@", [error description]);
          handleFailure();
      }
  }];

  return YES;
}
```

{% endtab %}
{% endtabs %}

#### **distributorID (required)**

The value for `distributorId` is assigned to your application by HyprMX. If you have not received this ID, please reach out to your HyprMX account manager.

### After Initialization

After receiving the `initializationDidComplete` message, you are now ready to load and display ads in your application. See our [Rewarded Ads](/sdk-integration-guides/ios/ad-formats/rewarded-ads.md), [Interstitial Ads](/sdk-integration-guides/ios/ad-formats/interstitial-ads.md), and [Banner/MREC Ads](/sdk-integration-guides/ios/ad-formats/banner-mrec-ads.md) guides to add these ad types to your application.

## \[Optional] Passing Alternative Identifiers

{% hint style="danger" %}
Alternative/Extended IDs are supported in HyprMX SDK 6.4+.
{% endhint %}

HyprMX SDK supports the following alternative IDs or extended IDs (EID) to help improve monetization. If applicable, you are responsible for tokenizing IDs before passing them to HyprMX SDK.

* [Unified ID 2.0 (UID2)](https://unifiedid.com/)
* [ID5](https://id5.io/)
* [LiveIntent ID](https://www.liveintent.com/identity-solutions/)

The following code snippet shows how to pass the IDs to HyprMX. Any optional fields supplied should be of the correct type.

{% tabs %}
{% tab title="Swift" %}

```swift
let uid2 = [
    [
        "id": "testUID2Id"
    ]
]

let id5 = [
    [
        "id": "testID5Id",
        "linkType": 2, // Optional. Only integer values 0..3 are allowed.
        "abTestingControlGroup": true // Optional
    ]
]

let liveintent = [
    [
        "id": "testLiveintentId",
        "atype": 1 // Optional. Only integer values 1, 2, 3, or 500+ allowed
    ]
]

let eids = [
    "uid2": uid2, // Optional
    "id5": id5, // Optional
    "liveintent": liveintent // Optional
]

if let eidData = try? JSONSerialization.data(withJSONObject: eids) {
    HyprMX.setUserExtras(String(data: eidData, encoding: .utf8) ?? "", for: "eids")
}
```

{% endtab %}

{% tab title="Objective C" %}

```objectivec
NSArray *uid2 = @[
    @{
        @"id": @"testUID2Id"
    }
];

NSArray *id5 = @[
    @{
        @"id": @"testID5Id",
        @"linkType": @2, // Optional. Only integer values 0..3 are allowed.
        @"abTestingControlGroup": @true // Optional
    }
];

NSArray *liveintent = @[
    @{
        @"id": @"testLiveintentId",
        @"atype": @1 // Optional. Only integer values 1, 2, 3, or 500+ allowed
    }
];

NSDictionary *eids = @{
    @"uid2": uid2,
    @"id5": id5,
    @"liveintent": liveintent
};
    
NSData *eidData = [NSJSONSerialization dataWithJSONObject:eids options:0 error:nil];
if (eidData) {
    NSString *eidJsonString = [[NSString alloc] initWithData:eidData encoding:NSUTF8StringEncoding];
    if (eidJsonString) {
        [HyprMX setUserExtras:eidJsonString for:@"eids"];
    }
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
For best results, set alternative/extended IDs before initializing HyprMX.
{% endhint %}

{% hint style="info" %}
Passing an empty string instead of json clears all alternative/extended IDs.
{% endhint %}

## Privacy Compliance

Please refer to our [Privacy](broken://pages/qo15izO4kikKMzTBxNsr) page to learn more about your privacy compliance responsibilities and to implement the relevant privacy methods.

## License <a href="#quickstart-license" id="quickstart-license"></a>

By integrating the HyprMX SDK, you are agreeing to the [End User License Agreement](https://hyprmx.com/eula.html).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.hyprmx.com/sdk-integration-guides/ios.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.