LSEG Data Library for Python

Built with Pandora

File sets response

The typical response that is received for a file set retrieval request.

Parameters

Name Description
is_success Boolean that indicates whether the request was successful.
data See Data container below.
errors The list of any errors that occur.
http_response HTTP response object, containing HTTP response data.
request_count Number of successful or failed connection attempts.
request_message HTTP request data, including headers, HTTP method, content, and so on.
closure Closure parameters that will be returned with the response.
http_status Dictionary, containing the http status code and http reason.
http_headers HTTP response headers.

Data container

Data container contains the raw JSON response (if applicable), dataframe and file_sets object.

Name Description
raw JSON response data received from the platform.
df Response data provided as a Dataframe.
file_sets Response data provided as a file_sets object.

file_sets object

The file_sets response field contains object representation of the bucket file set.

Field name Description Data type
attributes List of publisher-defined key-value attributes. Each key-pair value is separated by a colon. For example:
attributes=key1:val1,key2:val2		 List[dict]
available_from The date on which the file set is available to retrieve. Str
available_to The date after which the file set is no longer available. Str
bucket_name Name of the bucket that contains the file set. Str
content_from Age of the content within the file, start date. Str
content_to Age of the content within the file, end date. Str
created The creation date of the file set. Str
files List of the indices of the files. Str, List[str]
id The ID of the file set. Str
modified The last modification date of the file set. Str
name The name of the file set. Str
num_files The number of files in the file set. Int
package_id The package ID of the file set. Str
status The availability status of the file set. For example:
"Ready" or "Pending"		 Str
300 words (1:35 mins)