Giters

jericmac / pyasx

Python library to pull data from ASX.com.au

Home Page:https://pypi.org/project/pyasx/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PyASX

Build Status Python Version

Python library to pull ASX stock information via the undocumented API used on www.ASX.com.au.

Main features are;

  • Pulling the full list of companies & securities listed on the ASX
  • Pulling detailed company information
  • Pulling company regulatory annoucements

While PyASX provides pricing information, using AlphaVantage is a better option for up to date & historical price data.

NOTE: This library uses a bunch of undocumented APIs from the ASX.com.au website and thus could go the way of Google & Yahoo finance with the API unceremoniously being killed off.

Installation

Install via pip:

$ pip install pyasx

API

get_listed_companies()

Pulls a list of all companies listed on the ASX. This will not include anything other than companies, i.e. no EFT/ETPs, options, warrants etc.

Example

>>> import pyasx.data.companies
>>> results = pyasx.data.companies.get_listed_companies()
>>> print(results, indent=4)
[
    {
        "ticker": "MOQ",
        "name": "MOQ LIMITED"
        "gics_industry": "Software & Services",
    },
    {
        "ticker": "1PG",
        "name": "1-PAGE LIMITED"
        "gics_industry": "Software & Services",
    },
    {
        "ticker": "ONT",
        "name": "1300 SMILES LIMITED"
        "gics_industry": "Health Care Equipment & Services",
    },
    ...
    {
        "ticker": "ZYB",
        "name": "ZYBER HOLDINGS LTD"
        "gics_industry": "Software & Services",
    }
]

get_company_info()

Pull information on the company with the given ticker symbol. This also includes all of the pricing information returned by pyasx.data.securities.get_security_info().

This will only work for a company, it will not return information on, ETFs, warrants, indices etc. For that please use pyasx.data.securities.get_security_info()

Example

