Skip to content

Public Resources

MethodReturns
client.user(userId)PublicUserScope
client.tipAlerts.fromWidgetUrl(widgetUrl, options?)TipAlertsListener

userId here means a previously known internal Tipply identifier. Public profile payloads no longer expose another user’s id.

MethodReturns
client.user(userId).goals.templates.list(requestOptions?)Promise<PublicTemplate<"TIPS_GOAL", TipsGoalTemplateConfig>[]>
client.user(userId).goals.configuration.get(requestOptions?)Promise<TipsGoalConfiguration>
client.user(userId).goals.id(goalId).widget.get(requestOptions?)Promise<PublicGoalWidget>
MethodReturns
client.user(userId).voting.templates.list(requestOptions?)Promise<PublicTemplate<"GOAL_VOTING">[]>
client.user(userId).voting.configuration.get(requestOptions?)Promise<GoalVotingConfiguration>
MethodReturns
client.user(userId).templateFonts.get(requestOptions?)Promise<string>
client.user(userId).widgetMessage.get(requestOptions?)Promise<boolean>
client.user(userId).tipAlerts.createListener(options?)TipAlertsListener

The realtime helpers accept a full widget URL such as:

https://widgets.tipply.pl/TIP_ALERT/user-123

The SDK extracts the userId automatically before opening the websocket connection when the widget URL contains it.

  • public HTTP reads use https://tipply.pl/api
  • templateFonts.get() returns raw CSS
  • no authenticated session is required for any method on this page