johnvonneumann / pyasx Goto Github PK

The docs are hilariously out of date and need to be purged and updated, even just initially purging would probably be great.

Package information when viewed in PyPi and other locations is wrong, update the files necessary for providing metadata to PyPi.

Is your feature request related to a problem? Please describe.
Currently, the get_listed_securities() function returns a list of all securities, but in many cases, it is unnecessary to see all types of securities, for example, a user may not want to see warrants, or maybe they only want to see warrants, the API should support this type of filtering.

Describe the solution you'd like
A user should be able to easily view the results of get_listed_securities() with more granularity.

Describe alternatives you've considered
N/A

Additional context
N/A

Is your feature request related to a problem? Please describe.
Any code that makes a call to a third party API should cache the results locally for a period, with an option to invalidate the cache and call anyway. This is due to the remote data being relatively static over a 24 hour period, so consecutive repetitive calls are extremely likely to return the same data.

Describe the solution you'd like
First call to an endpoint over a predefined period, should return data, second call over the same time period should return locally cached data.

Describe alternatives you've considered
N/A

Additional context
Cache max time can be updated as a configuration value in the conf file.

The Securities API is being served a file from 2020. The URL currently listed in the config.yml file is out of date, and needs to be replaced with.

https://www2.asx.com.au/content/dam/asx/issuers/ISIN.xls