>>> import pyasx.data.companies
>>> results = pyasx.data.companies.get_company_info('CBA')
>>> print(results, indent=4)
{
    "ticker": "CBA",
    "name": "COMMONWEALTH BANK OF AUSTRALIA.",
    "name_short": "COMMONWEALTH BANK.",
    "gics_sector": "Financials",
    "gics_industry": "Banks",
    "principal_activities": "Banking, financial and related services.",
    "website": "http://www.commbank.com.au/",
    "mailing_address": "Ground Floor, Tower 1, 201 Sussex Street, SYDNEY, NSW, AUSTRALIA, 2000",
    "phone_number": "(02) 9378 2000",
    "fax_number": "(02) 9118 7192",
    "registry_name": "LINK MARKET SERVICES LTD",
    "registry_phone_number": "1800 022 440",
    "listing_date": datetime.datetime(1997, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
    "delisting_date": null,
    "foreign_exempt": false,
    "products": [
        "shares",
        "hybrid-securities",
        "options",
        "warrants"
    ],
    "primary_share": {
        "ticker": "CBA",
        "type": "Ordinary Fully Paid",
        "isin": "AU000000CBA7",
        "open_price": 74.1,
        "last_price": 72.81,
        "offer_price": 72.92,
        "bid_price": 72.8,
        "last_trade_date": datetime.datetime(2018, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
        "average_daily_volume": 2610218,
        "day_high_price": 74.16
        "day_low_price": 72.81,
        "day_change_price": -2.06,
        "day_change_percent": "-2.751%",
        "day_volume": 3617914,
        "prev_day_close_price": 74.87,
        "prev_day_change_percent": "-1.201%",
        "year_open_price": 75.27,
        "year_high_price": 87.74,
        "year_high_date": datetime.datetime(2017, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
        "year_low_price": 72.81,
        "year_low_date": datetime.datetime(2018, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
        "year_change_price": -2.46,
        "year_change_percent": "-3.268%",
        "annual_dividend_yield": 5.91,
        "securities_outstanding": 1752728198,
        "market_cap": 131226760184,
        "pe": 12.68,
        "eps": 5.7442,
        "is_suspended": false,
        "indices": [
            {
                "code": "XTL",
                "name": "S&P/ASX 20"
            },
            ...
        ]
    },
    "last_dividend": {
        "type": "",
        "amount_aud": "",
        "franked_percent": "",
        "created_date": "",
        "ex_date": "",
        "record_date": "",
        "books_close_date": "",
        "payable_date": "",
        "comments": ""
    },

}

get_company_announcements()

Pull the latest company announcements for the company with the given ticker symbol. This will only work for companies, it won't work for other securities.

NOTE This currently only pulls the 20 latest market sensitive annoucements.

Example

>>> import pyasx.data.companies
>>> results = pyasx.data.companies.get_company_announcements('CBA')
>>> print(results, indent=4)
[
    {
        "num_pages": 106,
        "title": "CommBank PERLS X Capital Notes - Replacement Prospectus",
        "url": "http://www.asx.com.au/asxpdf/20180315/pdf/43sg1vw9rn1yl1.pdf",
        "release_date": datetime.datetime(2018, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
        "size": "4.7MB",
        "document_date": datetime.datetime(2018, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000))
    },
    {
        "num_pages": 185,
        "title": "2018 Half Year Results Profit Announcement",
        "url": "http://www.asx.com.au/asxpdf/20180207/pdf/43rd1t86s7g1ll.pdf",
        "release_date": datetime.datetime(2018, 3, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
        "size": "19.9MB",
        "document_date": datetime.datetime(2018, 3, 1, 0, 0, tzinfo=tzoffset(None, 36000))
    },
    ...
]

get_listed_securities()

Pulls a list of all securities listed on the ASX.

Example

>>> import pyasx.data.securities
>>> results = pyasx.data.securities.get_listed_securities()
>>> print(results, indent=4)
[
    {
        "isin": "AU000000IJH2",
        "ticker": "IJH",
        "name": "ISHARES MID-CAP ETF",
        "type": "CHESS DEPOSITARY INTERESTS 1:1 ISHS&P400"
    },
    {
        "isin": "AU000000IJH2",
        "ticker": "MOQ",
        "name": "MOQ LIMITED",
        "type": ORDINARY FULLY PAID"
    },
    {
        "isin": "AU000000IJH2",
        "ticker": "MOQAI",
        "name": "MOQ LIMITED",
        "type": "OPTION EXPIRING VARIOUS DATES EX VARIOUS PRICES"
    },
    ...
    {
        "isin": "AU0000ZYBAI9",
        "ticker": "ZYBAI",
        "name": "ZYBER HOLDINGS LTD",
        "type": "OPTION EXPIRING VAR DATES RESTRICTED VAR PRICES"
    }
]

get_security_info()

Pull pricing information on the security with the given ticker symbol. This can be for any type of listed security, such as company stock, bonds, ETFs etc.

Example

>>> import pyasx.data.securities
>>> results = pyasx.data.securities.get_security_info('CBAPC')
>>> print(results, indent=4)
{
    "ticker": "CBAPC",
    "type": "Cap Note 3-bbsw+3.80% Perp Non-cum Red T-12-20",
    "isin": "AU0000CBAPC9",
    "open_price": 100.4,
    "last_price": 100.61,
    "offer_price": 100.66,
    "bid_price": 100.6,
    "last_trade_date": datetime.datetime(2018, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
    "average_daily_volume": 12781,
    "day_low_price": 100.4,
    "day_high_price": 100.66,
    "day_change_price": 0.18,
    "day_change_percent": "0.179%",
    "day_volume": 18446,
    "prev_day_close_price": 100.43,
    "prev_day_change_percent": "-0.366%",
    "year_open_price": 104.18,
    "year_high_price": 100.66,
    "year_high_date": datetime.datetime(2017, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
    "year_low_price": 0,
    "year_low_date": datetime.datetime(2018, 5, 1, 0, 0, tzinfo=tzoffset(None, 36000)),
    "year_change_price": -3.57,
    "year_change_percent": "-3.427%",
    "annual_dividend_yield": 3.89,
    "securities_outstanding": 1752728198,
    "market_cap": 131226760184,
    "pe": 0,
    "eps": 0,
    "is_suspended": false,
    "indices": []
}

Unit tests

The unit tests can be run by executing the test.py file, like so;

python3 tests.py

Changelog

2.1.7

  • Requirements security patches

2.1.5

  • Documentation update

2.1.1

  • Minor bug fixes

2.1.0

  • Throw UnknownTickerException when API 404s

2.0.0

  • Dates now returned as datetime object rather than a string
  • Better exception handling

1.1.0

  • Optimised get_company_info() to use only 1 API call
  • Changed gics & sector fields to gics_industry and gics_sector
  • Docs updates

1.0.2

  • Bug fix - config file missing in dist

1.0.1

  • Bug fix - pypandoc dependency failure on pypi

1.0

  • Initial version

About

Python library to pull data from ASX.com.au

https://pypi.org/project/pyasx/

Languages

Language:Python 100.0%