GET api/market/security?search={search}&limit={limit}

Get a list of securities based on user input. Minimum of 2 characters required before search is performed.

Request Information

URI Parameters

Name	Description	Type	Additional information
search	Search text. Needs to have a minimum of 2 characters.	string	Required
limit	Number of securities to return based on the search text. Default is 5.	integer	Default value is 5

Body Parameters

None.

Response Information

Resource Description

Collection of SecurityCodeAndDescription

Name	Description	Type	Additional information
Code	Security code. May contain the extension such as "ASX" or "CXA" if multiple exchanges are available for trading.	string	None.
Name	Security name	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Code": "BHP",
    "Name": "BHP BILLITON LIMITED ORDINARY"
  },
  {
    "Code": "CBA",
    "Name": "COMMONWEALTH BANK. ORDINARY"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSecurityCodeAndDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Market">
  <SecurityCodeAndDescription>
    <Code>BHP</Code>
    <Name>BHP BILLITON LIMITED ORDINARY</Name>
  </SecurityCodeAndDescription>
  <SecurityCodeAndDescription>
    <Code>CBA</Code>
    <Name>COMMONWEALTH BANK. ORDINARY</Name>
  </SecurityCodeAndDescription>
</ArrayOfSecurityCodeAndDescription>