LSEG Data Library for Python

Built with Pandora

Files response

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

Parameters

Name Description
is_success Boolean that indicates whether a request was successful.
data See Data container below.
errors Contains any errors that occur.
http_response HTTP response object, containing HTTP response data.
request_count Number of successful and 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 files object.

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

files object

The Files response field contains a files object that describes the files and their attributes.

"Files" is an iterable object that contains items with the following structure:

Field name Description Data type
created The creation date of the file. Str
file_size_in_bytes The size of the file, in bytes Int
filename The name of the file. Str
fileset_id The ID of the file set in which the file is held. Str
href Hyperlink to the files API used to retrieve file manually. Str
id The ID of the file. Str
md5 The MD5 hash of the file. Str
modified The last modification date of the file. Str
storage_location Storage location data for the file. Dict

The Ffile storage dictionary contains the following fields:

Field name Description Data type
url Direct URL for th file Str
@type Type of storage used for the file, for example:
"s3"		 Str
270 words (1:25 mins)