Our API can help to filter stocks based on any specific criteria of your choosing, across all equities.
As the API is currently in beta development stage, for now it is completely free to use. When we release our official API, there will still be a free (limited) version, however full access will require a monthly subscription. Until then, we hope it provides value and we welcome any comments or suggestions for improvement.
API
Our API provides a batch call to retrieve data from all ASX Equity Stocks. Batch means it retrieves data for all listed companies, in one call!
Stock data includes latest prices, trading info, statistics, and overall market depth data.
The API data is being used to populate our Prices section (see Home then click the Prices button).
View a quick demo in YouTube: https://youtu.be/11HuNHywfX0
(note that the demo uses Out-GridView, which may automatically round numbers, and is for demonstration purposes only).
API Intro
That's the basic API call to retrieve all available data (except news headlines, see further below).
How-To
To call the API from Windows PowerShell, open a PowerShell ISE and copy and run the commands below.
Replace <API-KEY> with your API Key shown above (if not displayed then log-in or create an account).
Sometimes the result is a truncated string, try rerunning the API command.
There are many ways to to view or store the data, here's an example of storing the data as a CSV file:
Note:
As we are currently using a free Wix website to host the API, occasionally the API call may fail with an error. Try rerunning the API command or contact us if you experience any issues (also check if the status indicator at the top of this page indicates that the API is Up/Running). API call rate is subject to Wix free site limitations.
Disclaimer:
The API is subject to change at any time.
We do not guarantee data accuracy and all data is intended to be used as a guide only.
The API is intended for personal use only.
We do not accept responsibility for any decisions you make based on the data we provide.
To retrieve a subset of data, such as specific columns, groups of columns or symbols, replace $params with one of the following options below. Specifying groups or columns is optional, as the default API call returns all columns - you can specify groups or columns to retrieve a smaller subset of columns if you prefer.
You can combine multiple groups as a comma separated list, and multiple options using "&", for example:
See next section for available groups and columns within each group.
API Key
We have recently implemented unique API keys for each user, so log in is now required to view your specific API key (non-expiring token).
News Headlines - To include news headlines in the API data, use the optional parameter "news=today" in the query, as shown below.
This will add 2 columns to the data table, "#News" (number of announcements that trading day per company), and "News" (comma-separated announcement headlines sorted in descending order by timestamp per company).
To limit news to most recent items based on minutes, use the alternative "news=30", which only return news items from within the previous 30 minutes. You can specify any number of minutes in the news parameter. This can help to reduce the data size if you are only interested in the most recently released announcements.
To see an example, see the Intro section for a YouTube video demo (note that the demo uses Out-GridView, which may automatically round numbers).
If you'd like to try our API before creating an account, you can use this temporary API key that expires in 15 minutes. To generate a new temporary key, refresh this page and paste the new key into your code.
(temporary) API Key
API Call Frequency: How often you call the API is up to you, noting that prices are updated every 30 seconds, so you will only see updated prices a couple of times a minute as an approximate guide.
The table below shows all columns of data that are provided by the API, including how frequently the data is refreshed. Data latency values are approximate and may be longer at times.
Data Latency
Column | Description | Latency/Refresh | Group |
|---|---|---|---|
Code | Symbol/Ticker | - | - |
MCm | Market Cap in $M | - | - |
PriceTS | Price Timestamp (AEST) | 30secs | core |
Price | Latest price | 30secs | core |
Chg | Latest price change ($) | 30secs | core |
ChgPc | Latest price change (%) | 30secs | core |
Open | Price at Market Open ($) | 30secs | core |
High | Intraday High ($) | 30secs | core |
Low | Intraday Low ($) | 30secs | core |
Close | Price at Market Close ($) | 30secs | core |
TrdVol | Volume traded | 30secs | core |
IndChgPc | Indicative Price Change (%), Pre-Open | 30secs | core |
PSA | Price-Sensitive Announcement | 30secs | core |
Status | Open/Halt/Suspended | 30secs | core |
PE | Price to Equity Ratio | 15mins | stats |
PB | Price to Book Ratio | 15mins | stats |
Div | Dividend ($) | 15mins | div |
DivY | Dividend Yield (%) | 15mins | div |
TrdNum | Number of Trades | 15mins | mdepth |
TrdVal | Trade Value ($) | 15mins | mdepth |
BuyOrders | Number of Buy Orders | 15mins | mdepth |
BuyVol | Number of Buy Units | 15mins | mdepth |
SellOrders | Number of Sell Orders | 15mins | mdepth |
SellVol | Number of Sell Units | 15mins | mdepth |
OrderRatio | Ratio of Buy Orders to Sell Orders | 15mins | mdepth |
VolRatio | Ratio of Buy Units to Sell Units | 15mins | mdepth |
AVol90Dm | Average volume over past 90 days (in millions) | EOD | chart |
AVol30Dm | Average volume over past 30 days (in millions) | EOD | chart |
AVol10Dm | Average volume over past 10 days (in millions) | EOD | chart |
YrHigh | Highest price over past year ($) | EOD | chart |
YrLow | Lowest price over past year ($) | EOD | chart |
RSI | Relative Strength Index (0-100) | EOD | chart |
Name | Company Name | EOD | info |
Sector | Sector | EOD | info |
Ind | Industry | EOD | info |
SOIm | Shares On Issue (in millions) | EOD | info |
Floatm | Float (in millions) | EOD | info |
#News | Number of news items in latest trading day | 2mins | - |
News | Comma-separated headlines, descending order if more than 1 | 2mins | - |
Note: For columns that display a ratio, if the divisor is zero (e.g. no seller quantities), the result is stored as a large number representing infinity.
If you'd like to contribute to developing this API, you can send us your suggestions in the comment box below, or email us directly.
We also welcome donations via Paypal if you'd like to help us along, payments can be sent directly to our email (see site footer for email address).
Contribute
We welcome your feedback... Submit comments here or email us directly
An API to retrieve data for all equities, including prices, volume, statistics, market depth, and news.
Status:
Loading...
message