FactSet.SDK.FactSetConcordance 0.24.5

FactSet Concordance client library for .NET

The FactSet Concordance API enables Application Developers and Data Scientists to programmatically discover the FactSet Identifier for a specific Entity or Person based on attributes, such as name, URL, and location.FactSet Identifiers are mapped to industry-standard identifiers, as well as to a comprehensive set of reference data and unique content, to enhance the ability to quickly connect content sets.<p>

Using the submitted attributes, the FactSet Concordance API leverages FactSet’s extensive Entity Master, People, and Symbology databases to return potential candidate matches and a proposed match. The result is a concorded FactSet Identifier that can then be used as input throughout FactSet's expanding catalog of Content using our Content APIs or Standard DataFeeds.</p>

<b>There are two types of workflows supported in the API:</b>

<b>Entity & People Match:</b> The first workflow follows traditional API conventions in that a request is accepted and a response is returned synchronously enabling the concordance of up to 25 names in a single request. The response returns a list of 20 candidates as well as a proposed match.

<b>Entity & People Match - Bulk:</b> The second workflow allows you to input a large list of names within a .CSV file in a single request With this workflow, a task is created for uploading a set of queries. Once the task has completed, the client retrieves the concordance results through the /entity-decisions or /people-decisions endpoint. Note that in the Bulk workflow, only the matches for the records are returned. Candidates are not included.

Once the service has provided a list of concorded FactSet Identifiers, you can then use our Entity Mappings and People Mappings endpoints to further review the universe of mapped identifiers or modify existing records. </p><p><b>Rate limit is set to 10 requests per second</b>.</p>

Methodology Guide link: https://open.factset.com/api/public/media/download/products/documents/8ca33e81-a7da-4d77-a8cf-2b3a2e868b3d

This .NET package is automatically generated by the OpenAPI Generator project:

• API version: 2.8.0
• SDK version: 0.24.5
• Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

Requirements

• .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.FactSetConcordance -v 0.24.5

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetConcordance -Version 0.24.5

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
3. Install dependencies.
4. Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.FactSetConcordance.Api;
using FactSet.SDK.FactSetConcordance.Client;
using FactSet.SDK.FactSetConcordance.Model;

namespace Example
{
    public static class GetEntityMatchExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetConcordance.Client.Configuration();

            // Examples for each supported authentication method are below,
            // choose one that satisfies your use case.

            /* (Preferred) OAuth 2.0: FactSetOAuth2 */
            // See https://github.com/FactSet/enterprise-sdk#oauth-20
            // for information on how to create the app-config.json file
            //
            // The confidential client instance should be reused in production environments.
            // See https://github.com/FactSet/enterprise-sdk-utils-dotnet#authentication
            // for more information on using the ConfidentialClient class
            ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
            config.OAuth2Client = confidentialClient;

            /* Basic authentication: FactSetApiKey */
            // See https://github.com/FactSet/enterprise-sdk#api-key
            // for information how to create an API key
            // config.Username = "USERNAME-SERIAL";
            // config.Password = "API-KEY";

