For the complete documentation index, see llms.txt. This page is also available as Markdown.

Initialization

βš™ SDK Initialization

To initialize Tyr SDK, embed a URL in your WebView with the following structure:

https://sdk.tyrads.com?token=<TOKEN>&to=<ROUTE>&lang=<LOCALE>

🚦 Parameters

Parameter
Required
Description

token

βœ… Yes

Access token generated via API. This token authenticates the session.

to

❌ No

Deep link route to direct users to a specific screen or feature in the SDK (e.g., /offers, /active-offers, /settings)

lang

❌ No

Language/locale code for SDK content localization. Follows ISO 639-1 (e.g., en, ja, id)

skipUserInfo

❌ No

Bypasses the user onboarding/profile collection screen on SDK launch. Set to true if user information has already been collected or is managed externally (e.g., skipUserInfo=true

placementId

❌ No

Identifies the ad placement context to filter and return only the currencies available for that specific placement. Use the placement ID assigned during your ad unit setup (e.g., placementId=1

hideBackButton

❌ No

Hides the back button on the offerwall page, which is normally used to close the SDK. Set to true if you want to prevent users from closing the SDK via this button. It is usually used when close behavior is handled by your own app. (e.g., hideBackButton=true)

Last updated