Skip to main content

FactSet

Conversational API Powered by FactSet Mercury client library for Python

This package is deprecated and will receive no further updates. The Conversational API Powered by FactSet Mercury has been renamed to Conversational. Use fds.sdk.Conversational instead (pip install fds.sdk.Conversational). The API is unchanged. See BREAKING.md for details.

API Version PyPi Apache-2 license

OVERVIEW

The FactSet Conversational API allows clients to integrate core FactSet Mercury capabilities in chatbot experiences.

The Conversational API is powered by FactSet Mercury, FactSet's Generative Artificial Intelligence (GenAI) large language model. The Conversational API provides a variety of content and capabilities, including FactSet’s Federation layer (FactSet’s core GenAI-based technology), as well as more specific content and functionality tailored for financial services workflows.

The Conversational API provides answers to hundreds of natural language search queries and allows you to easily ask questions related to companies and markets research.

Some example supported prompts:

  • Nintendo's highest closing stock price over the last 3 months
  • Has Yelp issued any guidance?
  • What are the key trends impacting costs for DaVita?

For Information on Access to and Content Available via the Conversational API

Please see the Conversational API Online Assistant Page. Here you can find instructions on how to set up access to the Conversational API, and the full list of content available.

Conversational API Consumer Workflow

The Conversational API is an asynchronous API that utilizes status polling to inform the consumer when a query response is complete. Please see the technical OpenAPI documentation below for specific information regarding consuming the API programmatically.

At a high level, the API consumer workflow is as follows:

  1. Send a natural language query to the /query endpoint and start the response generation process.
  2. Poll the status of the response generation process using the /status endpoint.
  3. Once the status indicates a ready response, retrieve it using the /result endpoint.
  • If your response contains a file ID, such as for an Excel chart or a FactSet ActiveGraph, retrieve it using the file ID at the /download/file endpoint.
  • To provide feedback on your response and help the Conversational API better serve you content, we encourage you to use the /feedback endpoint.

Conversational API Postman Collection

You can use our Postman collection for OpenAPI to help you get started with the Conversational API.

Receive updates on changes to the Conversational API

Subscribe to our FactSet Notify by clicking "Subscribe to notifications" in the upper right above the API overview. You will receive email updates when any updates occur to the API

FAQ & Troubleshooting

Please find FAQs and troubleshooting tips in the FAQs section of the Conversational API OA page

Current Limitations
  • "Natural language" in this documentation refers to modern conversational English. Support for other languages is currently unavailable.
  • The Conversational API is currently limited to accept 10 natural language queries per minute and 200 per hour for an individual consumer. If you anticipate your needs to be greater than these limits, please reach out to FactSet Support.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.1
  • SDK version: 2.0.1
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

  • Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.ConversationalAPIPoweredbyFactSetMercury==2.0.1

pip

pip install fds.sdk.utils fds.sdk.ConversationalAPIPoweredbyFactSetMercury==2.0.1

Usage

  1. Generate authentication credentials.
  2. Setup Python environment.
    1. Install and activate python 3.10+. If you're using pyenv:

      pyenv install 3.10.0
      pyenv shell 3.10.0
      
    2. (optional) Install poetry.

  3. Install dependencies.
  4. Run the following:

