fds.sdk.FactSetConcordance


Namefds.sdk.FactSetConcordance JSON
Version 0.24.4 PyPI version JSON
download
home_pagehttps://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2
SummaryFactSet Concordance client library for Python
upload_time2024-05-02 12:42:14
maintainerNone
docs_urlNone
authorFactSet Research Systems
requires_python>=3.7
licenseApache License, Version 2.0
keywords factset api sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)

# FactSet Concordance client library for Python

[![API Version](https://img.shields.io/badge/api-v2.8.0-blue)]()
[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetConcordance)](https://pypi.org/project/fds.sdk.FactSetConcordance/)
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)



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>
 


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.8.0
- SDK version: 0.24.4
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements

* Python >= 3.7

## Installation

### Poetry

```shell
poetry add fds.sdk.utils fds.sdk.FactSetConcordance==0.24.4
```

### pip

```shell
pip install fds.sdk.utils fds.sdk.FactSetConcordance==0.24.4
```

## Usage

1. [Generate authentication credentials](../../../../README.md#authentication).
2. Setup Python environment.
   1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):

      ```sh
      pyenv install 3.9.7
      pyenv shell 3.9.7
      ```

   2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
3. [Install dependencies](#installation).
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

```python
from fds.sdk.utils.authentication import ConfidentialClient

import fds.sdk.FactSetConcordance
from fds.sdk.FactSetConcordance.api import entity_match_api
from fds.sdk.FactSetConcordance.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.

# 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-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.FactSetConcordance.Configuration(
    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
)

# Basic authentication: FactSetApiKey
# See https://github.com/FactSet/enterprise-sdk#api-key
# for information how to create an API key
# configuration = fds.sdk.FactSetConcordance.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.FactSetConcordance.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = entity_match_api.EntityMatchApi(api_client)
    name = "FactSet" # str | Name of Entity to match.
    country = "US" # str | 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)
    state = "CT" # str | 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)
    url = "url_example" # str | URL corresponding to the entity name that is used when evaluating candidates for a match. (optional)
    include_entity_type = [
        "PUB",
    ] # [str] | 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)
    exclude_entity_type = [
        "EXT",
    ] # [str] | 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)
    include_entity_sub_type = [
        "PR",
    ] # [str] | 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)
    exclude_entity_sub_type = [
        "HF",
    ] # [str] | 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)
    include_parent = False # bool | Flag to include parent entities in the list of candidates. This parameter does not influence the match result. (optional) if omitted the server will use the default value of False
    bbg_figi = "BBG009S39JY5" # str | Input identifiers for the Bloomberg Listing/Regional/Security ID symbol type. (optional)
    bbg_ticker = "BloombergId" # str | Input identifiers for the Bloomberg Listing and Regional Ticker symbol Type. (optional)
    bic = "BICCode" # str | Input identifiers for the BICCode - Bank Indentification Code symbol Type. (optional)
    cik = "CIK" # str | Input identifiers for the CIK - Edgar Central Index Keys symbol type. (optional)
    crd = "CRD" # str | Input identifiers for the CRD - Central Registration Depository symbol type. (optional)
    cusip = "CUSIP" # str | Input identifiers for the CUSIP symbol type. (optional)
    duns = "Dun&Bradstreet" # str | Input identifiers for the DUNS - Dun & Bradstreet Data Universal Numbering System symbol type. (optional)
    ein = "EmployerIdentificationNumber" # str | Input identifiers for the EIN - Employer Identification Number symbol type. (optional)
    factset_id = "FactSetIdentifier" # str | Input identifiers for the type FactSet Identifier - FactSet -E,-S,-R, -L Permanent Identifier symbol type. (optional)
    fitch = "FitchCreditRating" # str | Input identifiers for the Fitch - Fitch Ratings symbol type. (optional)
    gvkey = "GVKey" # str | Input identifiers for the type GVKEY - Compustat Global Company Key symbol type. (optional)
    gvkey_iid = "GVKeyIssueIdentifier" # str | Input identifiers for the type GVKEY+IID - Compustat Global Company Key and Issue Identifier symbol type. (optional)
    isin = "ISIN" # str | Input identifiers for the ISIN - International Securities Identification Number symbol type. (optional)
    jcn = "JCN" # str | Input identifiers for the type JCN - Japanese Corporate Number symbol type. (optional)
    lei = "LegalEntityIdentifier" # str | Input identifiers for the LEI - Legal Entity Identifier symbol type (optional)
    lxid = "LXID" # str | Input identifiers for the type LXID - Markit Syndicated Loan Identifier symbol type. (optional)
    md = "MoodysIssuer" # str | Input identifiers for the Moody's Ratings Identifier type. (optional)
    red_code = "RedCode" # str | Input identifiers for the type Red Code - Markit Reference Entity Identifier symbol type. (optional)
    rssd = "FederalReserveRSSDIdentifier" # str | Input identifiers for the RSSD - Federal Reserve RSSD symbol typ. (optional)
    sedol = "SEDOL" # str | Input identifiers for the SEDOL symbol type. (optional)
    spr = "SPRating" # str | Input identifiers for the Price Ticker symbol type. (optional)
    ticker = "PriceTicker" # str | Input identifiers for the Price Ticker symbol type. (optional)
    ticker_exchange = "TickerExch" # str | Input identifiers for the TickerExchange. (optional)
    ticker_region = "TickerRegion" # str | Input identifiers for the TickerRegion. (optional)
    ukch = "UKCompanyHouse" # str | Input identifiers for the UKCH - UK Company House symbol type. (optional)
    valoren = "VALOR" # str | Input identifiers for the Valoren (\"Valor\") symbol type. (optional)
    wkn = "WKN" # str | Input identifiers for the WKN - German Securities symbol type. (optional)

    try:
        # Get Entity Candidates and Matches for a single name and attributes.
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.get_entity_match(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)

        pprint(api_response)
    except fds.sdk.FactSetConcordance.ApiException as e:
        print("Exception when calling EntityMatchApi->get_entity_match: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Get Entity Candidates and Matches for a single name and attributes.
    #     api_response, http_status_code, response_headers = api_instance.get_entity_match_with_http_info(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetConcordance.ApiException as e:
    #     print("Exception when calling EntityMatchApi->get_entity_match: %s\n" % e)

    # # Get response asynchronous
    # try:
    #     # Get Entity Candidates and Matches for a single name and attributes.
    #     async_result = api_instance.get_entity_match_async(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)
    #     api_response = async_result.get()


    #     pprint(api_response)
    # except fds.sdk.FactSetConcordance.ApiException as e:
    #     print("Exception when calling EntityMatchApi->get_entity_match: %s\n" % e)

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Get Entity Candidates and Matches for a single name and attributes.
    #     async_result = api_instance.get_entity_match_with_http_info_async(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetConcordance.ApiException as e:
    #     print("Exception when calling EntityMatchApi->get_entity_match: %s\n" % e)

```

### Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.
```python
import pandas as pd

response_dict = api_response.to_dict()['data']

simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)
```

### Debugging

The SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.

Setting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`
and enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).

**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.

```python
import logging
import fds.sdk.FactSetConcordance

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.FactSetConcordance.Configuration(...)
configuration.debug = True
```

### Configure a Proxy

You can pass proxy settings to the Configuration class:

* `proxy`: The URL of the proxy to use.
* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).

```python
import fds.sdk.FactSetConcordance

configuration = fds.sdk.FactSetConcordance.Configuration(
    # ...
    proxy="http://secret:password@localhost:5050",
    proxy_headers={
        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
    }
)
```

### Custom SSL Certificate

TLS/SSL certificate verification can be configured with the following Configuration parameters:

* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.
* `verify_ssl`: setting this to `False` disables the verification of certificates.
  Disabling the verification is not recommended, but it might be useful during
  local development or testing.

```python
import fds.sdk.FactSetConcordance

configuration = fds.sdk.FactSetConcordance.Configuration(
    # ...
    ssl_ca_cert='/path/to/ca.pem'
)
```

### Request Retries

In case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.

```python
from urllib3 import Retry
import fds.sdk.FactSetConcordance

configuration = fds.sdk.FactSetConcordance.Configuration(
    # ...
)

configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])
```


## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*EntityMatchApi* | [**get_entity_match**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchApi.md#get_entity_match) | **GET** /factset-concordance/v2/entity-match | Get Entity Candidates and Matches for a single name and attributes.
*EntityMatchApi* | [**get_entity_match_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchApi.md#get_entity_match_for_list) | **POST** /factset-concordance/v2/entity-match | Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes.
*EntityMatchBulkApi* | [**get_entity_decisions**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchBulkApi.md#get_entity_decisions) | **GET** /factset-concordance/v2/entity-decisions | Get the decisions of matches for the requested taskId.
*EntityMatchBulkApi* | [**get_entity_task_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchBulkApi.md#get_entity_task_for_list) | **POST** /factset-concordance/v2/entity-task | Input a file with names and attributes, creating a taskId.
*EntityMatchBulkApi* | [**get_entity_task_status**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchBulkApi.md#get_entity_task_status) | **GET** /factset-concordance/v2/entity-task-status | Gets the status of the requested taskId or all tasks for a User
*MappingsApi* | [**get_entity_mapping_delete_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_mapping_delete_for_list) | **POST** /factset-concordance/v2/entity-mapping-delete | Deletes mapping specified by the client.
*MappingsApi* | [**get_entity_mapping_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_mapping_for_list) | **POST** /factset-concordance/v2/entity-mapping | Saves a single-mapping specified by the client.
*MappingsApi* | [**get_entity_universe**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_universe) | **GET** /factset-concordance/v2/entity-universe | Retrieve all saved mappings within a requested universe
*MappingsApi* | [**get_entity_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_universe_for_list) | **POST** /factset-concordance/v2/entity-universe | Retrieve all saved mappings within a requested universe or large list of client ids
*PeopleMappingApi* | [**get_people_mapping_delete_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_mapping_delete_for_list) | **POST** /factset-concordance/v2/people-mapping-delete | Deletes mapping specified by the client.
*PeopleMappingApi* | [**get_people_mapping_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_mapping_for_list) | **POST** /factset-concordance/v2/people-mapping | Saves a single-mapping specified by the client.
*PeopleMappingApi* | [**get_people_universe**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_universe) | **GET** /factset-concordance/v2/people-universe | Retrieve all saved mappings within a requested universe
*PeopleMappingApi* | [**get_people_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_universe_for_list) | **POST** /factset-concordance/v2/people-universe | Retrieve all saved mappings within a requested universe or large list of client ids
*PeopleMatchApi* | [**get_people_match**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchApi.md#get_people_match) | **GET** /factset-concordance/v2/people-match | Find potential people matches given a person&#39;s name.People matches can be retrieved using person&#39;s name and other attributes like firstname, middlename and lastname.
*PeopleMatchApi* | [**get_people_match_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchApi.md#get_people_match_for_list) | **POST** /factset-concordance/v2/people-match | Find potential people matches given a person&#39;s name.
*PeopleMatchBulkApi* | [**get_people_decisions**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchBulkApi.md#get_people_decisions) | **GET** /factset-concordance/v2/people-decisions | Get the decisions of matches for the requested taskId.
*PeopleMatchBulkApi* | [**get_people_task_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchBulkApi.md#get_people_task_for_list) | **POST** /factset-concordance/v2/people-task | Create a People Concordance Task.
*PeopleMatchBulkApi* | [**get_people_task_status**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchBulkApi.md#get_people_task_status) | **GET** /factset-concordance/v2/people-task-status | Get the Status of the People Tasks.
*SnowflakeApi* | [**get_snowflake_entity_match_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeApi.md#get_snowflake_entity_match_for_list) | **POST** /factset-concordance/v2/snowflake-entity-match | Perform an entity search and return a snowflake-friendly response. Up to 25 Names per request.
*SnowflakeApi* | [**snowflake_entity_mapping_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeApi.md#snowflake_entity_mapping_post) | **POST** /factset-concordance/v2/snowflake-entity-mapping | Save entity mappings to a universe
*UniversesApi* | [**get_entity_universe_statistics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_entity_universe_statistics) | **GET** /factset-concordance/v2/entity-universe-statistics | Get statistics on a given universe
*UniversesApi* | [**get_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_universe_for_list) | **POST** /factset-concordance/v2/universe | Create a new universe
*UniversesApi* | [**get_universe_statistics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_universe_statistics) | **GET** /factset-concordance/v2/universe-statistics | Get statistics on a given universe
*UniversesApi* | [**get_universes**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_universes) | **GET** /factset-concordance/v2/universes | Fetch metadata for universes
*UniversesApi* | [**get_update_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_update_universe_for_list) | **POST** /factset-concordance/v2/update-universe | Update metadata for an existing universe


## Documentation For Models

 - [CreateUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/CreateUniverseRequest.md)
 - [EntityDecisionsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityDecisionsResponse.md)
 - [EntityMapping](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMapping.md)
 - [EntityMappingDeleteRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingDeleteRequest.md)
 - [EntityMappingDeleteResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingDeleteResponse.md)
 - [EntityMappingRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingRequest.md)
 - [EntityMappingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingResponse.md)
 - [EntityMatch](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatch.md)
 - [EntityMatchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchRequest.md)
 - [EntityMatchRequestInput](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchRequestInput.md)
 - [EntityMatchesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchesResponse.md)
 - [EntityResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityResponse.md)
 - [EntityTaskResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityTaskResponse.md)
 - [EntityTaskStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityTaskStatus.md)
 - [EntityTaskStatusResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityTaskStatusResponse.md)
 - [EntityUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityUniverseRequest.md)
 - [EntityUniverseResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityUniverseResponse.md)
 - [EntityUniverseStatisticsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityUniverseStatisticsResponse.md)
 - [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/ErrorResponse.md)
 - [ErrorResponseSubErrors](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/ErrorResponseSubErrors.md)
 - [MapStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MapStatus.md)
 - [PeopleDecisions](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleDecisions.md)
 - [PeopleDecisionsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleDecisionsResponse.md)
 - [PeopleMapping](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMapping.md)
 - [PeopleMappingDeleteResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingDeleteResponse.md)
 - [PeopleMappingRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingRequest.md)
 - [PeopleMappingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingResponse.md)
 - [PeopleMatch](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatch.md)
 - [PeopleMatchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchRequest.md)
 - [PeopleMatchRequestInput](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchRequestInput.md)
 - [PeopleMatchesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchesResponse.md)
 - [PeopleTask](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTask.md)
 - [PeopleTaskResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTaskResponse.md)
 - [PeopleTaskStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTaskStatus.md)
 - [PeopleTaskStatusResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTaskStatusResponse.md)
 - [PeopleUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleUniverseRequest.md)
 - [PeopleUniverseResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleUniverseResponse.md)
 - [SnowflakeEntityMappingRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMappingRequest.md)
 - [SnowflakeEntityMappingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMappingResponse.md)
 - [SnowflakeEntityMatchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMatchRequest.md)
 - [SnowflakeEntityMatchResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMatchResponse.md)
 - [Universe](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/Universe.md)
 - [UniverseMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseMeta.md)
 - [UniverseMetaResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseMetaResponse.md)
 - [UniverseStatistics](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseStatistics.md)
 - [UniverseStatisticsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseStatisticsResponse.md)
 - [UniversesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesResponse.md)
 - [UpdateUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UpdateUniverseRequest.md)


## Documentation For Authorization


## FactSetApiKey

- **Type**: HTTP basic authentication


## FactSetOAuth2

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: N/A


## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in fds.sdk.FactSetConcordance.apis and fds.sdk.FactSetConcordance.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1:
Use specific imports for apis and models like:
- `from fds.sdk.FactSetConcordance.api.default_api import DefaultApi`
- `from fds.sdk.FactSetConcordance.model.pet import Pet`

Solution 2:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import fds.sdk.FactSetConcordance
from fds.sdk.FactSetConcordance.apis import *
from fds.sdk.FactSetConcordance.models import *
```

