All URIs are relative to https://api.factset.com
| Method | HTTP request | Description |
|---|---|---|
| get_pa_column_by_id | GET /analytics/lookups/v2/engines/pa/columns/{id} | Get PA column settings |
| get_pa_columns | GET /analytics/lookups/v2/engines/pa/columns | Get PA columns |
Column get_pa_column_by_id(id)
Get PA column settings
This endpoint returns the default settings of a PA column.
- Basic Authentication (Basic):
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'
)
# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = fds.analyticsapi.engines.ColumnsApi(api_client)
id = 'id_example' # str | Unique identifier for a column
try:
# Get PA column settings
api_response = api_instance.get_pa_column_by_id(id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ColumnsApi->get_pa_column_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | Unique identifier for a column |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Expected response, returns settings of a PA column. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 400 | Invalid column Id. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 401 | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. |
| 403 | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 404 | Column not found. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 406 | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
| 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. |
| 503 | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
dict(str, ColumnSummary) get_pa_columns(name=name, category=category, directory=directory)
Get PA columns
This endpoint lists all the PA columns that can be applied to a calculation.
- Basic Authentication (Basic):
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'
)
# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = fds.analyticsapi.engines.ColumnsApi(api_client)
name = '' # str | Column name (optional) (default to '')
category = '' # str | Column category (optional) (default to '')
directory = '' # str | The directory to get the columns in (optional) (default to '')
try:
# Get PA columns
api_response = api_instance.get_pa_columns(name=name, category=category, directory=directory)
pprint(api_response)
except ApiException as e:
print("Exception when calling ColumnsApi->get_pa_columns: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | Column name | [optional] [default to ''] |
| category | str | Column category | [optional] [default to ''] |
| directory | str | The directory to get the columns in | [optional] [default to ''] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Expected response, returns a list of PA columns | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 401 | Missing or invalid authentication. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. |
| 403 | User is forbidden with current credentials | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 406 | Unsupported Accept header. Header needs to be set to application/json. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * X-RateLimit-Limit - Number of allowed requests for the time window. * X-RateLimit-Remaining - Number of requests left for the time window. * X-RateLimit-Reset - Number of seconds remaining till rate limit resets. |
| 429 | Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. |
| 500 | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. |
| 503 | Request timed out. Retry the request in sometime. | * X-DataDirect-Request-Key - FactSet's request key header. * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. * Age - Standard HTTP header. Header will specify the age of columns list cached response. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]