Integrating Bridgewise Widgets

Created by Erez Michaeli, Modified on Mon, 4 Nov, 2024 at 8:39 AM by Erez Michaeli

TABLE OF CONTENTS


Overview

Bridgewise provides advanced financial analysis widgets that are easily integrated into client applications. These widgets offer detailed insights and analytics, providing detailed information to its clients. Integration is straightforward. For web platforms, Bridgewise offers script-based and iframe options. For mobile platforms, WebView is available. These widgets are applicable to web, mobile, and desktop applications, ensuring wide compatibility.


With AI-driven analytics available in various languages, these widgets are designed to help in making informed financial decisions. Bridgewise offers script-based and iframe options for web platforms and WebView for mobile platforms.



Widget Catalog

Bridgewise offers a number of widgets to meet the client platform's financial data presentation needs. Each widget is designed to provide targeted insights into various aspects of financial performance and market data, ensuring that you can tailor your platform's analytics to your users' requirements.



The full list of widgets can also be accessed here.



Integrating Bridgewise Widgets

To integrate Bridgewise widgets into an app, clients need to follow these steps:


Authorization

After selecting the widgets you wish to integrate, you should be provided with an access token to initialize Bridgewise's widgets. To obtain the access token, please check this article.


Select Identifiers

Our widgets offer flexible data query options by supporting both internal and external identifiers. You can use globally recognized identifiers like ISIN codes or TICKER-EXCHANGE formats, depending on your preference and the specific data requirements of your platform. This flexibility enables precise and relevant financial data retrieval, improving the widgets' overall use.

  • TICKER-EXCHANGE Format: Verify that the exchange symbols you intend to use are supported by our platform. This step ensures compatibility and accuracy in data retrieval. A comprehensive list of supported exchange symbols is available here.

  • Internal Identifiers: Establish a mapping between external identifiers and our internal identifiers. Detailed information on this process can be found in here.

  • ISIN Format: Use International Securities Identification Numbers (ISIN) for globally recognized, standardized identification of securities. Ensure that the ISIN codes you intend to use are compatible with our platform for accurate data retrieval (e.g. US-000402625-0).


Integrate the Widget

Once clients have chosen their desired collection of parts and components of widgets, they receive a unique identifier specific to the widget. The basic HTML structure for integrating a Bridgewise widget is as follows and needs to be embedded into their applications as a script:

<div class="widget_wrapper">
<div id="bw-fundamental-analysis-main"></div>
</div>


In addition to the HTML, clients need to implement a JavaScript snippet to configure and activate the widget. The snippet includes an identifier applicable to the FinTech industry, a unique token, and the widget's name. The updated integration code using tokens is shown below:

new BridgeWise.Collection({
  accessToken: "accessToken",
identifier: "APPL-NasdaqGM",
name: "fundamental-analysis-main"
});

And most importantly, https://widget.bridgewise.com/index.js should also be included in the script to determine which widget to load.


Widget Properties Table


Property

Acceptable Values

Description

identifier

ISIN, ticker-exchange

The specific identifier for the widget's data retrieval.

language

en-US, de-DE, he-IL, zh-CN, pt-BR, ar-SA, es-ES, nl-NL, tr-TR, fr-FR, ja-JP

Sets the language for widget content, enhancing user comprehension.

mode

light, dark

Chooses the theme for the widget's appearance, allowing for visual integration with your platform.

onError

callback function

A function called upon encountering an error, enabling custom error handling.

onCompanySelect

callback function

Triggers upon company selection, returning essential company details for further actions.

actionType

external, internal, prevent

Determines how reports open upon selection, offering flexibility in user navigation.

accessToken

Your unique Access Token

Facilitates secure communication and access to the Bridgewise platform.


Example of an Integration Code

<div id="bw-{{widget_id}}"></div>
<script src="https://widget.bridgewise.com/index.js"></script>
<script>
new BridgeWise.Collection({
accessToken: "{{accessToken}}",
identifier: "APPL-NasdaqGM",
language: "en-US",
mode: "light",
name: "{{widget_id}}"
});
</script>

In this example, where {{accessToken}} and {{widget_id}} are replaced with your actual token and the chosen widget ID, respectively.


Customizing Widgets

Bridgewise offers its clients choose the mix of parts and components that make up their widgets. This mix is referred to a feature known as Collection


Collection of Parts and Components

This customization allows clients to select only the necessary elements that align with their specific needs to deliver the most relevant information and functionality for their application via widgets.


