financialdatapy.request module¶

This module requests data from web.

class financialdatapy.request.Request(url: str, method: str = 'get', headers: Optional[dict] = None, params: Optional[dict] = None, data: Optional[dict] = None)[source]¶

Bases: object

A class sending and receiving http request.

Parameters

url (str) – Url of the data source.
method (str, optional) – Which http methods to request, defaults to ‘get’.
headers (dict, optional) – Http request headers, defaults to None.
params (dict, optional) – URL parameters to attach, defaults to None.
data (Optional[dict], optional) – Data to pass when making POST request, defaults to None.

ResponseType = bytes | str | dict | bs4.BeautifulSoup¶: Available types of response data.

property headers: dict¶

Getter method of property headers.

Returns: Http request headers.
Return type: dict

property response: requests.models.Response¶

Sends a HTTP request to a data source url.

Raises: requests.exceptions.HTTPError An HTTP error occurred.
Returns: A response object from the source.
Return type: requests.Response

response_data(res_type: str) → bytes | str | dict | bs4.BeautifulSoup[source]¶

Return data depending on the data type.

Parameters: res_type (str) – Type of response data. ‘content’, ‘text’, ‘json’, or ‘beautifulsoup’.
Raises: NotAvailable – Response data is not available.
Returns: Bytes, text, or json file containing requested data.
Return type: ResponseType