Ijax Requests

Many of the parameters will be pre-configured to appropriate defaults for you and will therefore be optional.

Use the simulator or view the DTD for details of the response format.

Stock quotes

URI/quote
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
liveBoolean. Whether the data is live or delayed.
include_stock_infoBoolean. Whether to include stock fundamentals in results. Requires special permission.
include_indicesBoolean. Whether indices should be included in results.
include_related_newsBoolean. Whether to include related news (requires include_recent_news).
include_recent_newsBoolean. Whether to include the most recent news.
recent_news_countPositive integer. How many recent news items to include.

Index quotes

URI/index-quote
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
liveBoolean. Whether the data is live or delayed.
include_stocksBoolean. Whether stocks should be included in results.

Stock depth

The result can be large so we suggest you do not use include_orders unless absolutely necessary, and that you use depth_levels to control the maximum number returned.

This request can only return live data.

URI/depth
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
liveBoolean. Whether the data is live or delayed.
include_stock_infoBoolean. Whether to include stock fundamentals in results. Requires special permission.
depth_levelsInteger or "max" or "all". The number of depth levels to return. "max" will return whatever your allowed maximum is. "all" will return all levels, if that has been allowed.
include_ordersBoolean. Whether individual order volumes should be returned within each depth level.
include_ext_order_infoBoolean. Whether individual orders should include client and customer attributes if present. Requires include_orders=yes.
include_order_totalsBoolean. Whether to include the total count and volume of all orders in each queue.
include_related_newsBoolean. Whether to include related news (requires include_recent_news).
include_recent_newsBoolean. Whether to include the most recent news.
recent_news_countPositive integer. How many recent news items to include.
fromPositive integer. Start returning results from this point.
countPositive integer. Only return this many results.
store_idPositive integer. Recall a previously stored result.
storeBoolean. Ask to store the result; will respond with a store_id.

Stock trades

The result can be very large so we encourage the use of gzip, group_by_price, from and count.

URI/trades
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
liveBoolean. Whether the data is live or delayed.
include_stock_infoBoolean. Whether to include stock fundamentals in results. Requires special permission.
time_orderASC or DESC.
group_by_priceBoolean. Whether to produce a list of trades or a course of trades.
include_off_marketBoolean. Whether to include off market trades that don't adjust first, high, low, last and volume
fromPositive integer. Start returning results from this point.
countPositive integer. Only return this many results.
store_idPositive integer. Recall a previously stored result.
storeBoolean. Ask to store the result; will respond with a store_id.

Multiple stock and/or index quotes

URI/watchlist
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codesString. A comma separated list of codes to return data for.
liveBoolean. Whether the data is live or delayed.
include_stock_infoBoolean. Whether to include stock fundamentals in results. Requires special permission.
include_stocksBoolean. Whether stocks should be included in results.
include_indicesBoolean. Whether indices should be included in results.
include_related_newsBoolean. Whether to include related news (requires include_recent_news).
include_recent_newsBoolean. Whether to include the most recent news.
recent_news_countPositive integer. How many recent news items to include.

List of stocks quotes from an index

Only available for NZX until further notice.

URI/indexlist
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
liveBoolean. Whether the data is live or delayed.
include_stock_infoBoolean. Whether to include stock fundamentals in results. Requires special permission.
include_related_newsBoolean. Whether to include related news (requires include_recent_news).
include_recent_newsBoolean. Whether to include the most recent news.
recent_news_countPositive integer. How many recent news items to include.

Exchange announcements

URI/recent-news
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
exchangeString. What exchange to return data for (for market queries).
time_orderASC or DESC.
from_dateYYYY-MM-DD. Minimum date to include in result.
to_dateYYYY-MM-DD. Maximum date to include in result.
date_range[0-9]+[dwmy]. Can optionally be used with from_date or to_date. If neither is given, defaults to a date range prior to the current date. Set e.g. 1w is one week, 5m is 5 months.
include_related_newsBoolean. Whether to include related news (requires include_recent_news).
sensitive_news_onlyBoolean. Only include price sensitive news).
fromPositive integer. Start returning results from this point.
countPositive integer. Only return this many results.
store_idPositive integer. Recall a previously stored result.
storeBoolean. Ask to store the result; will respond with a store_id.

Stock price history

