Our API can help to filter stocks based on any specific criteria of your choosing, across all equities.
As our 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 in our Prices section (see Home then click the Prices button).
API Intro
That's the basic API call to retrieve all available data.
How-To
To call the API from Windows PowerShell, open a PowerShell ISE and copy and run the commands below.
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. 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 following options:
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.
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 | - | - |
Price | Latest price | 30secs | core |
Chg | Latest price change ($) | 30secs | core |
ChgPc | Latest price change (%) | 30secs | core |
TrdVol | Volume traded | 30secs | core |
IndChgPc | Indicative Price Change (%), Pre-Open | 30secs | core |
PSA | Price-Sensitive Announcement | 30secs | core |
Status | Halt or Suspended (empty if Open) | 30secs | core |
PE | Price to Equity Ratio | 15mimns | stats |
PB | Price to Book Ratio | 15mimns | stats |
Div | Dividend ($) | 15mimns | div |
DivY | Dividend Yield (%) | 15mimns | div |
TrdNum | Number of Trades | 15mimns | mdepth |
TrdVal | Trade Value ($) | 15mimns | mdepth |
BuyOrders | Number of Buy Orders | 15mimns | mdepth |
BuyVol | Number of Buy Units | 15mimns | mdepth |
SellOrders | Number of Sell Orders | 15mimns | mdepth |
SellVol | Number of Sell Units | 15mimns | mdepth |
OrderRatio | Ratio of Buy Orders to Sell Orders | 15mimns | mdepth |
VolRatio | Ratio of Buy Units to Sell Units | 15mimns | mdepth |
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, and market depth.
message