HyprMX Mediation Integration Guide

This guide will instruct you step-by-step on how to set HyprMX live as an Ad Network on the ironSource Mediation platform.

Before you start
  • Make sure you have correctly integrated ironSource’s Rewarded Video or Interstitial into your application.
  • In case you upgrade from lower adapter versions to 4.1.2 onwards, please make sure you reconfigure their HyprMX parameters within the platform to new ones. In order to get HyprMX new parameters, you should contact integration@hyprmx.com.
  • HyprMX SDK Show ads for Android Operating Systems Version 5.0 (API level 21) and up.

Step 1. Create an HyprMX Account

HyprMX provides a managed service. To create an account with them, contact them directly at integration@hyprmx.com.  Once your account is created, they will help you set up your application and retrieve the required parameters to activate HyprMx in your ironSource account.

Step 2. Activate HyprMX in Your ironSource Network Setup Module

There are 3 pieces of data from the HyprMX account which need to be inserted into your ironSource Network Setup Module in order for HyprMX to work correctly in connection with ironSource:

API Key This is the unique identifier of your account in the HyprMX system.
Distributor ID This is the unique Application identifier which HyprMX will deliver ads to.
Placement Name This is a unique identifier of your Placement with HyprMX.

Once you obtain this information, you must configure HyprMX’s Parameters in your ironSource Account. By adding the above information correctly, you will be able to take full advantage of HyprMX’s ad inventory and reporting data on ironSource’s Mediation platform.

Configure HyprMX’s Parameters into ironSource Account

  • Once you obtain the above parameters, log in to your ironSource account and go to ‘Monetize‘ ➣ ‘SDK Networks‘:
  • Select HyprMX from the list of available Ad Networks and input the HyprMX  ‘API Key‘.11
  • Next, select the app on which you’d like to run ironSource’s Mediation with HyprMX and click on the ‘Setup’ button. Then enter the ‘Distributor ID‘ and ‘Placement Name‘ in the relevant fields.1
  • You will then see HyprMX as Active for Mediation on the Setup Dashboard.

Step 3. Add the HyprMX Adapter to Your Build

ironSource supports both Gradle dependencies and manual download mechanisms.


  1. Make sure the following Maven URL exist in your build.gradle script of your app module.
    repositories {
        maven {
            url "https://android-sdk.is.com/"
  2. Add the adapter’s Maven name to your build.gradle script of your app module and add support-annotations and support-v4.jar.
    implementation 'com.hyprmx.android:HyprMX-SDK:5.1.2'
  3. Make sure your build.gradle script of your project supports classpath of 3.3.1 or above.
    classpath 'com.android.tools.build:gradle:3.3.1'

Manual download

  1. Download the HyprMX Adapter:
    Add the HyprMX Adapter to your build. You can find the latest HyprMX Adapter here.
  2. Add the HyprMX Adapter to your Project:
    After you download the Adapter; drop the HyprMXAdapter jar into the libs folder in your Android Project. Make sure you have the support-annotations and support-v4.jarintegrated in your project in your libs folder.
    Supersonic HyperMX Drop Libs
  3. Make sure you add the following to your Gradle build file under the dependencies section:
    implementation 'com.hyprmx.android:HyprMX-SDK:5.1.2'

  4. In Android Studio go to FileNew New Module ➣ Import .JAR.
    Navigate to the location where the HyprMX SDK has been downloaded.
    Supersonic Add New Module in Android StudioFor Proguard Users Only
    If you are using ProGuard with the HyprMX adapter, you must add the following code to your ProGuard file (Android Studio: proguard-rules.pro or Eclipse: proguard-project.txt):
    -keepattributes InnerClasses
    -keepattributes Signature
    -keepattributes Annotation
    -keepattributes EnclosingMethod
    -keep class com.hyprmx.** {*;}
    -keep class okhttp3.hyprmx.**
    { *; }
    -keep interface okhttp3.hyprmx.** { *; }
    -keep class com.google.gson.hyprmx.**
    { *; }
    -keepclassmembers class *
    { @android.webkit.JavascriptInterface <methods>; }
    -dontwarn okhttp3.hyprmx.**
    -dontwarn okio.hyprmx.**
    -dontwarn com.google.android.gms.ads.identifier.**

Step 4. Update AndroidManifest.xml

As of ironSource Android SDK Version 6.17.0 (HyprMx Android adapter version 4.1.5+), HypMx adapter will be released as AAR.

Only if you intend to keep your Jar integration, please add the manifest.

Manifest Permissions:

    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.VIBRATE" />

Manifest Activities:
Add the following activities inside the <application> tag in your manifestAdditions:

android:label="HyprMX SDK"
android:theme="@style/hyprmx_ActivityTheme" />
android:theme="@style/hyprmx_RequiredInfoTheme" />
android:theme="@style/hyprmx_ActivityTheme" />
android:theme="@style/hyprmx_ActivityTheme" />

android:grantUriPermissions="true" >
android:resource="@xml/hyprmx_provider_paths" />


You are now all set to deliver HyprMX within your application!

What’s Next?
To leverage additional ad networks through ironSource Mediation, integrate the adapters and follow our integration guides.