            var apiInstance = new EntityMatchApi(config);
            var name = "Tesla";  // string | Name of Entity to match.
            var country = "US";  // string | ISO2 country code corresponding to the entity name that is used when evaluating candidates for a match. For a list of ISO2 Country codes, visit [OA 8754](https://my.apps.factset.com/oa/pages/8754). (optional) 
            var state = "TX";  // string | Two-character state code corresponding to the entity name that is used when evaluating candidates for a match. Currently, only US state codes are supported. (optional) 
            var url = "www.tesla.com";  // string | URL corresponding to the entity name that is used when evaluating candidates for a match. (optional) 
            var includeEntityType = new List<string>(); // List<string> | Three-character FactSet entity type code used to filter candidates in order to determine the final match result. Only candidates with an entity type specified will be considered for the final match result. Multiple types can be entered separated by commas.   |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|   |- --|- --|- --|- --|   |ABS|Asset-Backed||MED|Broadcast Call Sign|   |BAS|Business Association (JP)||MUC|Mutual Fd-Closed End|   |CAC|Consolidated Accounting||MUE|Mutual Fd-ETF|   |CMD|Commodity||MUT|Mutual Fd-Open End|   |COL|College/University||NPO|Non-Profit Organization|   |CUR|Currency||OPD|Operating Division|   |ESP|Emp Stk Ownership Plan||OTH|Other|   |EXT|Extinct||PEF|Pension Fund|   |FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property|   |FND|Foundation/Endowment||PUB|Public Company|   |FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt|   |FRX|ForEx||PVT|Private Company|   |GOV|Government||SOV|Sovereign Wealth Fund|   |HED|Hedge Fund||SUB|Subsidiary|   |HOL|Holding Company||TRU|Trust/Trustee|   |IDX|Index||UMB|Umbrella Fund|   |VEN|Venture Capital Fund||JVT|Joint Venture|  (optional) 
            var excludeEntityType = new List<string>(); // List<string> | Three-character FactSet entity type code used to filter candidates in order to determine the final match result. Candidates with an entity type specified will *not* be considered for the final match result. Multiple types can be entered separated by commas.   |Entity Type Code|Entity Type Description|Entity Type Code|Entity Type Description|   |- --|- --|- --|- --| |ABS|Asset-Backed||MED|Broadcast Call Sign| |BAS|Business Association (JP)||MUC|Mutual Fd-Closed End| |CAC|Consolidated Accounting||MUE|Mutual Fd-ETF| |CMD|Commodity||MUT|Mutual Fd-Open End| |COL|College/University||NPO|Non-Profit Organization| |CUR|Currency||OPD|Operating Division| |ESP|Emp Stk Ownership Plan||OTH|Other| |EXT|Extinct||PEF|Pension Fund| |FAF|Family of Fds (VC/Pvt EQ)||PRO|Real Property| |FND|Foundation/Endowment||PUB|Public Company| |FNS|Financing Subsidiary/SPE||PVF|Private Eq Fd/Alt Invt| |FRX|ForEx||PVT|Private Company| |GOV|Government||SOV|Sovereign Wealth Fund| |HED|Hedge Fund||SUB|Subsidiary| |HOL|Holding Company||TRU|Trust/Trustee| |IDX|Index||UMB|Umbrella Fund| |VEN|Venture Capital Fund||JVT|Joint Venture|  (optional) 
            var includeEntitySubType = new List<string>(); // List<string> | Two-character FactSet entity subtype code used to filter candidates in order to determine the final match result. Only candidates with an entity subtype specified will be considered for the final match result. Multiple types can be entered separated by commas.   |Entity Subtype Code|Entity Subtype Description|Entity Subtype Code|Entity Subtype Description|   |- --|- --|- --|- --|   |AR|Arbitrage|IC|Investment Company|   |BM|Bank Investment Division|IN|Insurance Company|   |BR|Broker|MF|Mutual Fund Manager|   |CP|Corporate|ML|Master Ltd Part|   |CU|Custodial|MM|Market Maker|   |FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt|   |FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager|   |FO|Foundation/Endowment Manager|PP|Real Estate Manager|   |FS|Fund Distributor|RE|Research Firm|   |FU|Fund|SB|Subsidiary Branch|   |FY|Family Office|ST|Stock Borrowing/Lending|   |GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager|   |HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity|   |IA|Investment Adviser|   |IB|Investment Banking|  (optional) 
            var excludeEntitySubType = new List<string>(); // List<string> | Two-character FactSet entity subtype code used to filter candidates in order to determine the final match result. Candidates with an entity subtype specified will not be considered for the final match result. Multiple types can be entered separated by commas. |Entity Subtype Code|Entity Subtype Description|Entity Subtype Code|Entity Subtype Description| |- --|- --|- --|- --| |AR|Arbitrage|IC|Investment Company| |BM|Bank Investment Division|IN|Insurance Company| |BR|Broker|MF|Mutual Fund Manager| |CP|Corporate|ML|Master Ltd Part| |CU|Custodial|MM|Market Maker| |FF|Fund of Funds Manager|PB|Private Banking/Wealth Mgmt| |FH|Fund of Hedge Funds Manager|PF|Pension Fund Manager| |FO|Foundation/Endowment Manager|PP|Real Estate Manager| |FS|Fund Distributor|RE|Research Firm| |FU|Fund|SB|Subsidiary Branch| |FY|Family Office|ST|Stock Borrowing/Lending| |GV|Govt (Fed/Local/Agency)|SV|Sovereign Wealth Manager| |HF|Hedge Fund Manager|VC|Venture Capital/Pvt Equity| |IA|Investment Adviser| |IB|Investment Banking|  (optional) 
            var includeParent = false;  // bool? | Flag to include parent entities in the list of candidates. This parameter does not influence the match result. (optional)  (default to false)
            var bbgFigi = "BBG000N9P426";  // string | Input identifiers for the Bloomberg Listing/Regional/Security ID symbol type. (optional) 
            var bbgTicker = "TSLA UW";  // string | Input identifiers for the Bloomberg Listing and Regional Ticker symbol Type. (optional) 
            var bic = "TSLAUS66";  // string | Input identifiers for the BICCode - Bank Indentification Code symbol Type. (optional) 
            var cik = "1318605";  // string | Input identifiers for the CIK - Edgar Central Index Keys symbol type. (optional) 
            var crd = "CRD";  // string | Input identifiers for the CRD - Central Registration Depository symbol type. (optional) 
            var cusip = "88160R101";  // string | Input identifiers for the CUSIP symbol type. (optional) 
            var duns = "Dun&Bradstreet";  // string | Input identifiers for the DUNS - Dun & Bradstreet Data Universal Numbering System symbol type. (optional) 
            var ein = "912197729";  // string | Input identifiers for the EIN - Employer Identification Number symbol type. (optional) 
            var factsetId = "006XY7-E";  // string | Input identifiers for the type FactSet Identifier - FactSet -E,-S,-R, -L Permanent Identifier symbol type. (optional) 
            var fitch = "FitchCreditRating";  // string | Input identifiers for the Fitch - Fitch Ratings symbol type. (optional) 
            var gvkey = "GVKey";  // string | Input identifiers for the type GVKEY - Compustat Global Company Key symbol type. (optional) 
            var gvkeyIid = "GVKeyIssueIdentifier";  // string | Input identifiers for the type GVKEY+IID - Compustat Global Company Key and Issue Identifier symbol type. (optional) 
            var isin = "US88160R1014";  // string | Input identifiers for the ISIN - International Securities Identification Number symbol type. (optional) 
            var jcn = "JCN";  // string | Input identifiers for the type JCN - Japanese Corporate Number symbol type. (optional) 
            var lei = "54930043XZGB27CTOV49";  // string | Input identifiers for the LEI - Legal Entity Identifier symbol type (optional) 
            var lxid = "LXID";  // string | Input identifiers for the type LXID - Markit Syndicated Loan Identifier symbol type. (optional) 
            var md = "823642219";  // string | Input identifiers for the Moody's Ratings Identifier type. (optional) 
            var redCode = "RedCode";  // string | Input identifiers for the type Red Code - Markit Reference Entity Identifier symbol type. (optional) 
            var rssd = "FederalReserveRSSDIdentifier";  // string | Input identifiers for the RSSD - Federal Reserve RSSD symbol typ. (optional) 
            var sedol = "B616C79";  // string | Input identifiers for the SEDOL symbol type. (optional) 
            var spr = "562703";  // string | Input identifiers for the Price Ticker symbol type. (optional) 
            var ticker = "PriceTicker";  // string | Input identifiers for the Price Ticker symbol type. (optional) 
            var tickerExchange = "TSLA-NAS";  // string | Input identifiers for the TickerExchange. (optional) 
            var tickerRegion = "TSLA-US";  // string | Input identifiers for the TickerRegion. (optional) 
            var ukch = "UKCompanyHouse";  // string | Input identifiers for the UKCH - UK Company House symbol type. (optional) 
            var valoren = "VALOR";  // string | Input identifiers for the Valoren (\"Valor\") symbol type. (optional) 
            var wkn = "A1CX3T";  // string | Input identifiers for the WKN - German Securities symbol type. (optional) 

