Finwin Soap (Symbol Lookup)

Actions:

Quote

Symbol Lookup

Headlines

Symbol News

Story

Most Actives

Soap (Symbol Lookup)

Symbol lookup is a simple request. Pass a searchString node along with the other required parameters and retrieve up to 25 possible matches of ticker symbols for the string.

Required Parameters
Username - The developers username you chose when you enrolled as a FinWin developer. Password - The developers password you chose when you enrolled as a finwin developer. ID - The site ID issued by FinWin when you enrolled this Site to receive FinWin content. Note: If you are developing your site and do not yet havea paid FinWin ID you may use the Complimentary developers site ID of 1183. SearchString - This is a comma delimited list of ticker symbols. FinWin will return the quote packet with child nodes in the same order as this symbol list. Note: You are limited to a specific number of symbols. If you wish to increase your limit for the site you are working with, Finwin can make arrangements to do that. The default is 15 symbols.

Request Structure

A SOAP action of LOOKUP allows you to pass in a string representing all or part of a company name. FSS will then search for a ticker symbol that closely matches company names like that string. A lookup request will resemble a quote request very closely, except that instead of a symbols node, a lookup request requires a Search String node. As in all FSS requests, after the standard SOAP envelope and header, a SOAP request packet must have a node titled <ContentRequest xmlns='www.finwin.com'></ContentRequest>. This node contains child nodes that allow FSS to authorize and process your reqest - as in the example:

<?xml version='1.0'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" 
   xmlns:xsd="http://www.w3.org/1999/XMLSchema">
    <SOAP-ENV:Body>
       <ContentRequest xmlns='www.finwin.com'>
         <REQUEST xsi:type="xsd:string">Quote</REQUEST>
         <USERNAME xsi:type="xsd:string">Sillyname</USERNAME>
         <PASSWORD xsi:type="xsd:string">sillypassword</PASSWORD>
         <ID xsi:type="xsd:string">1183</ID>				
         <SYMBOLS xsi:type="xsd:string">msft</SYMBOLS>					
         <SEARCHSTRING xsi:type="xsd:string"></SEARCHSTRING>
         <STORYNUMBER xsi:type="xsd:string"></STORYNUMBER>		
         <PAGEID xsi:type="xsd:int"></PAGEID>	
         <ROWCOUNT xsi:type="xsd:int"></ROWCOUNT>	
       </ContentRequest>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Return Data

				
<?xml version='1.0'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" 
   xmlns:xsd="http://www.w3.org/1999/XMLSchema">
<SOAP-ENV:Body>
     <Recordcount xsi:type="xsd:int">25</Recordcount>
       <Results xmlns="http://www.finwin.com">
         <rslookup> <ISSUER xsi:type="xsd:string">Affordable Homes</ISSUER>
           <TSYM xsi:type="xsd:string">AHOA</TSYM>
         </rslookup>
         <rslookup> <ISSUER xsi:type="xsd:string">ALFORD REFRIGD WAREHOUSE</ISSUER>
           <TSYM xsi:type="xsd:string">ALFO</TSYM>
         </rslookup>
         <rslookup> <ISSUER xsi:type="xsd:string">BRADFORD MONEY FUND</ISSUER>
           <TSYM xsi:type="xsd:string">BRDXX</TSYM>
         </rslookup>
         <rslookup> <ISSUER xsi:type="xsd:string">BRIDGFORD FOODS CORP</ISSUER>
           <TSYM xsi:type="xsd:string">BRID</TSYM>
         </rslookup>
         <rslookup> <ISSUER xsi:type="xsd:string">CORTLAND-BRADFORD SH TR MU</ISSUER>
           <TSYM xsi:type="xsd:string">BRMXX</TSYM>
         </rslookup>
       </Results>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Fault Packets

FSS returns error descriptions as a soap packet with a "<Soapfault></Soapfault>" node in the results. An FSS SOAP fault packet looks like this:

					
<?xml version='1.0'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
   xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
   xmlns:xsi="http://www.w3.org/1999/XMLSchema-instance" 
   xmlns:xsd="http://www.w3.org/1999/XMLSchema">
   <SOAP-ENV:Body>
     <Results xmlns="http://www.finwin.com">
        <SoapFault>
          <EXCEPTION xsi:type="xsd:string">Username or password incorrect</EXCEPTION>
        </SoapFault>
     </Results>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

FSS Returns the following messages as SOAPFaults:

Method not allowed - Returned when you use an HTTP GET rather than a POST request. This return message also generates a 405 HTTP status code in the response header.
Missing SOAPAction Header - returned when no header titled SOAPAction was found.
Invalid SOAPAction Value - n is not a valid action - returned when the SOAPAction header contains an invalid or unrecognized SOAPAction
Missing Content-Type Header - A header named "content-type" was not found in your HTTP request
Invalid Content Type - your content-type header specifies something other than text/xml
Username Required - You did not provide a username in the request packet.
password Required - You did not provide a password in the request packet.
id Required - You did not provide a site id in the request packet.
Invalid Site ID - Your site ID is either unauthorized or not found.
Username or password incorrect - Your username and password are unauthorized or not found.