Client for consuming Accern data feeds.
Project description
Accern Data Library
Client library for consuming Accern data feed API.
PyPI page: Click here
Installation:
pip install accern-data
Sample snippet:
import accern_data
# Create a data client.
client = accern_data.create_data_client("https://api.example.com/", "SomeRandomToken")
# Set a data format/mode in which the data has to be downloaded.
# Split dates lets you divide files on the basis of dates.
client.set_mode(mode="csv", split_dates=True) # Other modes: {"df", "json"}
Set filters:
client.set_filters({
"provider_id": 5,
"entity_name": "Hurco Companies, Inc.",
"event": "Governance - Product Development, R&D and Innovation",
"entity_ticker": "HURC",
"entity_accern_id": "BBG000BLLFK1",
})
Set parameters to the download function:
client.download_range(
start_date="2022-01-03",
output_path=".",
output_pattern="data",
end_date="2022-03-04")
Note: To download single day's data, set end_date=None
or can leave that unset:
client.download_range(
start_date="2022-01-03",
output_path=".",
output_pattern="data",
end_date=None)
OR
client.download_range(
start_date="2022-01-03",
output_path=".",
output_pattern="data")
One-liner download:
accern_data.create_data_client("https://api.example.com/", "SomeRandomToken").download_range(start_date="2022-01-03", output_path=".", output_pattern="data", end_date="2022-03-04", mode="csv", filters={"entity_ticker": "HURC"})
Getting data using iterator:
for res in client.iterate_range(
start_date="2022-01-03",
end_date="2022-03-04"):
do_something(res)
Error logging:
While downloading the data any critical error will get raised.
Any non-critical errors, such as API timeouts, get silenced and API calls are repeated. To see a list of the last n
errors use:
client.get_last_silenced_errors()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
accern_data-0.2.1.tar.gz
(559.8 kB
view hashes)
Built Distribution
accern_data-0.2.1-py3-none-any.whl
(579.0 kB
view hashes)
Close
Hashes for accern_data-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e9d65c21d85da2b1d9ef0da7fe89eff763e94fafb05767907fd66cdb1e1d09e7 |
|
MD5 | 97b184304119e32bd39f13f2844ccad3 |
|
BLAKE2b-256 | c1f9516737145f73496707256a6b154a8b135db04db92b645471b8e813c60574 |