Bridgewise API Documentation: Getting Started

TABLE OF CONTENTS

• Overview
• Getting Started
• Obtain Bridgewise Internal Identifiers 
• Identifiers Explained: Company ID vs. Security ID vs. Trading Item ID
• Example for Data Retrieval
• Explore Bridgewise API

Overview

The Bridgewise API stands out as a leading interface to a vast expanse of financial information, covering nearly all publicly traded companies worldwide. It offers raw numerical data, AI-driven recommendations, and insightful textual analyses, all available in native languages. This API is designed on a RESTful architecture, ensuring easy integration and compatibility with modern development practices. 

Getting Started

Our guide is designed to streamline your introduction to utilizing the API, ensuring you're well-prepared to make the most of the wealth of financial data available at your fingertips.

The initial step to accessing the Bridgewise API which is described in this article.

Obtain Bridgewise Internal Identifiers 

All identifiers within the Bridgewise API are internal, but rest assured, we seamlessly support the conversion from globally recognized identifiers such as ISIN and/or Ticker-Exchange. This process is both straightforward and quick, ensuring you can easily integrate and work with your existing financial data identifiers within our platform.

In this example, we are submitting the Tesla stock symbol to the Bridgewise identifier-search  endpoint. This endpoint serves as the entry point to the Bridgewise identifier converter, facilitating the translation of widely recognized financial symbols into Bridgewise's internal identifiers.

Request

curl -X 'GET' \
  'https://rest.bridgewise.com/identifier-search?identifier=TSLA-NASDAQ&identifier_type=ticker_exchange' \
  -H 'accept: application/json'

Response

{
    "company_name": "Tesla, Inc.",
    "company_id": 27444752,
    "identifiers": [
        {
            "security_id": 108803914,
            "security_name": "Common Stock",
            "security_primary_flag": true,
            "trading_item_ids": [
                {
                    "trading_item_id": 108803915,
                    "trading_item_id_primary_flag": true,
                    "ticker_symbol": "TSLA",
                    "exchange_symbol": "NasdaqGS",
                    "exchange_name": "Nasdaq Global Select",
                    "exchange_id": 458,
                    "exchange_importance_level": 3
                }
            ]
        }
    ]
}

Let’s breakdown the request and the response of that call.

Request

Response

Identifiers Explained: Company ID vs. Security ID vs. Trading Item ID

As a result of our previous request to identifier-search we received the company_id (27444752) the security_id (108803914) trading_item_id (108803915) for the external identifier (TSLA-NASDAQ). 

Let's take a closer look at Tesla, which is traded on 7 exchanges with 4 different ISINs, in order to gain a deeper understanding of the identifiers. This use case will help clarify the differences between these identifiers.

In the above example, we can see that Tesla is listed on various exchanges but is unified under a single entity identifier, the company_id (27444752). Within this entity, there are three security IDs, each linked to a unique ISIN. For every ISIN, there are numerous trading_item_ids, which are combinations of Ticker-Exchange. Although multiple security IDs exist, only one is designated as the primary. Similarly, each security ID may have several trading_item_ids, but just one is selected as the primary for each.

The primary identifier used in the Bridgewise API is the company_id, which is used for company-level data retrieval. The trading_item_id is utilized specifically for accessing data at the ticker symbol level, while the security_id is not used at all. In our Swagger documentation, we will clearly specify the required identifier for each endpoint.

Note:

• To retrieve data for specific IDs (e.g., domicile_country_id), use the following request format:

  • https://rest.bridgewise.com/companies?domicile_country_id=100

• To exclude specific IDs, use negative values in the request, as shown below:

  • https://rest.bridgewise.com/companies?domicile_country_id=-100

In this case, the results will be more accurate, as they will focus on the inclusion or exclusion of specific IDs.

Example for Data Retrieval

Let's examine how an actual request and response in the Bridewise API look after converting the external identifier to an internal identifier.

curl -H ‘Access Token’: ‘access-token’ https://rest.bridgewise.com/companies/27444752

[
  {
    "language": "en-US",
    "updated_at": "2024-08-07T07:33:48.491895",
    "company_id": 21835,
    "company_name": "Microsoft Corporation",
    "company_name_short": "Microsoft",
    "website": "http://www.microsoft.com ",
    "primary_ticker_symbol": "MSFT",
    "primary_exchange_symbol": "NasdaqGS",
    "region_id": 10359,
    "region_name": "United States and Canada",
    "incorporation_country_id": 213,
    "incorporation_country_name": "United States",
    "incorporation_country_iso2": "US",
    "domicile_country_id": 213,
    "domicile_country_name": "United States",
    "domicile_country_iso2": "US",
    "gics_sector_id": 45,
    "gics_sector_name": "Information Technology",
    "gics_industry_group_id": 4510,
    "gics_industry_group_name": "Software & Services",
    "gics_industry_id": 451030,
    "gics_industry_name": "Software",
    "csa_industry_id": 52,
    "csa_industry_name": "Software",
    "primary_currency_market_id": 160,
    "primary_currency_market": "USD",
    "primary_currency_financials_id": 1,
    "primary_currency_financials": "TBD",
    "primary_security_id": 2630412,
    "primary_security_name": "Common Stock",
    "ipo_date": "1986-03-13T00:00:00"
  }
]

Explore Bridgewise API

Congratulations! You are now equipped to navigate the Bridgewise API. For an in-depth understanding, we've made available Swagger Documentation to expedite your acquaintance with the features at your disposal. Should you have any questions, our technical support team is eager to assist.