URI/stock-history
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
time_orderASC or DESC.
from_dateYYYY-MM-DD. Minimum date to include in result.
to_dateYYYY-MM-DD. Maximum date to include in result.
date_range[0-9]+[dwmy]. Can optionally be used with from_date or to_date. If neither is given, defaults to a date range prior to the current date. Set e.g. 1w is one week, 5m is 5 months.
fromPositive integer. Start returning results from this point.
countPositive integer. Only return this many results.
store_idPositive integer. Recall a previously stored result.
storeBoolean. Ask to store the result; will respond with a store_id.

Index price history

URI/index-history
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
time_orderASC or DESC.
from_dateYYYY-MM-DD. Minimum date to include in result.
to_dateYYYY-MM-DD. Maximum date to include in result.
date_range[0-9]+[dwmy]. Can optionally be used with from_date or to_date. If neither is given, defaults to a date range prior to the current date. Set e.g. 1w is one week, 5m is 5 months.
fromPositive integer. Start returning results from this point.
countPositive integer. Only return this many results.
store_idPositive integer. Recall a previously stored result.
storeBoolean. Ask to store the result; will respond with a store_id.

Issuer announcements

URI/news-history
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
time_orderASC or DESC.
from_dateYYYY-MM-DD. Minimum date to include in result.
to_dateYYYY-MM-DD. Maximum date to include in result.
date_range[0-9]+[dwmy]. Can optionally be used with from_date or to_date. If neither is given, defaults to a date range prior to the current date. Set e.g. 1w is one week, 5m is 5 months.
include_related_newsBoolean. Whether to include related news (requires include_recent_news).
sensitive_news_onlyBoolean. Only include price sensitive news).
fromPositive integer. Start returning results from this point.
countPositive integer. Only return this many results.
store_idPositive integer. Recall a previously stored result.
storeBoolean. Ask to store the result; will respond with a store_id.

Market scans

There will generally be a max_count set in your config to restrict the maximum number of items returned

URI/market
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
keywordString. Match the name against this.
exchangeString. What exchange to return data for (for market queries).
liveBoolean. Whether the data is live or delayed.
include_stock_infoBoolean. Whether to include stock fundamentals in results. Requires special permission.
include_optionsBoolean. Whether derivatives should be included in results.
include_chix
include_purematch
benchmark_shares_onlyBoolean. Only include shares from the benchmark index in the scan).
countPositive integer. Only return this many results.

Ticker lookup

Use keyword to search for stocks with the keyword in their name.
Use code to restrict the results to stocks that start with the code.
e.g. code=B&keyword=mining will return stocks with mining in their name whose code starts with B.

There will generally be a max_count set in your config to restrict the maximum number of items returned

URI/code-search
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
codeString. What code to return data for.
keywordString. Match the name against this.
include_optionsBoolean. Whether derivatives should be included in results.
include_chix
include_purematch
include_indicesBoolean. Whether indices should be included in results.
include_stock_infoBoolean. Whether to include stock fundamentals in results. Requires special permission.
fromPositive integer. Start returning results from this point.
countPositive integer. Only return this many results.
store_idPositive integer. Recall a previously stored result.
storeBoolean. Ask to store the result; will respond with a store_id.

User authentication

See the authentication documentation here.

This request will be restricted to your server IPs.

URI/auth
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
userString. User identifier.

User deauthentication

A user can be logged out by their authentication token or user id. You should supply the authentication token if possible, otherwise all sessions that the user has open will be logged out.

This request will be restricted to your server IPs.

URI/unauth
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.
userString. User identifier.

Configuration

Use this to view your permissions and defaults per module.

This request will be restricted to your server IPs.

URI/config
Parameters
verInteger. As new versions are released, you may use this parameter to force old behaviour.
fmtXML or JSON. What format to return the results in.
gzipBoolean. Whether to gzip the result.
callback_paramPositive integer. Echoed back in the result.
callbackString: [A-Za-z0-9_.]+. Change the JSON result to a javascript function call to callback
quote_fields
authToken. Authorize the request.

Parameter Types

Booleans can take any of the following values: y/n, yes/no, on/off, true/false and 1/0.

Codes can optionally indicate a different exchange from the default. e.g. ASX:TEL refers to Telecom on the ASX and NZX:TEL refers to Telecom on the NZX.

All parameter values are case insensitive and restricted to 64 characters from the set [A-Za-z0-9 ,.:] apart from the following exceptions:

codes has no length restriction.

callback preserves case and will accept characters from [A-Za-z0-9_.].

user preserves case and will accept characters from [A-Za-z0-9_.@-].