fds.analyticsapi.engines.StrategyDocumentsApi

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

Method	HTTP request	Description
get_axioma_equity_strategy_documents	GET /analytics/engines/axp/v3/strategies/{path}	Get Axioma Equity strategy documents and sub-directories in a directory
get_axioma_fi_strategy_documents	GET /analytics/engines/afi/v3/strategies/{path}	Get Axioma FI strategy documents and sub-directories in a directory
get_barra_strategy_documents	GET /analytics/engines/bpm/v3/strategies/{path}	Get Barra strategy documents and sub-directories in a directory
get_fpo_strategy_documents	GET /analytics/engines/fpo/v3/strategies/{path}	Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory
get_northfield_strategy_documents	GET /analytics/engines/npo/v3/strategies/{path}	Get Northfield strategy documents and sub-directories in a directory

get_axioma_equity_strategy_documents

DocumentDirectoriesRoot get_axioma_equity_strategy_documents(path)

Get Axioma Equity strategy documents and sub-directories in a directory

This endpoint looks up all Axioma Equity strategy documents and sub-directories in a given directory.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import strategy_documents_api from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse 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’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

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 = strategy_documents_api.StrategyDocumentsApi(api_client) path = “Client:” # str | The directory to get the strategy documents and sub-directories in

# example passing only required values which don't have defaults set
try:
    # Get Axioma Equity strategy documents and sub-directories in a directory
    api_response = api_instance.get_axioma_equity_strategy_documents(path)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling StrategyDocumentsApi->get_axioma_equity_strategy_documents: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
path	str	The directory to get the strategy documents and sub-directories in

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: DocumentDirectoriesRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns a list of Axioma Equity strategy documents and directories | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 400 | Invalid query parameter or value provided | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 404 | Path 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
| 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* 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.
| 503 | Request timed out. Retry the request in some time | * 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.
|

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_axioma_fi_strategy_documents

DocumentDirectoriesRoot get_axioma_fi_strategy_documents(path)

Get Axioma FI strategy documents and sub-directories in a directory

This endpoint looks up all Axioma FI strategy documents and sub-directories in a given directory.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import strategy_documents_api from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse 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’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

Enter a context with an instance of the API client

# example passing only required values which don't have defaults set
try:
    # Get Axioma FI strategy documents and sub-directories in a directory
    api_response = api_instance.get_axioma_fi_strategy_documents(path)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling StrategyDocumentsApi->get_axioma_fi_strategy_documents: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
path	str	The directory to get the strategy documents and sub-directories in

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: DocumentDirectoriesRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns a list of Axioma FI strategy documents and directories | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 400 | Invalid query parameter or value provided | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 404 | Path 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
| 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* 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.
| 503 | Request timed out. Retry the request in some time | * 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.
|

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_barra_strategy_documents

DocumentDirectoriesRoot get_barra_strategy_documents(path)

Get Barra strategy documents and sub-directories in a directory

This endpoint looks up all Barra strategy documents and sub-directories in a given directory.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import strategy_documents_api from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse 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’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

Enter a context with an instance of the API client

# example passing only required values which don't have defaults set
try:
    # Get Barra strategy documents and sub-directories in a directory
    api_response = api_instance.get_barra_strategy_documents(path)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling StrategyDocumentsApi->get_barra_strategy_documents: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
path	str	The directory to get the strategy documents and sub-directories in

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: DocumentDirectoriesRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns a list of Barra strategy documents and directories | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 400 | Invalid query parameter or value provided | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 404 | Path 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
| 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* 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.
| 503 | Request timed out. Retry the request in some time | * 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.
|

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_fpo_strategy_documents

DocumentDirectoriesRoot get_fpo_strategy_documents(path)

Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory

This endpoint looks up all FactSet Portfolio Optimizer strategy documents and sub-directories in a given directory.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import strategy_documents_api from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse 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’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

Enter a context with an instance of the API client

# example passing only required values which don't have defaults set
try:
    # Get FactSet Portfolio Optimizer strategy documents and sub-directories in a directory
    api_response = api_instance.get_fpo_strategy_documents(path)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling StrategyDocumentsApi->get_fpo_strategy_documents: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
path	str	The directory to get the strategy documents and sub-directories in

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: DocumentDirectoriesRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns a list of FactSet Portfolio Optimizer strategy documents and directories | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 400 | Invalid query parameter or value provided | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 404 | Path 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
| 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* 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.
| 503 | Request timed out. Retry the request in some time | * 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.
|

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_northfield_strategy_documents

DocumentDirectoriesRoot get_northfield_strategy_documents(path)

Get Northfield strategy documents and sub-directories in a directory

This endpoint looks up all Northfield strategy documents and sub-directories in a given directory.

Example

Basic Authentication (Basic):
Bearer Authentication (Bearer): ```python import time import fds.analyticsapi.engines from fds.analyticsapi.engines.api import strategy_documents_api from fds.analyticsapi.engines.model.document_directories_root import DocumentDirectoriesRoot from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse 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’ )

Configure Bearer authorization: Bearer

configuration = fds.analyticsapi.engines.Configuration( access_token = ‘YOUR_BEARER_TOKEN’ )

Enter a context with an instance of the API client

# example passing only required values which don't have defaults set
try:
    # Get Northfield strategy documents and sub-directories in a directory
    api_response = api_instance.get_northfield_strategy_documents(path)
    pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
    print("Exception when calling StrategyDocumentsApi->get_northfield_strategy_documents: %s\n" % e) ```

Parameters

Name	Type	Description	Notes
path	str	The directory to get the strategy documents and sub-directories in

Return type

A tuple with response data, HTTP status code and response headers.
Response datatype: DocumentDirectoriesRoot

Authorization

Basic, Bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| 200 | Expected response, returns a list of Northfield strategy documents and directories | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 400 | Invalid query parameter or value provided | * 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets.
| 404 | Path 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
| 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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window.
* X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window.
* X-FactSet-Api-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.
* 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.
| 503 | Request timed out. Retry the request in some time | * 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.
|

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fds.analyticsapi.engines.StrategyDocumentsApi

get_axioma_equity_strategy_documents

Example

Defining the host is optional and defaults to https://api.factset.com

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

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

Configure Bearer authorization: Bearer

Enter a context with an instance of the API client

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_axioma_fi_strategy_documents

Example

Defining the host is optional and defaults to https://api.factset.com

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

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

Configure Bearer authorization: Bearer

Enter a context with an instance of the API client

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_barra_strategy_documents

Example

Defining the host is optional and defaults to https://api.factset.com

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

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

Configure Bearer authorization: Bearer

Enter a context with an instance of the API client

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_fpo_strategy_documents

Example

Defining the host is optional and defaults to https://api.factset.com

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

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

Configure Bearer authorization: Bearer

Enter a context with an instance of the API client

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_northfield_strategy_documents

Example

Defining the host is optional and defaults to https://api.factset.com

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

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

Configure Bearer authorization: Bearer

Enter a context with an instance of the API client

Parameters

Return type

Authorization

HTTP request headers