def get_collections(collection_name, collection_type="tag", **kwargs):
"""
Top-level function for obtaining data from the Collections endpoint
Parameters
----------
collection_name: str
Desired collection name
collection_type: str, default "tag", optional
Desired collection type (sector, tag, or list)
kwargs:
Additional Request Parameters (see base class)
"""
return CollectionsReader(collection_name,
collection_type, **kwargs).fetch()
def get_collections(collection_name, collection_type="tag", **kwargs):
"""Collections
Returns an array of ``quote`` objects for a given collection type.
Currently supported collection types are ``sector``, ``tag``, and ``list``
Reference: https://iexcloud.io/docs/api/#collections
Data Weighting: Weight of ``/stock/quote`` per method
Parameters
=================
collection_name: str
Desired collection name
collection_type: str, default "tag", optional
Desired collection type (sector, tag, or list)
kwargs:
Additional Request Parameters (see base class)
"""
return CollectionsReader(collection_name, collection_type, **kwargs).fetch()
def get_collections(collection_name, collection_type="tag", **kwargs):
"""Collections
Returns an array of ``quote`` objects for a given collection type.
Currently supported collection types are ``sector``, ``tag``, and ``list``
.. note:: Proper capitalization must be used with sector names. For instance,
"Technology" must be capitalized or no results will be returned.
Reference: https://iexcloud.io/docs/api/#collections
Data Weighting: Weight of ``/stock/quote`` per method
Parameters
=================
collection_name: str
Desired collection name
collection_type: str, default "tag", optional
Desired collection type (sector, tag, or list)
kwargs:
Additional Request Parameters (see base class)
"""
return CollectionsReader(collection_name, collection_type,
**kwargs).fetch()