request_processor

Module for processing API requests.

Sets value of constants.api_attribute_map as an import side effect.

Functions

generate_pages(filters, limit, flags, res_colls)

Generate instances of FilingsPage from the API.

xbrl_filings_api.request_processor.generate_pages(filters, limit, flags, res_colls, sort=None, add_api_params=None)

Generate instances of FilingsPage from the API.

Parameters:

• filters (mapping of {str: any or iterable of any}, optional)

• limit (int or NO_LIMIT)

• flags (ScopeFlag)

• res_colls (dict of {str: ResourceCollection})

• sort (sequence of str, optional)

• add_api_params (mapping, optional)

Yields:

FilingsPage – New page object from HTTP response.

Raises:

• APIError –

• HTTPStatusError –

• requests.ConnectionError –

• requests.JSONDecodeError –

Return type:

Generator[FilingsPage, None, None]