Bridgewise widgets offer a range of customization options to align with the client’s branding and design guidelines:

  • Element Customization: Clients can reduce the number of elementcomponents within the widget, ensuring only the most relevant information is displayed. However, it is not possible to add new elements or strings to the widget. 

  • Styling and Coloring: All coloring and styles of the widget can be modified using CSS. This allows clients to match the widget’s appearance with their overall application design.

  • Modular Configuration: Widgets are composed of various modules that can be mixed and matched according to the client's specific needs. This modular approach enables clients to customize the functionality and presentation of the widgets to suit their particular requirements.

Changes requested by clients should be directed to the Customer Success team and be implemented both on the client and the Bridgewise side.


Implementing Bridewise Widgets in iFrame

To embed a widget using the Bridgewise platform, use the following base URL format:

<https://app.bridgewise.com/collection/{language}/{tenant}/{widgetName}>

URL Parameters:

  • language: Defines the language of the widget. Example values include:

    • en-US for English (US)

    • he-IL for Hebrew (Israel)

  • tenant: Your tenant-specific slug (e.g., xxxx).

  • widgetName: Specifies the widget to display. Available options include:

    • bw-summary


Example URLs

  • Report Page:

    <https://app.bridgewise.com/collection/en/my_tenant/bw-summary?identifier=AAPL-Nasdaq&actionType=external&accessToken=yourAccessToken>

Required Query Parameters

  • identifier: The stock identifier (e.g., AAPL-Nasdaq)

  • actionType: Must be set to external to enable onCompanySelect and onClick events via postMessage.

  • accessToken: Your unique access token for authorization.


Exposed Events

The following events are exposed and sent viapostMessage. You can parse the event payloads using JSON.parse():

  • on-load: Triggered when the widget is fully loaded.

  • on-success: Provides the IFRAME height.

  • on-resize: Sent when the IFRAME is resized, includes the new height.

  • on-click: Triggered when a clickable element inside the widget is interacted with.

  • on-company-select: Fired when a company is selected in the widget.

  • on-language-fallback: Triggered when the widget falls back to a default language.

  • on-error: Sent if an error occurs within the widget.


Analytical Events for Widgets

Several key analytical event callbacks are available for tracking and responding to various widget actions and request outcomes.


onSuccess Callback

Description:
The onSucces callback is triggered when all requests initiated by the widget are successfully completed without any issues.


Use Case:
This callback is typically used for handling post-processing actions after the widget completes a successful interaction with the backend, such as sending analytics, updating the UI, or triggering subsequent workflows.


onLanguage Fallback Callback

Description:
The onLanguageFallback callback is invoked when the language specified in the widget initialization is not supported by Bridgewise, and the content defaults to English.

Parameters:  

  • fallbackLanguage: The language code that was originally sent when calling the init function.


Use Case:
This callback helps monitor and handle cases where users attempt to initialize the widget with an unsupported language. You can use this function to notify users, log such events, or provide custom fallback behavior.


onError Callback 

Description:
The onError callback is triggered when an error occurs during widget initialization or requests. Errors can include issues such as missing authentication credentials, an invalid token, an incorrect identifier, or any other failure in request execution.

Parameters:  

  • errorMessage: The error message returned by the widget when the failure occurs.

Use Case:
You can use this callback to log errors, show error messages to the user, or trigger alternative flows in case of failure.


onEvent Callback

Description:
The onEvent callback allows clients to capture specific user interactions within the widget, such as clicks, hovers, or any other custom-defined events. This callback is triggered each time the specified event occurs.

Parameters:  

  • eventType: The type of event that has been triggered (e.g., "click", "hover").

  • eventData: Additional data associated with the event, such as metadata or event context.


Use Case:
This function is useful for tracking custom events that clients request to monitor, such as user behavior analytics, UI interaction logging, or any specific event that should trigger additional logic.


Find out more in the Screener here.



Frequently Asked Questions

 

How many publicly-traded companies do the widgets cover?

Bridgewise's analyses and widgets cover and rank over 36,000 publicly traded companies from global markets. The coverage includes companies with a market cap of at least $10 million as of the latest financial statement publish date.

 

How frequently is the data updated? 

Bridgewise updates stock and market data twice daily to ensure you have the most current information.

 

Which platforms do the widgets support?

The widgets are platform and device-agnostic, meaning they are compatible with both desktop and mobile applications across all devices.

 

What is the widget's rate limit?

The widget can render up to 1,000 times per second. For higher usage needs, please contact us for more information.

 

Besides widgets, what other integration methods are available?

Clients can also integrate BW’s data via API. For more details on API integration, please contact our sales team here.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article