## Contributing

Please refer to the [contributing guide](../../../../CONTRIBUTING.md).

## 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.




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2",
    "name": "fds.sdk.FactSetConcordance",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "FactSet, API, SDK",
    "author": "FactSet Research Systems",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "[![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)\n\n# FactSet Concordance client library for Python\n\n[![API Version](https://img.shields.io/badge/api-v2.8.0-blue)]()\n[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetConcordance)](https://pypi.org/project/fds.sdk.FactSetConcordance/)\n[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n\n\n\nThe 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>  \n\n Using the submitted attributes, the FactSet Concordance API leverages FactSet\u2019s 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>\n \n <b>There are two types of workflows supported in the API:</b>\n \n <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.\n \n <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.\n \n 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>\n \n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 2.8.0\n- SDK version: 0.24.4\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements\n\n* Python >= 3.7\n\n## Installation\n\n### Poetry\n\n```shell\npoetry add fds.sdk.utils fds.sdk.FactSetConcordance==0.24.4\n```\n\n### pip\n\n```shell\npip install fds.sdk.utils fds.sdk.FactSetConcordance==0.24.4\n```\n\n## Usage\n\n1. [Generate authentication credentials](../../../../README.md#authentication).\n2. Setup Python environment.\n   1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):\n\n      ```sh\n      pyenv install 3.9.7\n      pyenv shell 3.9.7\n      ```\n\n   2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).\n3. [Install dependencies](#installation).\n4. Run the following:\n\n> [!IMPORTANT]\n> The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.\n\n### Example Code\n\n```python\nfrom fds.sdk.utils.authentication import ConfidentialClient\n\nimport fds.sdk.FactSetConcordance\nfrom fds.sdk.FactSetConcordance.api import entity_match_api\nfrom fds.sdk.FactSetConcordance.models import *\nfrom dateutil.parser import parse as dateutil_parser\nfrom pprint import pprint\n\n# See configuration.py for a list of all supported configuration parameters.\n\n# Examples for each supported authentication method are below,\n# choose one that satisfies your use case.\n\n# (Preferred) OAuth 2.0: FactSetOAuth2\n# See https://github.com/FactSet/enterprise-sdk#oauth-20\n# for information on how to create the app-config.json file\n#\n# The confidential client instance should be reused in production environments.\n# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication\n# for more information on using the ConfidentialClient class\nconfiguration = fds.sdk.FactSetConcordance.Configuration(\n    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')\n)\n\n# Basic authentication: FactSetApiKey\n# See https://github.com/FactSet/enterprise-sdk#api-key\n# for information how to create an API key\n# configuration = fds.sdk.FactSetConcordance.Configuration(\n#     username='USERNAME-SERIAL',\n#     password='API-KEY'\n# )\n\n# Enter a context with an instance of the API client\nwith fds.sdk.FactSetConcordance.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = entity_match_api.EntityMatchApi(api_client)\n    name = \"FactSet\" # str | Name of Entity to match.\n    country = \"US\" # str | 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)\n    state = \"CT\" # str | 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)\n    url = \"url_example\" # str | URL corresponding to the entity name that is used when evaluating candidates for a match. (optional)\n    include_entity_type = [\n        \"PUB\",\n    ] # [str] | 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)\n    exclude_entity_type = [\n        \"EXT\",\n    ] # [str] | 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)\n    include_entity_sub_type = [\n        \"PR\",\n    ] # [str] | 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)\n    exclude_entity_sub_type = [\n        \"HF\",\n    ] # [str] | 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)\n    include_parent = False # bool | Flag to include parent entities in the list of candidates. This parameter does not influence the match result. (optional) if omitted the server will use the default value of False\n    bbg_figi = \"BBG009S39JY5\" # str | Input identifiers for the Bloomberg Listing/Regional/Security ID symbol type. (optional)\n    bbg_ticker = \"BloombergId\" # str | Input identifiers for the Bloomberg Listing and Regional Ticker symbol Type. (optional)\n    bic = \"BICCode\" # str | Input identifiers for the BICCode - Bank Indentification Code symbol Type. (optional)\n    cik = \"CIK\" # str | Input identifiers for the CIK - Edgar Central Index Keys symbol type. (optional)\n    crd = \"CRD\" # str | Input identifiers for the CRD - Central Registration Depository symbol type. (optional)\n    cusip = \"CUSIP\" # str | Input identifiers for the CUSIP symbol type. (optional)\n    duns = \"Dun&Bradstreet\" # str | Input identifiers for the DUNS - Dun & Bradstreet Data Universal Numbering System symbol type. (optional)\n    ein = \"EmployerIdentificationNumber\" # str | Input identifiers for the EIN - Employer Identification Number symbol type. (optional)\n    factset_id = \"FactSetIdentifier\" # str | Input identifiers for the type FactSet Identifier - FactSet -E,-S,-R, -L Permanent Identifier symbol type. (optional)\n    fitch = \"FitchCreditRating\" # str | Input identifiers for the Fitch - Fitch Ratings symbol type. (optional)\n    gvkey = \"GVKey\" # str | Input identifiers for the type GVKEY - Compustat Global Company Key symbol type. (optional)\n    gvkey_iid = \"GVKeyIssueIdentifier\" # str | Input identifiers for the type GVKEY+IID - Compustat Global Company Key and Issue Identifier symbol type. (optional)\n    isin = \"ISIN\" # str | Input identifiers for the ISIN - International Securities Identification Number symbol type. (optional)\n    jcn = \"JCN\" # str | Input identifiers for the type JCN - Japanese Corporate Number symbol type. (optional)\n    lei = \"LegalEntityIdentifier\" # str | Input identifiers for the LEI - Legal Entity Identifier symbol type (optional)\n    lxid = \"LXID\" # str | Input identifiers for the type LXID - Markit Syndicated Loan Identifier symbol type. (optional)\n    md = \"MoodysIssuer\" # str | Input identifiers for the Moody's Ratings Identifier type. (optional)\n    red_code = \"RedCode\" # str | Input identifiers for the type Red Code - Markit Reference Entity Identifier symbol type. (optional)\n    rssd = \"FederalReserveRSSDIdentifier\" # str | Input identifiers for the RSSD - Federal Reserve RSSD symbol typ. (optional)\n    sedol = \"SEDOL\" # str | Input identifiers for the SEDOL symbol type. (optional)\n    spr = \"SPRating\" # str | Input identifiers for the Price Ticker symbol type. (optional)\n    ticker = \"PriceTicker\" # str | Input identifiers for the Price Ticker symbol type. (optional)\n    ticker_exchange = \"TickerExch\" # str | Input identifiers for the TickerExchange. (optional)\n    ticker_region = \"TickerRegion\" # str | Input identifiers for the TickerRegion. (optional)\n    ukch = \"UKCompanyHouse\" # str | Input identifiers for the UKCH - UK Company House symbol type. (optional)\n    valoren = \"VALOR\" # str | Input identifiers for the Valoren (\\\"Valor\\\") symbol type. (optional)\n    wkn = \"WKN\" # str | Input identifiers for the WKN - German Securities symbol type. (optional)\n\n    try:\n        # Get Entity Candidates and Matches for a single name and attributes.\n        # example passing only required values which don't have defaults set\n        # and optional values\n        api_response = api_instance.get_entity_match(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)\n\n        pprint(api_response)\n    except fds.sdk.FactSetConcordance.ApiException as e:\n        print(\"Exception when calling EntityMatchApi->get_entity_match: %s\\n\" % e)\n\n    # # Get response, http status code and response headers\n    # try:\n    #     # Get Entity Candidates and Matches for a single name and attributes.\n    #     api_response, http_status_code, response_headers = api_instance.get_entity_match_with_http_info(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)\n\n\n    #     pprint(api_response)\n    #     pprint(http_status_code)\n    #     pprint(response_headers)\n    # except fds.sdk.FactSetConcordance.ApiException as e:\n    #     print(\"Exception when calling EntityMatchApi->get_entity_match: %s\\n\" % e)\n\n    # # Get response asynchronous\n    # try:\n    #     # Get Entity Candidates and Matches for a single name and attributes.\n    #     async_result = api_instance.get_entity_match_async(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)\n    #     api_response = async_result.get()\n\n\n    #     pprint(api_response)\n    # except fds.sdk.FactSetConcordance.ApiException as e:\n    #     print(\"Exception when calling EntityMatchApi->get_entity_match: %s\\n\" % e)\n\n    # # Get response, http status code and response headers asynchronous\n    # try:\n    #     # Get Entity Candidates and Matches for a single name and attributes.\n    #     async_result = api_instance.get_entity_match_with_http_info_async(name, country=country, state=state, url=url, include_entity_type=include_entity_type, exclude_entity_type=exclude_entity_type, include_entity_sub_type=include_entity_sub_type, exclude_entity_sub_type=exclude_entity_sub_type, include_parent=include_parent, bbg_figi=bbg_figi, bbg_ticker=bbg_ticker, bic=bic, cik=cik, crd=crd, cusip=cusip, duns=duns, ein=ein, factset_id=factset_id, fitch=fitch, gvkey=gvkey, gvkey_iid=gvkey_iid, isin=isin, jcn=jcn, lei=lei, lxid=lxid, md=md, red_code=red_code, rssd=rssd, sedol=sedol, spr=spr, ticker=ticker, ticker_exchange=ticker_exchange, ticker_region=ticker_region, ukch=ukch, valoren=valoren, wkn=wkn)\n    #     api_response, http_status_code, response_headers = async_result.get()\n\n\n    #     pprint(api_response)\n    #     pprint(http_status_code)\n    #     pprint(response_headers)\n    # except fds.sdk.FactSetConcordance.ApiException as e:\n    #     print(\"Exception when calling EntityMatchApi->get_entity_match: %s\\n\" % e)\n\n```\n\n### Using Pandas\n\nTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.\n```python\nimport pandas as pd\n\nresponse_dict = api_response.to_dict()['data']\n\nsimple_json_response = pd.DataFrame(response_dict)\nnested_json_response = pd.json_normalize(response_dict)\n```\n\n### Debugging\n\nThe SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.\n\nSetting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`\nand enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).\n\n**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.\n\n```python\nimport logging\nimport fds.sdk.FactSetConcordance\n\nlogging.basicConfig(level=logging.DEBUG)\n\nconfiguration = fds.sdk.FactSetConcordance.Configuration(...)\nconfiguration.debug = True\n```\n\n### Configure a Proxy\n\nYou can pass proxy settings to the Configuration class:\n\n* `proxy`: The URL of the proxy to use.\n* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).\n\n```python\nimport fds.sdk.FactSetConcordance\n\nconfiguration = fds.sdk.FactSetConcordance.Configuration(\n    # ...\n    proxy=\"http://secret:password@localhost:5050\",\n    proxy_headers={\n        \"Custom-Proxy-Header\": \"Custom-Proxy-Header-Value\"\n    }\n)\n```\n\n### Custom SSL Certificate\n\nTLS/SSL certificate verification can be configured with the following Configuration parameters:\n\n* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.\n* `verify_ssl`: setting this to `False` disables the verification of certificates.\n  Disabling the verification is not recommended, but it might be useful during\n  local development or testing.\n\n```python\nimport fds.sdk.FactSetConcordance\n\nconfiguration = fds.sdk.FactSetConcordance.Configuration(\n    # ...\n    ssl_ca_cert='/path/to/ca.pem'\n)\n```\n\n### Request Retries\n\nIn case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.\n\n```python\nfrom urllib3 import Retry\nimport fds.sdk.FactSetConcordance\n\nconfiguration = fds.sdk.FactSetConcordance.Configuration(\n    # ...\n)\n\nconfiguration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])\n```\n\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.factset.com/content*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*EntityMatchApi* | [**get_entity_match**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchApi.md#get_entity_match) | **GET** /factset-concordance/v2/entity-match | Get Entity Candidates and Matches for a single name and attributes.\n*EntityMatchApi* | [**get_entity_match_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchApi.md#get_entity_match_for_list) | **POST** /factset-concordance/v2/entity-match | Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes.\n*EntityMatchBulkApi* | [**get_entity_decisions**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchBulkApi.md#get_entity_decisions) | **GET** /factset-concordance/v2/entity-decisions | Get the decisions of matches for the requested taskId.\n*EntityMatchBulkApi* | [**get_entity_task_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchBulkApi.md#get_entity_task_for_list) | **POST** /factset-concordance/v2/entity-task | Input a file with names and attributes, creating a taskId.\n*EntityMatchBulkApi* | [**get_entity_task_status**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchBulkApi.md#get_entity_task_status) | **GET** /factset-concordance/v2/entity-task-status | Gets the status of the requested taskId or all tasks for a User\n*MappingsApi* | [**get_entity_mapping_delete_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_mapping_delete_for_list) | **POST** /factset-concordance/v2/entity-mapping-delete | Deletes mapping specified by the client.\n*MappingsApi* | [**get_entity_mapping_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_mapping_for_list) | **POST** /factset-concordance/v2/entity-mapping | Saves a single-mapping specified by the client.\n*MappingsApi* | [**get_entity_universe**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_universe) | **GET** /factset-concordance/v2/entity-universe | Retrieve all saved mappings within a requested universe\n*MappingsApi* | [**get_entity_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MappingsApi.md#get_entity_universe_for_list) | **POST** /factset-concordance/v2/entity-universe | Retrieve all saved mappings within a requested universe or large list of client ids\n*PeopleMappingApi* | [**get_people_mapping_delete_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_mapping_delete_for_list) | **POST** /factset-concordance/v2/people-mapping-delete | Deletes mapping specified by the client.\n*PeopleMappingApi* | [**get_people_mapping_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_mapping_for_list) | **POST** /factset-concordance/v2/people-mapping | Saves a single-mapping specified by the client.\n*PeopleMappingApi* | [**get_people_universe**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_universe) | **GET** /factset-concordance/v2/people-universe | Retrieve all saved mappings within a requested universe\n*PeopleMappingApi* | [**get_people_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingApi.md#get_people_universe_for_list) | **POST** /factset-concordance/v2/people-universe | Retrieve all saved mappings within a requested universe or large list of client ids\n*PeopleMatchApi* | [**get_people_match**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchApi.md#get_people_match) | **GET** /factset-concordance/v2/people-match | Find potential people matches given a person&#39;s name.People matches can be retrieved using person&#39;s name and other attributes like firstname, middlename and lastname.\n*PeopleMatchApi* | [**get_people_match_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchApi.md#get_people_match_for_list) | **POST** /factset-concordance/v2/people-match | Find potential people matches given a person&#39;s name.\n*PeopleMatchBulkApi* | [**get_people_decisions**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchBulkApi.md#get_people_decisions) | **GET** /factset-concordance/v2/people-decisions | Get the decisions of matches for the requested taskId.\n*PeopleMatchBulkApi* | [**get_people_task_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchBulkApi.md#get_people_task_for_list) | **POST** /factset-concordance/v2/people-task | Create a People Concordance Task.\n*PeopleMatchBulkApi* | [**get_people_task_status**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchBulkApi.md#get_people_task_status) | **GET** /factset-concordance/v2/people-task-status | Get the Status of the People Tasks.\n*SnowflakeApi* | [**get_snowflake_entity_match_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeApi.md#get_snowflake_entity_match_for_list) | **POST** /factset-concordance/v2/snowflake-entity-match | Perform an entity search and return a snowflake-friendly response. Up to 25 Names per request.\n*SnowflakeApi* | [**snowflake_entity_mapping_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeApi.md#snowflake_entity_mapping_post) | **POST** /factset-concordance/v2/snowflake-entity-mapping | Save entity mappings to a universe\n*UniversesApi* | [**get_entity_universe_statistics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_entity_universe_statistics) | **GET** /factset-concordance/v2/entity-universe-statistics | Get statistics on a given universe\n*UniversesApi* | [**get_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_universe_for_list) | **POST** /factset-concordance/v2/universe | Create a new universe\n*UniversesApi* | [**get_universe_statistics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_universe_statistics) | **GET** /factset-concordance/v2/universe-statistics | Get statistics on a given universe\n*UniversesApi* | [**get_universes**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_universes) | **GET** /factset-concordance/v2/universes | Fetch metadata for universes\n*UniversesApi* | [**get_update_universe_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesApi.md#get_update_universe_for_list) | **POST** /factset-concordance/v2/update-universe | Update metadata for an existing universe\n\n\n## Documentation For Models\n\n - [CreateUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/CreateUniverseRequest.md)\n - [EntityDecisionsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityDecisionsResponse.md)\n - [EntityMapping](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMapping.md)\n - [EntityMappingDeleteRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingDeleteRequest.md)\n - [EntityMappingDeleteResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingDeleteResponse.md)\n - [EntityMappingRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingRequest.md)\n - [EntityMappingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMappingResponse.md)\n - [EntityMatch](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatch.md)\n - [EntityMatchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchRequest.md)\n - [EntityMatchRequestInput](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchRequestInput.md)\n - [EntityMatchesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityMatchesResponse.md)\n - [EntityResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityResponse.md)\n - [EntityTaskResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityTaskResponse.md)\n - [EntityTaskStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityTaskStatus.md)\n - [EntityTaskStatusResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityTaskStatusResponse.md)\n - [EntityUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityUniverseRequest.md)\n - [EntityUniverseResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityUniverseResponse.md)\n - [EntityUniverseStatisticsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/EntityUniverseStatisticsResponse.md)\n - [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/ErrorResponse.md)\n - [ErrorResponseSubErrors](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/ErrorResponseSubErrors.md)\n - [MapStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/MapStatus.md)\n - [PeopleDecisions](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleDecisions.md)\n - [PeopleDecisionsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleDecisionsResponse.md)\n - [PeopleMapping](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMapping.md)\n - [PeopleMappingDeleteResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingDeleteResponse.md)\n - [PeopleMappingRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingRequest.md)\n - [PeopleMappingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMappingResponse.md)\n - [PeopleMatch](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatch.md)\n - [PeopleMatchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchRequest.md)\n - [PeopleMatchRequestInput](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchRequestInput.md)\n - [PeopleMatchesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleMatchesResponse.md)\n - [PeopleTask](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTask.md)\n - [PeopleTaskResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTaskResponse.md)\n - [PeopleTaskStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTaskStatus.md)\n - [PeopleTaskStatusResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleTaskStatusResponse.md)\n - [PeopleUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleUniverseRequest.md)\n - [PeopleUniverseResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/PeopleUniverseResponse.md)\n - [SnowflakeEntityMappingRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMappingRequest.md)\n - [SnowflakeEntityMappingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMappingResponse.md)\n - [SnowflakeEntityMatchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMatchRequest.md)\n - [SnowflakeEntityMatchResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/SnowflakeEntityMatchResponse.md)\n - [Universe](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/Universe.md)\n - [UniverseMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseMeta.md)\n - [UniverseMetaResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseMetaResponse.md)\n - [UniverseStatistics](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseStatistics.md)\n - [UniverseStatisticsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniverseStatisticsResponse.md)\n - [UniversesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UniversesResponse.md)\n - [UpdateUniverseRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2/docs/UpdateUniverseRequest.md)\n\n\n## Documentation For Authorization\n\n\n## FactSetApiKey\n\n- **Type**: HTTP basic authentication\n\n\n## FactSetOAuth2\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: N/A\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in fds.sdk.FactSetConcordance.apis and fds.sdk.FactSetConcordance.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from fds.sdk.FactSetConcordance.api.default_api import DefaultApi`\n- `from fds.sdk.FactSetConcordance.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport fds.sdk.FactSetConcordance\nfrom fds.sdk.FactSetConcordance.apis import *\nfrom fds.sdk.FactSetConcordance.models import *\n```\n\n## Contributing\n\nPlease refer to the [contributing guide](../../../../CONTRIBUTING.md).\n\n## Copyright\n\nCopyright 2022 FactSet Research Systems Inc\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "FactSet Concordance client library for Python",
    "version": "0.24.4",
    "project_urls": {
        "Homepage": "https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetConcordance/v2"
    },
    "split_keywords": [
        "factset",
        " api",
        " sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e53ffe39b02d1e36eaebeb5f5910d4f9983997c67e327b33622b4d4bfafe8ab",
                "md5": "32bb3992b299f22b20e665856fcdcaed",
                "sha256": "fda543349478430a7b621e31f2a3229fc26db98ec6954744aade54797a5519e7"
            },
            "downloads": -1,
            "filename": "fds.sdk.FactSetConcordance-0.24.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "32bb3992b299f22b20e665856fcdcaed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 276227,
            "upload_time": "2024-05-02T12:42:14",
            "upload_time_iso_8601": "2024-05-02T12:42:14.104056Z",
            "url": "https://files.pythonhosted.org/packages/6e/53/ffe39b02d1e36eaebeb5f5910d4f9983997c67e327b33622b4d4bfafe8ab/fds.sdk.FactSetConcordance-0.24.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-02 12:42:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "FactSet",
    "github_project": "enterprise-sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "fds.sdk.factsetconcordance"
}
        
Elapsed time: 0.33897s