            try
            {
                // Get Entity Candidates and Matches for a single name and attributes.
                EntityMatchesResponse result = apiInstance.GetEntityMatch(name, country, state, url, includeEntityType, excludeEntityType, includeEntitySubType, excludeEntitySubType, includeParent, bbgFigi, bbgTicker, bic, cik, crd, cusip, duns, ein, factsetId, fitch, gvkey, gvkeyIid, isin, jcn, lei, lxid, md, redCode, rssd, sedol, spr, ticker, tickerExchange, tickerRegion, ukch, valoren, wkn);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling EntityMatchApi.GetEntityMatch: " + e.Message );
                Console.WriteLine("Status Code: "+ e.ErrorCode);
                Console.WriteLine(e.StackTrace);
            }
        }
    }
}

Using a Proxy

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/content

Documentation for Models

• Model.CreateUniverseRequest
• Model.EntityDecisionsResponse
• Model.EntityMapping
• Model.EntityMappingDeleteRequest
• Model.EntityMappingDeleteResponse
• Model.EntityMappingRequest
• Model.EntityMappingResponse
• Model.EntityMatch
• Model.EntityMatchRequest
• Model.EntityMatchRequestInput
• Model.EntityMatchesResponse
• Model.EntityResponse
• Model.EntityTaskResponse
• Model.EntityTaskStatus
• Model.EntityTaskStatusResponse
• Model.EntityUniverseRequest
• Model.EntityUniverseResponse
• Model.EntityUniverseStatisticsResponse
• Model.ErrorResponse
• Model.ErrorResponseSubErrors
• Model.MapStatus
• Model.PeopleDecisions
• Model.PeopleDecisionsResponse
• Model.PeopleMapping
• Model.PeopleMappingDeleteResponse
• Model.PeopleMappingRequest
• Model.PeopleMappingResponse
• Model.PeopleMatch
• Model.PeopleMatchRequest
• Model.PeopleMatchRequestInput
• Model.PeopleMatchesResponse
• Model.PeopleTask
• Model.PeopleTaskResponse
• Model.PeopleTaskStatus
• Model.PeopleTaskStatusResponse
• Model.PeopleUniverseRequest
• Model.PeopleUniverseResponse
• Model.SnowflakeEntityMappingRequest
• Model.SnowflakeEntityMappingResponse
• Model.SnowflakeEntityMatchRequest
• Model.SnowflakeEntityMatchResponse
• Model.Universe
• Model.UniverseMeta
• Model.UniverseMetaResponse
• Model.UniverseStatistics
• Model.UniverseStatisticsResponse
• Model.UniversesResponse
• Model.UpdateUniverseRequest

Documentation for Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.