Skip to content

README.md

Latest commit

 

History

History
182 lines (147 loc) · 11.1 KB

README.md

File metadata and controls

182 lines (147 loc) · 11.1 KB

fds.analyticsapi.engines

Allow clients to fetch Analytics through APIs.

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

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import fds.analyticsapi.engines

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import fds.analyticsapi.engines

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import fds.analyticsapi.engines
from fds.analyticsapi.engines.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.factset.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fds.analyticsapi.engines.Configuration(
    host = "https://api.factset.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = fds.analyticsapi.engines.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Defining host is optional and default to https://api.factset.com
configuration.host = "https://api.factset.com"
# Create an instance of the API class
api_instance = fds.analyticsapi.engines.AccountsApi(fds.analyticsapi.engines.ApiClient(configuration))
path = '' # str | The directory to get the accounts and sub-directories in (default to '')

try:
    # Get accounts and sub-directories in a directory
    api_response = api_instance.get_accounts(path)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->get_accounts: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountsApi get_accounts GET /analytics/lookups/v2/accounts/{path} Get accounts and sub-directories in a directory
CalculationsApi cancel_calculation_by_id DELETE /analytics/engines/v2/calculations/{id} Cancel calculation by id
CalculationsApi get_calculation_status_by_id GET /analytics/engines/v2/calculations/{id} Get calculation status by id
CalculationsApi get_calculation_status_summaries GET /analytics/engines/v2/calculations Get all calculation statuses
CalculationsApi run_calculation POST /analytics/engines/v2/calculations Run calculation
ColumnStatisticsApi get_pa_column_statistics GET /analytics/lookups/v2/engines/pa/columnstatistics Get PA column statistics
ColumnsApi get_pa_column_by_id GET /analytics/lookups/v2/engines/pa/columns/{id} Get PA column settings
ColumnsApi get_pa_columns GET /analytics/lookups/v2/engines/pa/columns Get PA columns
ComponentsApi get_pa_component_by_id GET /analytics/lookups/v2/engines/pa/components/{id} Get PA component by id
ComponentsApi get_pa_components GET /analytics/lookups/v2/engines/pa/components Get PA components
ComponentsApi get_spar_components GET /analytics/lookups/v2/engines/spar/components Get SPAR components
ComponentsApi get_vault_component_by_id GET /analytics/lookups/v2/engines/vault/components/{id} Get Vault component by id
ComponentsApi get_vault_components GET /analytics/lookups/v2/engines/vault/components Get Vault components
ConfigurationsApi get_vault_configuration_by_id GET /analytics/lookups/v2/engines/vault/configurations/{id} Get Vault configuration by id
ConfigurationsApi get_vault_configurations GET /analytics/lookups/v2/engines/vault/configurations Get Vault configurations
CurrenciesApi get_pa_currencies GET /analytics/lookups/v2/engines/pa/currencies Get PA currencies
DatesApi convert_pa_dates_to_absolute_format GET /analytics/lookups/v2/engines/pa/dates Convert PA dates to absolute format
DatesApi convert_vault_dates_to_absolute_format GET /analytics/lookups/v2/engines/vault/dates Convert Vault dates to absolute format
DocumentsApi get_pa3_documents GET /analytics/lookups/v2/engines/pa/documents/{path} Get PA3 documents and sub-directories in a directory
DocumentsApi get_pub_documents GET /analytics/lookups/v2/engines/pub/documents/{path} Gets Publisher documents and sub-directories in a directory
DocumentsApi get_spar3_documents GET /analytics/lookups/v2/engines/spar/documents/{path} Gets SPAR3 documents and sub-directories in a directory
DocumentsApi get_vault_documents GET /analytics/lookups/v2/engines/vault/documents/{path} Get Vault documents and sub-directories in a directory
FrequenciesApi get_pa_frequencies GET /analytics/lookups/v2/engines/pa/frequencies Get PA frequencies
FrequenciesApi get_spar_frequencies GET /analytics/lookups/v2/engines/spar/frequencies Get SPAR frequencies
FrequenciesApi get_vault_frequencies GET /analytics/lookups/v2/engines/vault/frequencies Get Vault frequencies
GroupsApi get_pa_groups GET /analytics/lookups/v2/engines/pa/groups Get PA groups
PACalculationsApi cancel_pa_calculation_by_id DELETE /analytics/engines/pa/v2/calculations/{id} Cancel PA calculation by id
PACalculationsApi get_pa_calculation_by_id GET /analytics/engines/pa/v2/calculations/{id} Get PA calculation by id
PACalculationsApi run_pa_calculation POST /analytics/engines/pa/v2/calculations Run PA Calculation
SPARBenchmarkApi get_spar_benchmark_by_id GET /analytics/lookups/v2/engines/spar/benchmarks Get SPAR benchmark details
SPARCalculationsApi cancel_spar_calculation_by_id DELETE /analytics/engines/spar/v2/calculations/{id} Cancel SPAR calculation
SPARCalculationsApi get_spar_calculation_by_id GET /analytics/engines/spar/v2/calculations/{id} Get SPAR calculation by id
SPARCalculationsApi run_spar_calculation POST /analytics/engines/spar/v2/calculations Run SPAR Calculation
VaultCalculationsApi cancel_vault_calculation_by_id DELETE /analytics/engines/vault/v2/calculations/{id} Cancel Vault calculation by id
VaultCalculationsApi get_vault_calculation_by_id GET /analytics/engines/vault/v2/calculations/{id} Get Vault calculation by id
VaultCalculationsApi run_vault_calculation POST /analytics/engines/vault/v2/calculations Run Vault Calculation
UtilityApi get_by_url GET {url} Get by url

Documentation For Models

Documentation For Authorization

Basic

  • Type: HTTP basic authentication

Author

analytics.api.support@factset.com