GET api/market/securities
Get all securities details or security details for a given security code.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Security object
Collection of SecurityDetailsName | Description | Type | Additional information |
---|---|---|---|
SecurityID |
Security identifier. |
integer |
None. |
SecurityCode |
Security code. May contain the extension such as "ASX" or "CXA" if multiple exchanges are available for trading. |
string |
None. |
ShortName |
Security short name. |
string |
None. |
LongName |
Security long name. |
string |
None. |
SecurityClassType |
Security class type. ASX class type group or CXA class type group |
enSecurityClassType |
None. |
Response Formats
application/json, text/json
Sample:
[ { "SecurityID": 479, "SecurityCode": "BHP", "ShortName": "BHP GROUP FPO", "LongName": "BHP BILLITON LIMITED ORDINARY", "SecurityClassType": 1 }, { "SecurityID": 174, "SecurityCode": "AGL", "ShortName": "AGL FPO", "LongName": "AUSTRALIAN GAS LIGHT ORDINARY", "SecurityClassType": 1 } ]
application/xml, text/xml
Sample:
<ArrayOfSecurityDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Market"> <SecurityDetails> <LongName>BHP BILLITON LIMITED ORDINARY</LongName> <SecurityClassType>ASXEquity</SecurityClassType> <SecurityCode>BHP</SecurityCode> <SecurityID>479</SecurityID> <ShortName>BHP GROUP FPO</ShortName> </SecurityDetails> <SecurityDetails> <LongName>AUSTRALIAN GAS LIGHT ORDINARY</LongName> <SecurityClassType>ASXEquity</SecurityClassType> <SecurityCode>AGL</SecurityCode> <SecurityID>174</SecurityID> <ShortName>AGL FPO</ShortName> </SecurityDetails> </ArrayOfSecurityDetails>