Example Code

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.ConversationalAPIPoweredbyFactSetMercury
from fds.sdk.ConversationalAPIPoweredbyFactSetMercury.api import chat_api
from fds.sdk.ConversationalAPIPoweredbyFactSetMercury.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.ConversationalAPIPoweredbyFactSetMercury.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.ConversationalAPIPoweredbyFactSetMercury.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.ConversationalAPIPoweredbyFactSetMercury.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = chat_api.ChatApi(api_client)
    query_chat_request = QueryChatRequest(
        data=QueryChatRequestData(
            query="query_example",
            chat_id="chat_id_example",
        ),
    ) # QueryChatRequest | Request body to the `/query` endpoint, containing the natural language query to be sent to FactSet Mercury and an optional chat ID for continuing an ongoing conversation.

    try:
        # Send a natural language query to FactSet Mercury
        # example passing only required values which don't have defaults set
        api_response = api_instance.send_query(query_chat_request)

        pprint(api_response)
    except fds.sdk.ConversationalAPIPoweredbyFactSetMercury.ApiException as e:
        print("Exception when calling ChatApi->send_query: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Send a natural language query to FactSet Mercury
    #     api_response, http_status_code, response_headers = api_instance.send_query_with_http_info(query_chat_request)


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

    # # Get response asynchronous
    # try:
    #     # Send a natural language query to FactSet Mercury
    #     async_result = api_instance.send_query_async(query_chat_request)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Send a natural language query to FactSet Mercury
    #     async_result = api_instance.send_query_with_http_info_async(query_chat_request)
    #     api_response, http_status_code, response_headers = async_result.get()


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

Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.

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

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

import logging
import fds.sdk.ConversationalAPIPoweredbyFactSetMercury

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.ConversationalAPIPoweredbyFactSetMercury.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).
import fds.sdk.ConversationalAPIPoweredbyFactSetMercury

configuration = fds.sdk.ConversationalAPIPoweredbyFactSetMercury.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.
import fds.sdk.ConversationalAPIPoweredbyFactSetMercury

configuration = fds.sdk.ConversationalAPIPoweredbyFactSetMercury.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.

from urllib3 import Retry
import fds.sdk.ConversationalAPIPoweredbyFactSetMercury

configuration = fds.sdk.ConversationalAPIPoweredbyFactSetMercury.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/conversational/v1

Class Method HTTP request Description
ChatApi get_chat_result POST /result Retrieve the completed response for your query
ChatApi get_chat_status POST /status Retrieve the status of a chat response generation process
ChatApi send_query POST /query Send a natural language query to FactSet Mercury
DownloadApi download_file POST /download/file Retrieve data file based on file ID.
FeedbackApi send_feedback POST /feedback Send feedback on the response to a query.

Documentation For Models

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.ConversationalAPIPoweredbyFactSetMercury.apis and fds.sdk.ConversationalAPIPoweredbyFactSetMercury.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.ConversationalAPIPoweredbyFactSetMercury.api.default_api import DefaultApi
  • from fds.sdk.ConversationalAPIPoweredbyFactSetMercury.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.ConversationalAPIPoweredbyFactSetMercury
from fds.sdk.ConversationalAPIPoweredbyFactSetMercury.apis import *
from fds.sdk.ConversationalAPIPoweredbyFactSetMercury.models import *

Contributing

Please refer to the contributing guide.

Copyright 2026 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.

Metadata

Release files for fds.sdk.ConversationalAPIPoweredbyFactSetMercury 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fds.sdk.ConversationalAPIPoweredbyFactSetMercury 2.0.1
File Size Uploaded Provenance Actions
fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1.tar.gz 81.1 kB Without provenance Details for fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for fds.sdk.ConversationalAPIPoweredbyFactSetMercury 2.0.1
File Interpreter ABI Platform Actions
fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1-py3-none-any.whl Python 3 none any Details for fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1-py3-none-any.whl

Total release size: 339.8 kB

Release files / fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1.tar.gz

Download URL fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1.tar.gz
Size 81.1 kB
Tags Source
SHA-256 checksum
How to use checksums
c9519be7eecf3a01cccb5a860c86a5c3ab55a81ef62d0e04f670383688b7f141
BLAKE2b-256 checksum
How to use checksums
5a18f4d4f2d2c46060f6ff93cb9802af79f8bb45052f537d330b748ea6d28666
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1-py3-none-any.whl

Download URL fds_sdk_conversationalapipoweredbyfactsetmercury-2.0.1-py3-none-any.whl
Size 258.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a3ca35c29508abc52131b67117a3c8409a7c88e1405b4b02e77722f3cd08f944
BLAKE2b-256 checksum
How to use checksums
a0ba75c17b7d2c31ecaca36a4b440e3150641089f8dd7cfb3d06ee5fe223cf8d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for fds.sdk.ConversationalAPIPoweredbyFactSetMercury 2.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page